Webhooks

Batch Notifications

Batch Webhook Structure Data Type: JSON

The webhook payload is delivered in JSON format, a structured data format commonly used for APIs. Each payload includes:

Variable	Type	Description
event	String	The event will following current progress of this batch.
amount	Integer	Batch total amount in cent.
currency	String	Currency of this batch.
batch_id	String	Unique ID of the updated batch.
status	String	Status of the current batch progress.
batch_run_time	Integer	Unix timestamp of the batch running time.
batch_reference	String	Reference of this batch.
process_amount	Integer	Actual batch total amount in cent when batch processed.
total_failed	Integer	Total of failed payout records.
total_tx	Integer	Total of payout records.
subccount_id	String	Unique ID of the updated batch's subaccount.
created_at	Integer	Unix timestamp when batch record created.
timestamp	Integer	Unix timestamp of the event.

Batch Notification Event

Event	Description
batchUpdate	Indicates that batch have been updated in a single operation.

Batch Notification Status

Status	Description
open	Batch is in the open for new created payout.
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.

Example

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