This section serves to give an overview of the design considerations in the Enovepay(Formerly WebPayment) platform. The API is accessible through the URL https://api.webpayment.io Integrating with this API enables merchants to initiate payment collection and disbursement in several countries. The API is designed to be seamless and allow developers to use minimal effort while integrating securely and reliably.
\nCurrently, the API has documented payment collection/payout in the following countries: Kenya, Nigeria, Ghana, Cameroon, Benin, Ivory Coast and Senegal. You can share feedback and suggestions via support@enovepay.com
\nPlease note: This API documentation is property of Enove Technologies LTD(Kenya,Nigeria, Cameroon,Ivory Coast, Senegal, Burkina Faso, Rwanda, Uganda, Tanzania). Registered as Crafthouse Technologies Limited in Uganda and South Africa.
\nWhen initiating a collection or payout, you provide a callback URL in the payload, we use this to notify you of the transaction status. Please ensure your webhooks are https:// and are always available. If not provided in the payload, we will invoke the default URL in your account settings.
\nTransaction Status for Webhooks
\nThe transaction_status field indicates the success status of the collection/payout transation. It may contain any of the following values.
\nSample Webhook for successful transaction
\n{\nsuccess: true,\nstatus_code: 100,\nmessage: 'Transaction completed Successfully',\ntransaction_id: '4c2a169dda4c54f61d33',\ntransaction_amount: 10,\nsender_name: 'Johhn Nadala',\ntransaction_ref: 'Ymdnsfh',\ndebitor_account: 'Ymdnsfh',\ntransaction_status: 'Success',\ncommand_status: 'ok',\nreference_number: 'Ymdnsfh'\n}\n\nSample Webhook for failed transaction
\n{\nsuccess: false,\nstatus_code: 112,\nmessage: 'Transaction Failed',\ntransaction_id: '07f967a5d1a40eed1840',\ntransaction_ref: 'Ymdns5454fh',\ndebitor_account: 'Ymdns4343fh',\nreference_number: 'Ymdns5454fh'\n}\n\nIn order to accept webhooks with confidence, we encourage use of 2 security features.
\nWhitelist Webpayment API IP address(Request IP from Webpayment Support). Only accept Webhooks from this IP.
\nOn the Webhook request header, there is a Bearer Token. This token is equivalent to the md5() hash value of transaction_id+client_secret_key. The transaction ID is available in the webhook payload, the client secret key is your secret, you can generate it on the Webpayment dashboard.
\nIMPORTANT NOTE: The webhook may be invoked more than once for the same transaction. Please validate so as not to double debit.
\nEach API response provides 3 status indicators: Status code, message and boolean Success. For a successful request, the status_code=100 and boolean success=true. See below the API reference.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Webhooks","slug":"webhooks"},{"content":"API response Codes","slug":"api-response-codes"}],"owner":"5364077","collectionId":"6ab0fd4d-1609-4020-b75c-9025aa269289","publishedId":"2s7Z7ckBmo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-09-21T19:30:48.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authenticate your session","id":"08a6873f-6475-4253-b7a3-4a7925c79362","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"api_password\": \"1SDFR\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/specialsessionid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Every interaction with WebPayment API requires authentication with a Bearer Token Authorization. You start by getting an authentication token which you will use in all requests until it expires.
\nYour API username and API password are available on your dashboard under Settings->My Account->API Settings. Click on Change Password on the dashboard to set your API Password.
\nNOTE The Token Expires after 30mins. For users on the legacy Webpayment API, including the token in the payload body rather than header will also work. Maintain the payload variable: session_id as before. This is to ensure backward compatibility.
\n","_postman_id":"aa3f58ec-3561-42d0-aa7f-9f7fd19eafc2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"When a transaction is complete, we will notify you of the status using the callback URL you provided. transaction_status value on the payload will provide the status of the transaction as either:
\nSuccess
\nFailed
\nCredit In Progress
\nRefunded
\n","urlObject":{"protocol":"https","host":["your_callback_url"],"query":[],"variable":[]}},"response":[{"id":"17278921-909e-4b85-b156-ee41d4b19a10","name":"Webhook","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \"success\": true,\r\n \"message\": \"Request was successful\", \r\n \"status_code\": 100, \r\n \"api_username\": \"demo\",\r\n \"transaction_id\": \"cf07ae4fe83d8e2127a3\", \r\n \"transaction_amount\": 10,\r\n \"sender_name\": \"Mary Wambui\",\r\n \"transaction_status\": \"Success\" \r\n }","options":{"raw":{"language":"json"}}},"url":"https://your_callback_url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 14:01:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"214"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"d6-WmzZ552isDSk0TnJHOG2wnjTKtk\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Request was successful\",\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"transaction_id\": \"cf07ae4fe83d8e2127a3\",\n \"transaction_amount\": 10,\n \"sender_name\": \"Mary Wambui\",\n \"transaction_status\": \"Success\"\n}"}],"_postman_id":"77dd6ade-e5ab-4f5d-ada7-a45e0cb8d230"}],"id":"f387e5b8-2dc4-484c-bf9a-5fae4f1c5582","description":"When initiating a collection or payout, you provide a callback URL in the payload, we use this to notify you of the transaction status. Please ensure your webhooks are https:// and are always available. If not provided in the payload, we will invoke the default URL in your account settings.
\nTransaction Status for Webhooks
\nThe transaction_status field indicates the success status of the collection/payout transation. It may contain any of the following values.
\nSample Webhook for successful transaction
\n{\nsuccess: true,\nstatus_code: 100,\nmessage: 'Transaction completed Successfully',\ntransaction_id: '4c2a169dda4c54f61d33',\ntransaction_amount: 10,\nsender_name: 'Johhn Nadala',\ntransaction_ref: 'Ymdnsfh',\ndebitor_account: 'Ymdnsfh',\ntransaction_status: 'Success',\ncommand_status: 'ok',\nreference_number: 'Ymdnsfh'\n}\n\nSample Webhook for failed transaction
\n{\nsuccess: false,\nstatus_code: 112,\nmessage: 'Transaction Failed',\ntransaction_id: '07f967a5d1a40eed1840',\ntransaction_ref: 'Ymdns5454fh',\ndebitor_account: 'Ymdns4343fh',\nreference_number: 'Ymdns5454fh'\n}\n\nIn order to accept webhooks with confidence, we encourage use of 2 security features.
\nIMPORTANT NOTE: The webhook may be invoked more than once for the same transaction. Please validate so as not to double debit.
\n","_postman_id":"f387e5b8-2dc4-484c-bf9a-5fae4f1c5582","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a collection within Nigeria, use this example. It initiates a request to /direct debit endpoint with instructions to collect Nigerian Naira. Payment will be completed with Transfer. The Bank and account to transfer to are provided in a successful response.
\nFor Nigeria, our API responds with a redirect url where a mechant can redirect a customer. We also return the bank account details incase the merchant wishes to create a custom checkout page.
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"b8ee44cf-6418-46a0-bb2e-968700cc33be","name":"Collection Nigeria","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"TRANSFER_NG\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"XV34387\",\r\n \"debitor_mobile\": \"254722140588\",\r\n \"debitor_currency_code\": \"NGN\",\r\n \"debitor_country_code\": \"NG\",\r\n \"reference_number\": \"43434343N\",\r\n \"amount\": 20,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\":\"https://sandbox.webpayment.io/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 12 May 2023 10:35:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"497"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1f1-TNhaKbk/6CjTHt4dMecoygCJfNI\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"transaction_id\": \"8835277ec50e7c92d2e3\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\",\n \"message\": \"Pay NGN 20 to vfd, Account: WebPayment, Account Number: 4700060288\",\n \"pay_instructions\": {\n \"bank_name\": \"vfd\",\n \"account_number\": \"4700060288\",\n \"account_name\": \"WebPayment\",\n \"amount\": 20\n },\n \"redirect_url\": \"https://checkout.webpayment.io/nigeria/transaction_id/8835277ec50e7c92d2e3/amount/20/bank/vfd/accountname/WebPayment/accountno/4700060288\"\n}"}],"_postman_id":"2e0c44ae-a39e-456f-8d17-1f399b6b45ca"},{"name":"Collection South Africa","id":"9b0d959f-ff15-494e-b625-44cdd6b12433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a collection within South Africa, use this example. It initiates a request to /directdebit endpoint with instructions to collect South African Rand. Payment will be completed with eft.
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"fa8dc67b-1c72-4f2a-bd09-20f273529b7e","name":"Collection South Africa","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"api_username\": \"demo\",\r\n\t\"route_name\": \"SOUTH_AFRICA\",\r\n\t\"debitor_name\": \"Joseph Webo\",\r\n\t\"debitor_account\": \"XV34387\",\r\n\t\"debitor_mobile\": \"+27112345678\",\r\n\t\"debitor_currency_code\": \"ZAR\",\r\n\t\"debitor_country_code\": \"ZA\",\r\n\t\"reference_number\": \"43434343N\",\r\n\t\"amount\": 20,\r\n\t\"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n\t\"callback_url\": \"https://webhook.site/e784fe13-546f-4ac2-ac62-3b4ca97d39f2\",\r\n\t\"redirect_url\": \"yourwebpageurl\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 06 Feb 2026 10:09:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"368"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"170-sHJF7yOJI4d7iR+MWmsyhUiqYFo\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Follow redirect link to complete payment\",\n \"api_username\": \"demo\",\n \"transaction_id\": \"797d22f3561f3c6b9125\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\",\n \"redirect_url\": \"https://secure.stitch.money/connect/payment-request/9b55589e-8fc2-40fd-baa5-07d359cc0880?redirect_uri=https://api.webpayment.io/stitch-callback\"\n}"}],"_postman_id":"9b0d959f-ff15-494e-b625-44cdd6b12433"},{"name":"Collection Kenya","id":"c3ac0e15-49c5-48d2-a4cd-37694106b8d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a collection within Kenya, use this example. It initiates a request to /direct debit endpoint with instructions to collect Kenyan Shillings. Payment will be completed with MPESA Mobile Money.
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"9b193545-8a73-40b9-87b7-d12fc74c1279","name":"Collection Kenya","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"MPESADIRECT\",\r\n \"debitor_name\": \"Kiprop Nadala\",\r\n \"debitor_account\": \"Ymdnsfh\",\r\n \"debitor_mobile\": \"254722140588\",\r\n \"debitor_currency_code\": \"KES\",\r\n \"debitor_country_code\": \"KE\",\r\n \"reference_number\": \"Ymdnsfh\",\r\n \"amount\": 10,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\":\"https://sandbox.webpayment.io/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:50:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"199"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c7-PoXeDvmTymeDdyYvlnqDehimPko\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Collection initated successfully\",\n \"api_username\": \"demo\",\n \"transaction_id\": \"7cc94c6ef314c369db85\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"}],"_postman_id":"c3ac0e15-49c5-48d2-a4cd-37694106b8d6"},{"name":"Collection Ghana","id":"3b4301e6-40df-4bbb-a15f-467080d82901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a collection within Ghana, use this example. It initiates a request to /direct debit endpoint with instructions to collect Ghanaian Cedis. Payment will be completed with the following Mobile Money Platforms: MTN, AIRTEL/Tigo and Vodafone.
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"6888588d-3eba-4508-a446-4791889dcc0e","name":"Collection Ghana","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"GHANA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"0546305463\",\r\n \"debitor_currency_code\": \"GHS\",\r\n \"debitor_country_code\": \"GH\",\r\n \"reference_number\": \"456776\",\r\n \"amount\": 7,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\":\"https://api.webpayment.live/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:47:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"182"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b6-9T0SLxizPFUkbadxEo676UO027o\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"status_code\": 112,\n \"transaction_id\": \"0ac661f7978859210db7\",\n \"command_status\": \"fail\",\n \"remit_status\": \"ERROR_OCCURED\",\n \"message\": \"Transaction is pending on provider end.\"\n}"}],"_postman_id":"3b4301e6-40df-4bbb-a15f-467080d82901"},{"name":"Collection West Africa","id":"b95a94c0-0b78-431d-ad52-2b348b9d2621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a collection within West Africa, use this example. It initiates a request to /direct debit endpoint with instructions to collect XOF(West African francs). Payment will be completed with the following Mobile Money Platforms: orange money,mtn etc.
\nPlease note that orange network requires otp code for 'CI', 'GN', 'BF', 'SN' countries. We will return a redirect url where a merchant can redirect the customer or optionally request the otp from the customer and send it as 'otp' in the request body.
\nSupported XOF/XAF countries
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"e1f4f602-e355-4ad1-8593-6f8c457bffdb","name":"Collection West Africa","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"0767475356\",\r\n \"debitor_currency_code\": \"XOF\",\r\n \"debitor_country_code\": \"CI\",\r\n \"reference_number\": \"456776\",\r\n \"amount\": 7,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\":\"https://api.webpayment.live/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:48:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"199"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c7-RlrKoOeK+75bypYOzvNb5MMpYxo\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Collection initated successfully\",\n \"api_username\": \"demo\",\n \"transaction_id\": \"8596abdb2d459bd1605f\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"}],"_postman_id":"b95a94c0-0b78-431d-ad52-2b348b9d2621"},{"name":"Query Transaction Status","id":"92b30aa0-dc11-4927-8c65-97666eb5e4d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"To Check the status of a Transaction, use this endpoint. Provide the Transaction ID that was issued when initiating the collection.
\nUpdate: You may also check the status of a transaction using your own reference using the key: \"merchant_reference\" in the payload.
\n","urlObject":{"path":["collectionrefNumStatus"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"2e133e67-844f-4d36-bfcc-c239cd9b5163","name":"Query Transaction Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"transaction_id\": \"8835277ec50e7c92d2e3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/collectionrefNumStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 12 May 2023 10:41:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"296"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"128-1HJsdR1NcfMmIoklTYjFLNPTg7E\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Transaction Failed\",\n \"status_code\": 112,\n \"api_username\": \"demo\",\n \"transaction_id\": \"8835277ec50e7c92d2e3\",\n \"transaction_amount\": 20,\n \"transaction_reference\": \"43434343N\",\n \"debited_account\": \"XV34387\",\n \"sender_name\": \"Joseph Webo\",\n \"transaction_status\": \"Failed\",\n \"command_status\": \"ok\"\n}"}],"_postman_id":"92b30aa0-dc11-4927-8c65-97666eb5e4d6"},{"name":"View Collection Networks","id":"105d378c-38bb-44be-8ed2-a2205ffa42de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"To view possible collection networks, use this endpoint
\n","urlObject":{"protocol":"https","path":["fetchnetworks"],"host":["api","webpayment","io"],"query":[],"variable":[]}},"response":[{"id":"4d9215c1-dce8-4e7b-8e58-d3f8b44a207e","name":"View Collection Networks","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/fetchnetworks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:54:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"850"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"352-RVoe+dFSeaYgpjzcvKc+cmuzFG8\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Request was successful\",\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"command_status\": \"ok\",\n \"Collection_Networks\": [\n {\n \"CollectionName\": \"MPESADIRECT\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"KE\",\n \"Instructions\": \"Mpesa Collection \"\n },\n {\n \"CollectionName\": \"TRANSFER_NG\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"NG\",\n \"Instructions\": \"Transfer Nigeria\"\n },\n {\n \"CollectionName\": \"WESTAFRICA_MOBILEMONEY\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"CI\",\n \"Instructions\": \"IVORYCOAST money network\"\n },\n {\n \"CollectionName\": \"SOUTH_AFRICA\",\n \"CollectionType\": \"BANK\",\n \"SupportDirectDebit\": true,\n \"Country\": \"ZA\",\n \"Instructions\": \"SOuth Africa\"\n },\n {\n \"CollectionName\": \"GHANA_MOBILEMONEY\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"GH\",\n \"Instructions\": \"Mobile money Ghana\"\n }\n ]\n}"}],"_postman_id":"105d378c-38bb-44be-8ed2-a2205ffa42de"},{"name":"Collection LATAM","id":"50535840-e175-483e-ac52-517b61f45080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For the debit to be succesfull please follow the following guidelines
\napi_username->The api_username provided to you by the team
\ndebitor_name -> The name of the customer making the transaction
\ndebitor_account ->The account number if the debitor
\ndebitor_mobile -> The mobile number of the debitor
\ndebitor_currency_code -> The currecy code in the Alpha-3 code format
\ndebitor_country_code -> The country code in the Alpha-3 code format
\nreference_number -> Your internal transaction id to reference the transaction
\nemail -> The email of the debitor
\nroute_name -> this should always be \"LATAM\"
\namount -> amount to debit
\nclient_datetime-> Your local datetime
\ncallback_url -> The url where the transactionresults will be sent
\nSupported Coutries:
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"8ff3f3d7-7566-4d61-b64f-3d2d9f3a3d94","name":"Collection LATAM","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_username\": \"demo\",\n \"route_name\": \"LATAM\",\n \"debitor_name\": \"Test name\",\n \"debitor_account\": \"1234567\",\n \"debitor_mobile\": \"+254707030720\",\n \"debitor_currency_code\": \"BRL\",\n \"debitor_country_code\": \"BRA\",\n \"reference_number\": \"45677676712\",\n \"amount\": 7,\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\n \"callback_url\": \"https://webhook.site/b30537b8-3d06-4258-bba0-678df3a663ff\",\n \"meta_data\": {\n \"document\": {\n \"id\": \"34669130000133\",\n \"type\": \"The Collection API enables merchants to initiate requests for payments in over 11 countries/currencies. All requests are made to the same endpoint: https://api.webpayment.io/directdebit The difference is in the API request payload, which will vary: currency code, country, collection network name.
\nThere are 2 main types of Collection APIs.
\nRedirect- Navigates the depositor away from the page to complete payment(Common for card payments, bank transfer, and some mobile networks which require OTP). Developer may add redirect_url in request, to navigate the user back to the payment page.
\nNon-Redirect- Does not redirect depositor away from the page(Common for mobile money transactions)
\nFor making a CARD collection, use this example. It initiates a request to /directdebit endpoint.
NB:
Testing Cards
\n","urlObject":{"path":["directdebit"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"8fe754f7-6548-4219-9e0e-7b5cdcbd9c6b","name":"Collection Card","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"CARD_GATEWAY\",\r\n \"debitor_name\": \"John Doe\",\r\n \"debitor_account\": \"28473454\",\r\n \"debitor_mobile\": \"2547########\",\r\n \"debitor_currency_code\": \"USD\",\r\n \"debitor_country_code\": \"KE\",\r\n \"reference_number\": \"437866RF\",\r\n \"amount\": 10,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\":\"https://sandbox.webpayment.io/webhook-example\",\r\n \"redirect_url\":\"https://sandbox.webpayment.io/webhook-example\",\r\n \"email\":\"test@test.com\",\r\n \"billing_address\":\"delaware\",\r\n \"billing_city\":\"paris\",\r\n \"billing_zipcode\":\"00100\",\r\n \"billing_state\":\"NY\",\r\n \"card_no\":\"123456789123\",\r\n \"card_expiry_month\":\"12\",\r\n \"card_expiry_year\":\"2023\",\r\n \"card_cvc\":\"098\",\r\n \"customer_ip_address\":\"41.90.66.217\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directdebit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 17 Mar 2023 11:33:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"266"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"10a-mTAGuJ52ldpAm8jXyoKiPtprBgc\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"transaction_id\": \"6ae02eb2551d861d1831\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\",\n \"message\": \"Success\",\n \"redirect_url\": \"https://ts.secure1gateway.com/api/v2/ProcessTxSend3DS_KY?key3ds=766e1be933f1146a236e5de0d575151f\"\n}"}],"_postman_id":"8e48f625-1e0e-412b-ab1f-90ce83103412"},{"name":"Card Collection Reversal","id":"2ab6f6e9-0fe7-4af2-99e8-4fcbc3ed163b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Reverses a collection made via CARD_GATEWAY.\ntransaction_id is returned to the merchant once a collection has been initated
\n","urlObject":{"path":["collectionReversal"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"a55dae38-e006-4d3f-ae46-b697c0538136","name":"Card Collection Reversal","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"transaction_id\": \"6340e9db0476f886c065\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/collectionReversal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 20 Mar 2023 05:36:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"199"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c7-Jt25dXPVrX/9YMKzpjXCDsuWWGc\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"transaction_id\": \"6340e9db0476f886c065\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\",\n \"message\": \"Reversal accepted for processing\"\n}"}],"_postman_id":"2ab6f6e9-0fe7-4af2-99e8-4fcbc3ed163b"},{"name":"Blacklisted Countries for cards collection","id":"76f24a5d-a068-47ac-8067-16df5e98bf49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.webpayment.io/cardsblacklistedcountries","description":"We do not accept collections from these countries
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Webpayment offers merchants a card payment method that is secure and seamlessly integrates. Our Cards payment gateway is fully PCI DSS compliant and enables you to brand your card checkout page with your own logo.
\n","_postman_id":"f75a2747-5769-45ee-9096-af00f2cc4bd4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a payout within Kenya, use this example. It initiates a request to /direct payout endpoint with instructions to pay Kenya Shillings via Mpesa.
\n","urlObject":{"path":["directpayout"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"3bf16fea-f2f7-47ce-88c0-4eaa1655ca7c","name":"Payout Kenya","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"MPESADIRECT\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"XV34387\",\r\n \"debitor_mobile\": \"254700000000\",\r\n \"debitor_currency_code\": \"KES\",\r\n \"debitor_country_code\": \"KE\",\r\n \"reference_number\": \"43434N\",\r\n \"amount\": 10,\r\n \"callback_url\":\"https://api.webpayment.live/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:55:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c3-+BTxMATw3KbIw86qhzMtMgTmJHE\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Payout initated successfully\",\n \"api_username\": \"demo\",\n \"transaction_id\": \"043757186192f6f6b3f9\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"}],"_postman_id":"3e7a91d9-a5a9-4511-afb3-3079fbaa47ef"},{"name":"Payout Ghana","id":"d9c79872-3644-4acf-b9ba-b0347ab200f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a payout within Ghana, use this example. It initiates a request to /direct payout endpoint with instructions to collect pay Ghana Cedes via Mobile Money. Ensure you include payee mobile number
\n","urlObject":{"path":["directpayout"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"5bb48401-acb6-4b3b-893b-965093970190","name":"Payout Ghana","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"GHANA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"XV34387\",\r\n \"debitor_mobile\": \"0584957374\",\r\n \"debitor_currency_code\": \"GHS\",\r\n \"debitor_country_code\": \"GH\",\r\n \"reference_number\": \"43434N\",\r\n \"amount\": 13,\r\n \"callback_url\":\"https://api.webpayment.live/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:55:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"92"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"5c-v9bpWnWrif9leQYHDiZPYHZsBE8\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 113,\n \"message\": \"Insufficient Balance to Complete Transaction\",\n \"success\": false\n}"}],"_postman_id":"d9c79872-3644-4acf-b9ba-b0347ab200f7"},{"name":"Payout West Africa","id":"14039941-4c75-4966-94a7-0751a44216a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"For making a payout within West Africa, use this example. It covers a number of countries: Ivory Coast, Togo, Cameroon, Senegal, Guniea(Conackry)
\n","urlObject":{"path":["directpayout"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"181e2fb0-f887-476a-9216-15ad1fb725f6","name":"Payout West Africa","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"XV34387\",\r\n \"debitor_mobile\": \"254722140588\",\r\n \"debitor_currency_code\": \"XAF\",\r\n \"debitor_country_code\": \"CMR\",\r\n \"reference_number\": \"43434N\",\r\n \"amount\": 13,\r\n \"callback_url\":\"https://api.webpayment.live/webhook-example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:58:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"c3-VqnNvG9iP4vEOHVLPc1GISixvu8\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Payout initated successfully\",\n \"api_username\": \"demo\",\n \"transaction_id\": \"dace74dc4029eb056909\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"}],"_postman_id":"14039941-4c75-4966-94a7-0751a44216a6"},{"name":"Payout Nigeria","id":"0a38c19b-af96-4115-8623-539956e750f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"NB:
\nTo view possible collection networks, use this endpoint
\n","urlObject":{"protocol":"https","path":["fetchpayoutnetworks"],"host":["api","webpayment","io"],"query":[],"variable":[]}},"response":[{"id":"78b1dcde-fee8-4434-8592-f28a23a5713a","name":"View Payout Networks","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/fetchpayoutnetworks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 13:58:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"563"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"233-ylUi7V6W3pQnsjfps+XlSfzZ728\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Request was successful\",\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"command_status\": \"ok\",\n \"Collection_Networks\": [\n {\n \"CollectionName\": \"MPESADIRECT\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"KE\",\n \"Instructions\": \"Mpesa Collection\"\n },\n {\n \"CollectionName\": \"WESTAFRICA_MOBILEMONEY\",\n \"CollectionType\": \"MOBILEMONEY\",\n \"SupportDirectDebit\": true,\n \"Country\": \"CI\",\n \"Instructions\": \"IVORYCOAST money network\"\n },\n {\n \"CollectionName\": \"SOUTH_AFRICA\",\n \"CollectionType\": \"BANK\",\n \"SupportDirectDebit\": true,\n \"Country\": \"ZA\",\n \"Instructions\": \"SOuth Africa\"\n }\n ]\n}"}],"_postman_id":"af29b42a-32d4-4cba-82cd-17c6fb1b9bf9"},{"name":"Query Payout Status","id":"c7782c69-35fa-46e0-bfed-cca71c7c3bf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"To Check the status of a Transaction, use this endpoint. Provide the Transaction ID that was issued by us when initiating the collection.
\nUpdate: You may also check the status of a transaction using your own reference using the key: \"merchant_reference\" in the payload.
\n","urlObject":{"path":["payoutrefNumStatus"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"fa332909-9f05-4643-9533-c0bcd870f70c","name":"Query Payout Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"api_username\": \"demo\",\r\n\"transaction_id\": \"19c66c6a2aed045315bb\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/payoutrefNumStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 05 Dec 2022 14:00:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"308"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"134-iH2JXJYNGttTgyGY9D64VgVEFk0\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Request was successful\",\n \"status_code\": 100,\n \"api_username\": \"demo\",\n \"transaction_id\": \"19c66c6a2aed045315bb\",\n \"transaction_amount\": 1,\n \"transaction_reference\": \"43434N\",\n \"debitor_account\": \"XV34387\",\n \"sender_name\": \"Joseph Webo\",\n \"transaction_status\": \"Credit In Progress\",\n \"command_status\": \"ok\"\n}"}],"_postman_id":"c7782c69-35fa-46e0-bfed-cca71c7c3bf0"},{"name":"View Payout account balance","id":"c326d92a-042e-4e2a-8963-de0a823f3014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint moves collected funds to your payout wallet
\n","urlObject":{"path":["moveFundsToPayoutWallet"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"d9e64619-635a-4d0b-b1aa-0fb2b7f082bb","name":"Move funds to payout wallet","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 1,\r\n \"currency_code\": \"XOF\",\r\n \"api_username\": \"demo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/moveFundsToPayoutWallet"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 14 Nov 2023 13:31:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"138"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"8a-qHcplxhVdRxcedLICDKDS1R7/gE\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 100,\n \"message\": \"Request successfully submitted for processing. You will receive an email once this is done!\",\n \"success\": true\n}"}],"_postman_id":"3f70ce3d-1aa2-4d45-b3ab-856f4c5db2e1"},{"name":"Fetch a list of Banks","id":"cd4af0b2-a3e7-4ce4-af2e-26dd8be17b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.webpayment.io/fetchbanks?country=nigeria","description":"This API is used to retrive a list of banks for the countries that support bank transfer. \nCurrently its working for:
\nThis API allows bank account verification before doing a payout.
\nNB: Currently works with Nigeria bank accounts
\n","urlObject":{"path":["verifyBankAccount"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"3f460865-5517-4747-bd49-d609a2520fa2","name":"Verify Bank Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"account_number\": \"Allows sending multiple payouts in a single API request
\n","urlObject":{"path":["directpayout-batch"],"host":["https://sandbox.webpayment.io"],"query":[],"variable":[]}},"response":[{"id":"63cf8150-1410-4fea-a283-c50aff22be48","name":"Batch Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"payouts\": [\r\n {\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"07700016654\",\r\n \"debitor_mobile_network\": \"MTN\",\r\n \"debitor_currency_code\": \"XOF\",\r\n \"debitor_country_code\": \"BF\",\r\n \"reference_number\": \"45677654\",\r\n \"amount\": 500,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\": \"https://webhook.site/6962d1f3-6188-43ba-938e-0ac0033084b1\"\r\n },\r\n {\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"07700016654\",\r\n \"debitor_mobile_network\": \"MTN\",\r\n \"debitor_currency_code\": \"XOF\",\r\n \"debitor_country_code\": \"BF\",\r\n \"reference_number\": \"456776\",\r\n \"amount\": 500,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\": \"https://webhook.site/6962d1f3-6188-43ba-938e-0ac0033084b1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout-batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 15 Jan 2024 09:44:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"87-jSyQ5nTQRt4Qfh1x1na630QXs+M\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Payouts submitted successfully\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"},{"id":"6eccce54-e3c3-42d7-b30c-751c8db0ff4f","name":"Batch Payout","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_username\": \"demo\",\r\n \"payouts\": [\r\n {\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"07700016654\",\r\n \"debitor_mobile_network\": \"MTN\",\r\n \"debitor_currency_code\": \"XOF\",\r\n \"debitor_country_code\": \"BF\",\r\n \"reference_number\": \"45677654\",\r\n \"amount\": 500,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\": \"https://webhook.site/6962d1f3-6188-43ba-938e-0ac0033084b1\"\r\n },\r\n {\r\n \"route_name\": \"WESTAFRICA_MOBILEMONEY\",\r\n \"debitor_name\": \"Joseph Webo\",\r\n \"debitor_account\": \"NYUGDSF-GH\",\r\n \"debitor_mobile\": \"07700016654\",\r\n \"debitor_mobile_network\": \"MTN\",\r\n \"debitor_currency_code\": \"XOF\",\r\n \"debitor_country_code\": \"BF\",\r\n \"reference_number\": \"456776\",\r\n \"amount\": 500,\r\n \"client_datetime\": \"2021-07-25T15:54:45+02:00\",\r\n \"callback_url\": \"https://webhook.site/6962d1f3-6188-43ba-938e-0ac0033084b1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout-batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 15 Jan 2024 09:44:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"135"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"87-jSyQ5nTQRt4Qfh1x1na630QXs+M\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status_code\": 100,\n \"message\": \"Payouts submitted successfully\",\n \"command_status\": \"ok\",\n \"remit_status\": \"CREDIT_IN_PROGRESS\"\n}"}],"_postman_id":"00f52228-5b0f-45df-989a-693aed6e64b1"},{"name":"Payout LATAM","id":"485df427-86f4-4809-a615-ab5cb6d56653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_username\": \"demo\",\n \"route_name\": \"LATAM\",\n \"debitor_name\": \"Joseph Webo\",\n \"debitor_account\": \"775757757575\",\n \"debitor_mobile\": \"123456789\",\n \"debitor_currency_code\": \"BOB\",\n \"debitor_country_code\": \"BOL\",\n \"reference_number\": \"43YTFD4N\",\n \"amount\": 1,\n \"callback_url\":\"https://sandbox.webpayment.io/webhook-example\",\n \"bank_code\":\"007\",\n \"email\":\"test@test.com\",\n \"account_type\":\"S\",\n \"document_type\":\"CI\",\n \"document_id\":\"4822012-1B\",\n \"bank_name\":\"BANCO DE GALICIA Y BUENOS AIRES S.A.U.\",\n \"payment_method\":\"1099\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.webpayment.io/directpayout","description":"For the Payout to be succesfull please follow the following guidelines
\napi_username->The api_username provided to you by the team
\ndebitor_name -> The name of the customer making the transaction
\ndebitor_account ->The account number if the debitor
\ndebitor_mobile -> The mobile number of the debitor
\ndebitor_currency_code -> The currecy code in the Alpha-3 code format
\ndebitor_country_code -> The country code in the Alpha-3 code format
\nreference_number -> Your internal transaction id to reference the transaction
\nemail -> The email of the debitor
\nroute_name -> this should always be \"LATAM\"
\namount -> amount to debit
\nclient_datetime-> Your local datetime
\ncallback_url -> The url where the transactionresults will be sent
\naccount_type ->This is either S for savings or C for current accounts
\ndocument_type _>This is the document type to be used for verification, these can can found from the api __Latam payout Options
\ndocument_id -> This is the document identifiacttion of the customer
\nbank_name -> The customers bank name
\npayout_method -> This is the payout method to be used,this can be found on the api Latam payout Options
\nReplace the last part of the url with the country the payout is to take place
\nie for Argentina the complete url will be
\nhttps://sandbox.webpayment.io/latam-payout-options/ARG
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Payout API enables merchants to initiate requests for disbursement in over 11 countries/currencies. All requests are made to the same endpoint: https://api.webpayment.io/directpayout The difference is in the API request payload, which will vary: currency code, country, collection network name.
\n