Skip to main content
POST

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
required
The unique ID of the worker initiating the payout.
string
The ID of the job for which the payout is being initiated. Either job ID or reference is required.
string
The reference for the payout request. Either job ID or reference is required.
number
required
The amount to be transferred in decimal dollars (e.g. 500.00). Do not pass cents.
string
required
The currency of the payout (e.g. AUD).
boolean
Indicates whether the payout should be processed against an invoice.
string
The ID of the invoice against which the payout should be processed. Required when against_invoice is true.
string
The payout mode. Defaults to BANK_TRANSFER. NPP is also supported. Make sure the mode you choose is supported in the recipient’s country.

Response Body

Response Codes

Last modified on November 10, 2026