Learn how to receive payout notifications.
The Payouts API will send notifications to your notification URL using the POST protocol whenever there is a change in payout status.
If you need to specify a port in the notification URL, it must be the standard HTTPS port 443, and the connection must use TLS 1.2.
Parameters
The following is a list of the parameters included in the notification POST message:
| Field | Format | Description |
|---|---|---|
external_id | String (max. 100 chars) | Payout identification (at the Merchant Dashboard). Example: payout1234 |
cashout_id | Number (max. 10 chars) | Payout identification (at Merchant Dashboard). Example: 10050 |
date | Format: YYYY-MM-DD HH:MM:SS (GMT) | The date when the status changed. Example: 2015-10-03 15:32:01 |
bank_reference_id | String (max. 50 chars) | Number reference at the bank. Example: 513512.04198.5 |
comments | String (max. 200 chars) | Payout comment. Example: This is a comment. |
status_reason | String (max. 200 chars) | Status reason (if available). Example: ERROR_ACCOUNT_INCORRECT |
control | String (max. 100 chars) | V2-HMAC-SHA256 signature. Example: FOR59E6E3F1353305181E1DCA20... |
Example
Content-Type: application/x-www-form-urlencoded
external_id=ext123
cashout_id=123456
date=2021-04-29 02:16:24
bank_reference_id=ref321
comments=Merchant
status_reason=ERROR_ACCOUNT_INCORRECT
control=FOR59E6E3F1353305181E1DCA204157FF47D1F014F4FB603EF4