Status Webhooks

Account Created

{
    "event":  "accountCreated",
    "bsb":  "012003",
    "account_number": "712179",
    "receiver_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
    "receiver_account_id":  "6afec8ad-c026-463b-9f09-f60adfae10a0",
    "status":  "completed",
    "confirm_status": "unconfirmed",
    "timestamp":  1710091428000
}

Account Updated

{
    "event":  "accountUpdate",
    "bsb": "012003",
    "account_number": "712179",
    "receiver_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
    "receiver_account_id":  "6afec8ad-c026-463b-9f09-f60adfae10a0",
    "status":  "completed",
    "confirm_status": "confirmed",
    "timestamp":  1719980696994
}

Account confirm status :

"unconfirmed" = Receiver has not yet confirmed the bank details sent for payout via email/ SMS. "confirmed" = Receiver has confirmed the bank details sent for payout via email or SMS.

Payout Created

{
    "event":  "payoutCreated",
    "amount": 2000,
    "currency": "AUD",
    "payout_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
    "receiver_account_id":  "6afec8ad-c026-463b-9f09-f60adfae10a0",
    "receiver_id":"e4908c83-6656-408a-8ba2-61dae8f039a5",
    "reference": "ref-a00020",
    "status":  "awaiting",
    "subccount_id":  "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
    "timestamp":  1710091428000
}

Payout Update

{
    "event":  "payoutUpdate",
    "amount": 2000,
    "currency": "AUD",
    "payout_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
    "batch_id":  "b4ac0283-354c-4008-9b25-0338198b6fa0",
    "batch_run_time" :  1710282140000,
    "receiver_account_id":  "6afec8ad-c026-463b-9f09-f60adfae10a0",
    "receiver_id":"e4908c83-6656-408a-8ba2-61dae8f039a5",
    "reference": "ref-a00020",
    "status": "successful",
    "subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
    "timestamp": 1710091428000
}

Payout Failure

{
    "event":  "payoutFailure",
    "amount": 2000,
    "currency": "AUD",
    "payout_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
    "receiver_account_id":  "6afec8ad-c026-463b-9f09-f60adfae10a0",
    "receiver_id":"e4908c83-6656-408a-8ba2-61dae8f039a5",
    "reference": "ref-a00020",
    "status": "failed",
    "cause": "bank account not valid",
    "subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
    "timestamp": "1710091428000"
}

Payout status :

"awaiting" = Payout is waiting for the receiver to confirm their bank details. "pending" = Payout in pending for processing time. "in_progress" = Payout is currently in progress. "successful" = Payout has been successfully completed. "cancelled" = Payout has been cancelled. "failed" = Payout process has failed.

Batch Update

{
    "event": "batchUpdate",
    "amount":  2440,
    "currency": "AUD",
    "batch_id": "13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
    "status": "queue",
    "batch_run_time": 1724965200000,
    "batch_reference":  "BATCH_API_13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
    "process_amount": 0,
    "total_failed":  0,
    "total_tx":  1,
    "subccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
    "created_at":"e4908c83-6656-408a-8ba2-61dae8f039a5",
    "timestamp": "1710091428000"
}

Batch status :

"queue" = Batch is in the queue, waiting to be processed. "in_progress" = Batch is currently in progress. "settled" = Batch has been successfully settled. "cancelled" = Batch has been cancelled. "failed" = Batch process has failed.

Receiver KYC Update

{
    "event":  "receiverKycUpdate",
    "receiver_id":"e4908c83-6656-408a-8ba2-61dae8f039a5",
    "kyc_status": "completed",
    "subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
    "timestamp": 1710091428000
}

KYC status :

"pending" = Pending customer to do KYC. "completed" = KYC process is successfully completed. "failed" = KYC process did not succeed.