Notification
It is a webhook for publishers to receive a notification. Publishers should provide the webhook URL to the integration support team to receive the notification.
Webhook headers
x-signature
To perform an integrity check, signature value for checksum
Content-Type
Content type will always be application/json
Webhook payload
payout_id
A unique ID of the payout, created by Coda
request_id
A unique request ID that is attached to the payout request, created by Merchant
request_amount
Total requested payout amount
target_amount
Total final amount paid out to beneficiary (after deducting fees, gst, various taxes depending on Merchant contract with Coda)
Note: request_amount and target_amount can be in different currencies
payout_status
Payout status for this transaction. Refer to the Payout Statuses table for the different statuses.
error
This will show the error message if there is an error.
Sample Notification Payload
{
"payout_id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
"request_id": "request_id",
"request_amount": {
"value": 10.0,
"currency_code": "USD"
},
"target_amount": {
"value": 10.0,
"currency_code": "PHP"
},
"payout_status": {
"code": "success",
"message": "Payout is successful"
},
"error": null
}{
"payout_id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
"request_id": "request_id",
"request_amount": {
"value": 10.0,
"currency_code": "USD"
},
"target_amount": {
"value": 10.0,
"currency_code": "PHP"
},
"payout_status": {
"code": "Failed",
"message": "Payout has failed, refer to the error message for more details."
},
"error": {
"code": "INCOMPLETE_DATA",
"message": "Data sent are incomplete and the request cannot be completed."
}
}Last updated
Was this helpful?