Skip to main content
POST
Payouts are supported in 160+ countries. The bsb field applies to Australian bank accounts. For bank accounts in other countries, collect details with the hosted form from Beneficiary URL or the Beneficiary SDK, which show the right fields for the worker’s country.

Headers

string
default:"1.2"
required
The API version to use. Supported versions are 1.1 and 1.2.

Headers

string
required
A unique UUID string used to prevent duplicate operations.

Request Body Parameters

string
The Bank State Branch code (6 digits) for Australian bank accounts. Use 065163 in the demo environment.
string
required
12345678 for Sandbox Environment.
string
required
The name associated with the bank account.
string
required
The unique ID of the worker.

Response Body

number
Indicates the status of the request. A value of 200 indicates success.
string
A message related to the status of the request.

Response Codes

Last modified on November 10, 2026