Skip to main content
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.

​
Parameter overview

ParameterDescription
messageIndicates the status of the transaction.
transaction_idA unique identifier for the transaction.
transaction_referenceA unique identifier for the transaction.
transaction_statusThe status of the transaction (e.g., SUCCESSFUL).
transaction_feeThe fee charged for the transaction.
transaction_amount_without_feeThe amount sent excluding fees.
transaction_amountThe total amount including fees.
transaction_currencyThe currency in which the transaction is conducted (CAD).
customer_idThe customer associated with the transaction
recipientDetails of the recipient, including:
recipient.account_numberThe recipient’s bank account number.
recipient.account_nameThe name associated with the recipient’s bank account.
recipient.bank_nameThe name of the bank holding the recipient’s account.
recipient.amountThe net amount that the recipient received.
extrasExtra/Additional Information
extras.interac_instructionContains the security question and answer for the transaction
event_idA unique identifier for the event.
typeThe 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",
  "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

{
  "message": "Transaction Completed",
  "transaction_id": "20580e50-1b32-40a6-aa46-ac8e795b3zas",
  "transaction_reference": "2a446ee4-8d3a-40ed-b33f-6430df69e7bf",
  "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"
}