{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"982084b9-e545-4463-8d0d-25a3cc6fd3c0","name":"Plumter Business API V2","description":"**Live Base URL:** [https://api-business.plumter.com/v2](https://)\n\n**Staging Base URL:** [https://api-business-sandbox.plumter.com/v2](https://)\n\n| Status Code | Description |\n| --- | --- |\n| 200 | OK |\n| 201 | Created |\n| 202 | Transaction is Processing |\n| 400 | Bad Request |\n| 401 | Unauthorized |\n| 402 | Insufficient Funds |\n| 404 | Not Found |\n| 409 | Duplicate |\n| 500 | Internal Server Error |\n\n**Webhooks:** Your webhook enables us to notify your servers of events. This is a mandatory configuration for most of our transactional API calls. Below is a list of events that we currently publish:\n\n| event | Request Body | Description |\n| --- | --- | --- |\n| wallet.deposit | `{\"event\": \"wallet.deposit\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\"}}` | When a vendor receives a deposit into their wallet. |\n| wallet.withdraw | `{\"event\": \"wallet.withdraw\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\"}}` | When a vendor withdraws from their wallet |\n| wallet.swap | `{\"event\": \"wallet.swap\", \"data\": { \"reference\": \"reference\", \"amount\": \"amount\", \"fromCurrency\": \"fromCurrency\", \"toCurrency\": \"toCurrency\"}}` | When a vendor swaps funds from one currency to another |\n| payment.processing | `{\"event\": \"payment.processing\", \"data\": { \"reference\": \"reference\", \"status\": \"status\" \"amount\": \"amount\"}}` | When a vendor payment is processing |\n| payment.completed | `{\"event\": \"payment.completed\", \"data\": {\"reference\": \"reference\", \"amount\": \"amount\", \"status\": \"status\" }}` | When a vendor payment is completed. |\n| payment.rejected | `{\"event\": \"payment.rejected\", \"data\": {\"reference\": \"reference\", \"amount\": \"amount\", \"status\": \"status\", \"reason\": \"Rejection reason\" }}` | When a vendor payment is rejected. |\n| payment.failed | `{\"event\": \"payment.failed\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\", \"status\":\"status\", \"reason\": \"reason\"}}` | When a vendor payment fails |\n| payment.cancelled | `{\"event\": \"payment.cancelled\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\", \"status\": \"status\"}}` | When a vendor payment is cancelled |\n| payment.returned | `{\"event\": \"payment.returned\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\", \"status\": \"status\", \"return\": \"return data object\"}}` | When a vendor payment is returned |\n| withdrawal.declined | `{\"event\": \"withdrawal.declined\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\", \"reason\": \"reason\"}}` | When a withdrawal request is declined |\n| withdrawal.approved | `{\"event\": \"withdrawal.approved\", \"data\": { \"reference\": \"reference\", \"currency\": \"currency\" \"amount\": \"amount\", \"reason\": \"reason\"}}` | When a withdrawal is approved |\n| sender.declined | `{\"event\": \"sender.declined\", \"data\": { \"reference\": \"reference\",\"reason\": \"reason\"}}` | When a sender is declined |\n| sender.approved | `{\"event\": \"sender.approved\", \"data\": { \"reference\": \"reference\"}}` | When a sender is approved |\n\nTo get started with webhooks, update your webhook URL from the developer's section of your dashboard. When you receive a wbhook request on your endpoint, endeavour to call the relevant Plumter API endpoint for confirmation.\n\n## **Authorization**\n\nTo Authorize requests, simply send the two headers below with the request:\n\n`X-PLUM-PK: \"Your Plumter Public Key\"`\n\n`X-PLUM-SK: \"Your Plumter Secret Key\"`\n\n## **A few things to note**:\n\n- Amounts are typically represented in the base currency such as cents or kobo. Therefore, 1,000 USD will be represented as 100000. Please note that certain currencies do not have a base currency. Eg JPY. Therefore 1,000 JPY will be represented as 1000.\n    \n\n## **UAT Cases:**\n\n1. Get wallet balances\n    \n2. Upload document\n    \n3. Create sender\n    \n4. Create sender with PEP director\n    \n5. Create Beneficiary\n    \n6. Create IBAN Beneficiary\n    \n7. Create US Beneficiary\n    \n8. Create beneficiary for country that requires additional information\n    \n9. Create sanctioned beneficiary\n    \n10. Create payment\n    \n11. Payment completed webhook\n    \n12. Payment rejected webhook\n    \n13. Sender approved webhook\n    \n14. Sender rejected webhook\n    \n15. Track payment\n    \n16. Get rate","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13015425","team":1313856,"collectionId":"982084b9-e545-4463-8d0d-25a3cc6fd3c0","publishedId":"2sB2cU9NAb","public":true,"publicUrl":"https://docs.plumter.com","privateUrl":"https://go.postman.co/documentation/13015425-982084b9-e545-4463-8d0d-25a3cc6fd3c0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-04-04T05:00:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2751426c51579989d17b032559473b672934e8d7ba42c27d9db8b51bd2fbef10","favicon":"https://plumter.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.plumter.com/view/metadata/2sB2cU9NAb"}