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

number
required
The amount of the payment in decimal dollars (e.g. to charge $25.00 AUD, pass 25.00). Do not pass cents.
string
required
The currency of the payment.
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.
string
required
The unique identifier of the customer for whom the payment is being created.
boolean
A flag indicating whether the payment should be automatically captured after being created. If set to true, the payment will be captured immediately; if false, it may require manual capture later.

Response Body

The response is in JSON format and contains:
number
Indicates the status code of the payment creation request.
string
Provides any additional information related to the payment creation process.
string
Represents the status of the payment (e.g., SUCCEEDED, REQUIRES_CAPTURE, FAILED).
string
The unique identifier for the payment intent.

Response Codes

Last modified on November 10, 2026