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. For example, to charge $10.00 AUD, pass 10.
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.
boolean
Indicates whether the payment should be automatically captured. If set to true, the payment will be captured immediately; if false, it may require manual capture later. Note: Card statement descriptor is configured at the merchant account level and cannot be passed dynamically.

Response Body

The response for the Create Intent request is a JSON object with the following schema:
number
The HTTP status code of the response envelope (e.g. 200).
string
Informational message (e.g. "Payment intent created successfully").
string
The unique identifier for the payment intent (prefixed with int_).
number
The amount in decimal dollars.
string
The currency of the intent (e.g. AUD).
Note: To inspect the payment intent lifecycle status (e.g. REQUIRES_CAPTURE, SUCCEEDED), use the Retrieve Intent endpoint.

Response Codes

Last modified on November 10, 2026