The Payout API no longer supports crypto payouts. The Payout API does not send crypto payout webhooks. Use Webhook events for Crypto API webhook data.
Parameter overview
| Parameter | Description |
|---|---|
message | Indicates the status of the transaction. |
transaction_id | A unique identifier for the transaction. |
transaction_reference | A unique identifier for the transaction. |
merchant_reference | The reference that you supplied on the payout. It is null if you supplied no reference. |
transaction_status | The status of the transaction (e.g., SUCCESSFUL). |
transaction_fee | The fee charged for the transaction. |
transaction_amount_without_fee | The amount sent excluding fees. |
transaction_amount | The total amount including fees. |
transaction_currency | The currency in which the transaction is conducted (USD). |
customer_id | The customer associated with the transaction |
recipient | Details of the recipient, including: |
recipient.account_number | The recipient’s bank account number. |
recipient.account_name | The name associated with the recipient’s bank account. |
recipient.bank_name | The name of the bank holding the recipient’s account. |
recipient.amount | The net amount that the recipient received. |
recipient.wallet_address | The wallet address of the recipient if payment was made via crypto. |
event_id | A unique identifier for the event. |
type | The type of transaction (e.g., payout). |
Example payload
{
"message": "Transaction Completed",
"transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
"transaction_reference": "90980e50-0b83-40a6-aa46-ac8e795b1acd",
"merchant_reference": "ORDER-1001",
"transaction_status": "SUCCESSFUL",
"transaction_fee": 39.12,
"transaction_amount_without_fee": 612.88,
"transaction_amount": 652.0,
"transaction_currency": "USD",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"recipient": {
"account_number": "123456789",
"routing_number": "021000021",
"account_name": "Sarah Williams",
"bank_name": "Chase Bank",
"wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb0",
"amount": 990.00
},
"event_id": "9d46b957-0cf5-4743-847a-254d92de6a85",
"type": "payout"
}