Batch Disbursement
Introduction
The Disbursement API module allows a business to disburse funds cross-boarder, business-to-business (B2B) or business-to-consumer (B2C).
An application can use the Disbursement endpoints to securely move funds to over 200 countries and in multiple currencies. The APIs enable funds to be picked up in cash or deposited directly to their bank account, wallet, or card, giving businesses a greater choice on how they move funds.
API Sequence
This model for disbursing B2C or B2B funds consists of a single API call for faster transaction processing: Create a transaction with auto-commit. This model applies to business partners wanting to process business transactions without calling the quote, update and commit APIs. In this model, the business partner provides all the transactional information for a payment and submits it directly to the Create a transaction with auto-commit API.
- Business partner generates the payment information
The business partner generates the payment information. It must include the business partner information, beneficiary, service option, send amount, currency type, target account information if the transaction is being deposited to a bank, wallet, or card, and all other required transactional details.
- Create a transaction with auto-commit |
POST /disbursement/v1/transactions
POST /disbursement/v1/transactions The endpoint will validate all the transaction details, generates a uniqure transactionId resource, and auto-commit the payment. It will respond with a transaction reference number, which the customer can use to pick up the funds in cash or track the progress of their transfer. The funds will also be marked for settlement.
API Sequence Diagram
This model for disbursing B2C or B2B funds consists of a single API call for faster transaction processing: Create a transaction with auto-commit asynchronously. This model applies to business partners wanting to process business transactions without calling the quote, update and commit APIs. In this model, the business partner provides all the transactional information for a payment and submits it directly to the Create a transaction with auto-commit async API.
- Business partner generates the payment information
The business partner generates the payment information. It must include the business partner information, beneficiary, service option, send amount, currency type, target account information if the transaction is being deposited to a bank, wallet, or card, and all other required transactional details.
- Create a transaction with auto-commit async |
POST disbursement/v1/transactions/async
POST disbursement/v1/transactions/asyncThe endpoint will validate all the transaction details, generates a uniqure transactionId resource, and auto-commit the payment asynchronously. It will respond with a `transactionId` resource. The funds will also be marked for settlement.
API Sequence Diagram
Endpoints
| Name | HTTP Method | Endpoints | Description |
|---|---|---|---|
| Create with auto-commit | POST | /disbursement/v1/transactions | The Batch Disbursement w/Auto Commit API determines what information to collect from the customer, validates the data for compliance purposes and creates the transactionId resource and reference number for the transaction. |
| Create with auto-commit | POST | /disbursement/v1/transactions/async | The Batch Disbursement w/Auto Commit Async API determines what information to collect from the customer, validates the data for compliance purposes and creates the transactionId resource a webhook will respond with the Refernce number and transaction details. |
Updated 7 days ago
