Skip to main content

Create Payout Batch via File

POST 
/v1/payouts/

This API enables you to create a batch payout to PayID or NPP-enabled BSB accounts by uploading a file containing payout details, facilitating bulk payment processing to multiple recipients efficiently.

If a payout cannot be processed due to insufficient funds and the is_retry flag is set to true, the system will continue to attempt processing until sufficient funds are available, either through a top-up or new incoming payments.

Payment statuses:

  • created: Payout payment created and pending further processing.
  • processing: Payout has been topped up to the corresponding PayID and is currently being processed.
  • scheduled: Waiting for funds to be debited from the payer's account; the payout is scheduled but not yet executed.
  • completed: Payout payment has been completed successfully for the entire batch. Note that individual transaction failures do not affect the completion status of the overall batch.

Important notes:

  • If using a phone number as the PayID, prefix it with the country code, separated by a dash. For example: +61-412345678.
  • PayIDs using email addresses must be in lowercase (e.g., johnwick@gmail.com).

Request​

Responses​

Payout batch created successfully.

Callbacks​

POST 
{$request.body#/endpoint_url}

Callbacks Responses​

Callback received successfully