Efficient management of multi-currency payments
Create, query, manage and automate your outgoing transactions to customers or external entities with our multi-currency payouts API. Our system supports a wide range of currencies and integrates seamlessly with various PSPs (Payment Service Providers) and EMIs (Electronic Money Institutions).
Payout Lifecycle Events
The following events will be emitted during the lifecycle of a payout. To receive webhook's for these events, see Notification Configuration API.
FLOW_PAYOUT_COMPLETED
: The payout has been successfully processed and accepted.FLOW_PAYOUT_RETURNED
: The payout has been returned by the beneficiary bank.FLOW_PAYOUT_UPSERT
: An update or insertion of payout details has occurred.FLOW_PAYOUT_FAILED
: The payout has failed to process.FLOW_PAYOUT_SUBMITTED
: The payout request has been submitted.
Payout Returns
In certain cases, the beneficiary bank may refuse to process a payout. This situation can be represented in one of two ways in our system:
- Payout Return: The payout is returned, with the status of your payout request updated to
RETURNED
and aFLOW_PAYOUT_RETURNED
event emitted. - Returned as Payin: The payout is returned to the account as a payin. In this scenario, there are no references to the original payout in the system.
It is important to consider how your payin automation is implemented and how it may be affected by an incoming payin resulting from a returned payout.
Payout Purpose
The purpose field can be a string up to 100 characters or a PUC code. The following table lists the PUC codes that are currently supported. A code in the PUC format must be used when making a payout via FED_WIRE to an international beneficiary:
PUC Code | Description |
---|---|
PUC001 | Transfer to own account |
PUC002 | Family Maintenance |
PUC003 | Education-related student expenses |
PUC004 | Medical Treatment |
PUC005 | Hotel Accommodation |
PUC006 | Travel |
PUC007 | Utility Bills |
PUC008 | Repayment of Loans |
PUC009 | Tax Payment |
PUC010 | Purchase of Residential Property |
PUC011 | Payment of Property Rental |
PUC012 | Insurance Premium |
PUC013 | Life Insurance |
PUC014 | Insurance Claims Payment |
PUC015 | Mutual Fund Investment |
PUC016 | Investment in Shares |
PUC01801 | Information Service Charges |
PUC01802 | Advertising & Public relations-related expenses |
PUC01803 | Royalty fees, trademark fees, patent fees, and copyright fees |
PUC01804 | Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee |
PUC01805 | Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists |
PUC01806 | Representative office expenses |
PUC01807 | Construction costs/expenses |
PUC01808 | Transportation fees for goods |
PUC01809 | For payment of exported goods |
PUC01810 | Delivery fees for goods |
PUC01811 | General Goods Trades - Offline trade |
PUC020 | Salary |
As an example, the following JSON object represents the PUC codes and their descriptions:
{
"PUC001": "Transfer to own account",
"PUC002": "Family Maintenance",
"PUC003": "Education-related student expenses",
"PUC004": "Medical Treatment",
"PUC005": "Hotel Accommodation",
"PUC006": "Travel",
"PUC007": "Utility Bills",
"PUC008": "Repayment of Loans",
"PUC009": "Tax Payment",
"PUC010": "Purchase of Residential Property",
"PUC011": "Payment of Property Rental",
"PUC012": "Insurance Premium",
"PUC013": "Life Insurance",
"PUC014": "Insurance Claims Payment",
"PUC015": "Mutual Fund Investment",
"PUC016": "Investment in Shares",
"PUC01801": "Information Service Charges",
"PUC01802": "Advertising & Public relations-related expenses",
"PUC01803": "Royalty fees, trademark fees, patent fees, and copyright fees",
"PUC01804": "Fees for brokers, front end fee, commitment fee, guarantee fee and custodian fee",
"PUC01805": "Fees for advisors, technical assistance and academic knowledge, including remuneration for specialists",
"PUC01806": "Representative office expenses",
"PUC01807": "Construction costs/expenses",
"PUC01808": "Transportation fees for goods",
"PUC01809": "For payment of exported goods",
"PUC01810": "Delivery fees for goods",
"PUC01811": "General Goods Trades - Offline trade",
"PUC020": "Salary"
}