Skip to main content

Create Payment Agreement

POST 
/v1/pay_to/payment_agreement

Create a payment agreement that enables recurring or one-time payments between merchants and payers. This agreement specifies the transaction structure, including payment limits, agreement type, and callback details for status notifications.

Available payment methods:

  • pay_id: Use PayID as the payment method, which can be an email, phone number, or Australian Business Number (ABN). This provides a secure and streamlined payment option using a unique identifier.
  • bsb: Use BSB (Bank-State-Branch) and account number as the payment method, which is suitable for direct bank transfers within Australia.

The endpoint also supports merchant callback configurations to notify merchants of status changes in the payment agreement.

Request​

Responses​

Payment agreement created successfully.

Callbacks​

POST 
{$request.body#/payment_agreement_notification/endpoint_url}

Callbacks Responses​

Callback received successfully.