Skip to main content

Create a Payout

POST 
/v1/payouts

Initiate a batch payout to multiple recipients using either PayID or BSB-enabled accounts. This API enables efficient bulk payment processing, allowing merchants to handle payouts to multiple recipients in a single request.

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

Payment statuses:

  • created: Payout 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 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., [email protected]).
  • Either payid or both bsb and account_number are required. You cannot use both payid and bsb/account_number in the same request for a single transaction.

Request​

Responses​

Payout batch created successfully.

Callbacks​

POST 
{$request.body#/endpoint_url}

Callbacks Responses​

Callback received successfully