Make a Payment

To enable custom payment flows, the required payment channel can be selected by setting the channel attribute to one of the following combinations:

  • ["new_payments_platform"] - for faster payments 24/7/365
  • ["direct_entry"] - for slower traditional payments
  • ["new_payments_platform", "direct_entry"] - enables automatic channel switching if a payment fails on the NPP
We now require supplying an Idempotency-Key header when performing this request to ensure you can safely retry the action in case of an issue. If the header value is different to one provided previously, we will be treating a request as a new operation which may lead to duplicate payments. To understand more on how to make idempotent requests, please refer to our Idempotent requests guide.
Body Params
string
required

User description. Only visible to the payer. ASCII-printable characters and unicode emojis are accepted.

date-time
required

Date & time in UTC ISO8601 the Payment should be processed. (Can not be earlier than the start of current day in Sydney AEST/AEDT)

string
required

Specify where we should take the funds for this transaction. If omitted, your primary bank account will be used.

channels
array
required

Specify the payment channel to be used, in order. (new_payments_platform, direct_entry, or both)

channels*
payouts
array of objects
required

One Payout object only

payouts*
string
Headers
string
required

Idempotency key to support safe retries for 24h

string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json