Payout
CAD
Webhook payload for CAD payout transactions
When your CAD payouts are confirmed or initiated, details about the transaction are sent in a payload that provides essential information for record-keeping and reconciliation.
Transaction list and detail responses use external_reference for payouts in all currencies, including CAD and GBP.
Completed CAD payout webhooks keep interac_reference. Payout-initiated webhooks do not include either field.
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. |
interac_reference | The Interac reference number for the completed payout. A string, or null when no reference is available. Absent from payout_initiated webhooks. |
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 (CAD). |
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. |
extras | Extra/Additional Information |
extras.interac_instruction | Contains the security question and answer for the transaction |
event_id | A unique identifier for the event. |
type | The type of transaction (e.g., payout or payout_initiated). |
Example payloads
Initiated
{
"message": "Transaction Initiated",
"transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
"transaction_reference": "2a446ee4-8d3a-40ed-b33f-6430df69e7bf",
"merchant_reference": "ORDER-1001",
"transaction_status": "PENDING",
"transaction_fee": 0.4,
"transaction_amount_without_fee": 19.6,
"transaction_amount": 20.0,
"transaction_currency": "CAD",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"recipient": {
"account_number": null,
"account_name": "Oluwatobi Ishola",
"bank_name": null,
"amount": 19.6
},
"extras": {
"interac_instruction": {
"question": "What is the PIN?",
"answer": 1234
}
},
"event_id": "9d46b957-61b2-4b27-85cf-059069893237",
"type": "payout_initiated",
"developer_note": "This is a payout initiated webhook. This is not a final webhook. The final webhook (payment confirmation) will be sent when the transaction is completed."
}Completed
The completed payout webhook includes interac_reference at the top level. Use this reference to identify the Interac transfer.
The value is null when no reference is available. The existing extras.interac_instruction field is unchanged.
{
"message": "Transaction Completed",
"transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
"transaction_reference": "2a446ee4-8d3a-40ed-b33f-6430df69e7bf",
"interac_reference": "CA123456789",
"merchant_reference": "ORDER-1001",
"transaction_status": "SUCCESSFUL",
"transaction_fee": 0.4,
"transaction_amount_without_fee": 19.6,
"transaction_amount": 20.0,
"transaction_currency": "CAD",
"customer_id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
"recipient": {
"account_number": null,
"account_name": "Oluwatobi Ishola",
"bank_name": null,
"amount": 19.6
},
"extras": {
"interac_instruction": {
"question": "What is the PIN?",
"answer": 1234
}
},
"event_id": "9d46b957-61b2-4b27-85cf-059069893237",
"type": "payout"
}