Notification parameters

Learn all about receiving a notification. When and how.

The Payouts API will send notifications to your Notification URL using the POST protocol whenever there is a payout status change. The following is a list of the parameters included in the notification POST message:

FieldFormatDescriptionExample
external_idString (max. 100 chars)Payout identification (at the Merchant Dashboard).payout1234
cashout_idNumber (max. 10 chars)Payout identification (at Merchant Dashboard).10050
dateFormat: YYYY-MM-DD HH:MM:SS (GMT)The date when the status changed.2015-10-03 15:32:01
bank_reference_idString (max. 50 chars)Number reference at the bank.513512.04198.5
commentsString (max. 200 chars)Payout commentThis is a comment.

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 
comments&control=6C40B2B4E7F43EF7EA3C6C0F386C11865D60892591301CDF6C62FBE6A5FFEF1D