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 for the payment link in decimal dollars (e.g. to charge $250.00 AUD, pass 250.00). Do not pass cents.
string
required
The currency of the payment.
string
required
Description of the payment link.
string
required
Expiry date and time for the payment link, must be in future.
string
required
Reference for the payment link.
string
required
Title of the payment link.
boolean
If true, the payment link can be reused for multiple payments. Defaults to false.

Response Body

The response for the Generate Payment Link request is a JSON object with the following schema:
string
Provides information about the payment link generation process.
string
The unique identifier for the generated payment link.
string
The URL of the generated payment link.

Response Codes

Test Card Numbers

Last modified on November 10, 2026