Payouts overview
The payout capability enables you to facilitate payout functionality for your end users to payout to users worldwide.
Domestic bank accounts
Payouts to other bank accounts domestically (For SGD currency accounts)
Overseas bank accounts
Payouts to other bank accounts around the world (For USD currency accounts)
Payout to a domestic bank account
Create a recipient for domestic payment
Learn how to securely store a beneficiary's local bank account details for future use. This guide helps you understand the process of creating reusable recipient profiles for domestic bank transfers.
Perform a domestic payment
Understand the process for initiating a local bank-to-bank transfer to a saved domestic beneficiary. This guide will walk you through the process of making a payment using a previously created recipient profile.
Track the status of a domestic payment
Learn about the different status updates you will receive for domestic payments via webhooks. Understand how to interpret these events to track a payment's lifecycle from initiation to completion.
Simulate domestic payments
Learn how to test your complete domestic payment flow in our sandbox environment without moving real money. Use this guide to understand how to validate your integration by simulating various payment outcomes.
Payout to an overseas bank account
Create a recipient for cross-border payment
Learn how to securely store a beneficiary's details for future cross-border payments, supporting both bank accounts and remittance providers. This guide helps you understand the process of creating reusable recipient profiles for these transfers.
Manage cross-border recipients
Learn how to create and maintain beneficiary profiles to facilitate seamless cross-border payouts. Understand the necessary recipient details required by the payout network based on the target currency, country, and remittance mode.
Get a quote for cross-border payment
Understand how to get a time-limited quote with guaranteed foreign exchange rates and a transparent breakdown of all fees. This guide explains the mandatory step of locking in the financial details of a cross-border transfer.
Perform a cross-border payment using an existing beneficiary
Learn the standard process for executing a cross-border transfer to a saved beneficiary profile. This guide shows you how to use a previously generated quote to send funds to a known recipient.
Perform a cross-border payment without a existing beneficiary
Understand how to execute a one-time cross-border payment without first creating a recipient profile. This guide covers transfers where beneficiary details are provided at the time of the transaction, rather than selected from a saved profile.
Track the status of a cross-border payment
This guide explains the webhook statuses available to receive status updates on cross-border payments. Understand the various lifecycle statuses a cross-border payment goes through until it is completed.
Manage cross-border payments
Understand the post-initiation operations available for your cross-border payments. Learn how to retrieve transaction details and the appropriate actions to take based on the various status updates you receive.
Payout-related API and Webhooks
Payout Transactions
Payout Transactions
Domestic Payouts | Create New Beneficiary Bank Account |
| Create a beneficiary bank account (receiver) for domestic payout transfers |
Domestic Payouts | Get Beneficiary Bank Accounts |
| Retrieve all defined beneficiaries associated with a user account |
Domestic Payouts | Remove Beneficiary Bank Account |
| Remove and disassociate a beneficiary from a user account |
Domestic Payouts | Credit Bank Account |
| Initiate a domestic payout to a chosen beneficiary |
Domestic Payout Enumerations | Get Domestic Transfer Agents |
| Retrieve the list of supported local banks for domestic payout transfer |
Cross-border Payouts | Get Corridor List |
| Retrieve the list of all corridors available on the platform |
Cross-border Payouts | Get Corridor Details |
| Retrieve the corridor details of a specific corridor/route |
Cross-border Payouts | Get Payout Recipient Form |
| Retrieve the payout recipient form that contains the required fields necessary to create a remittance recipient for a particular corridor |
Cross-border Payouts | Create Remittance Recipient |
| Create a remittance recipient passing the requirements listed on the payout recipient form |
Cross-border Payouts | Update Remittance Recipient |
| Update a defined remittance recipient's details |
Cross-border Payouts | Update Recipient Status |
| Activate, deactivate, block, and delete a remittance recipient status |
Cross-border Payouts | Enquire Quotes |
| Retrieve a quotation or calculation of total deductibles for an intended remittance amount to a specific remittance corridor |
Cross-border Payouts | Send Remittance Transaction |
| Initiate a remittance transaction using a chosen recipient, corridor, and quotation |
Cross-border Payouts | Get All Transaction List |
| Retrieve all the remittance transactions made by a user |
Cross-border Payouts | Get Transaction Details |
| Retrieve the transaction details of a specific remittance transaction |
Cross-border Payouts | Get Transaction Timelines |
| Retrieve the transaction timeline involving the status changes of a specific remittance transaction |
Cross-border Payouts | Get Transaction Status |
| Retrieve the current status of a specific remittance transaction |
Cross-border Payouts Enumerations | Get Country List |
| Retrieve the available platform-supported countries |
Cross-border Payouts Enumerations | Get Currency List |
| Retrieve the available platform-supported currencies |
Cross-border Payouts Enumerations | Get Receiving Institutions List |
| Retrieve the list of supported banks and receiving institutions in the remittance receiving country |
Cross-border Payouts Enumerations | Get Receiving Institutions Branches List |
| Retrieve the list of supported banks and receiving institutions' branches in the remittance receiving country |
Webhook Category (non-API) | Transaction Payout Advisory, particularly the webhook events: | Webhook category to subscribe to receive notifications on payout transactions status updates | |
Webhook Event (non-API) | PAYOUT.QUOTE.CROSSBORDER.STATUS | Webhook notification on status updates containing details of quote validity and expiry | |
Webhook Event (non-API) | PAYOUT.RECIPIENT.CROSSBORDER.STATUS | Webhook notification on status updates of a recipient | |
Webhook Event (non-API) | PAYOUT.TRANSACTION.CROSSBORDER.STATUS | Webhook notification on status updates of a cross-border transaction | |
Webhook Event (non-API) | PAYOUT.TRANSACTION.CROSSBORDER.REVIEW.STATUS | Webhook notification on status updates on the result of the review made by the remittance rail on the transaction |
Related Links
On this page
- Payouts overview