Receive PayTo Payments

PayTo payments

Use PayTo payments in the Pay by Bank App when you want customers to authorise payment directly from their bank account.

PayTo supports three main receive-payment patterns:

Once-off PayTo

A single authorised payment collected directly from the customer’s bank account.

Recurring PayTo

An ongoing payment authority for future recurring collections.

Pay & Subscribe

An upfront payment collected now, with recurring payments authorised for later.



Choose the right PayTo model

Payment modelBest forWhat it does
Once-off PayToSingle authorised paymentsCollect one authorised payment from the customer’s bank account
Recurring PayToSubscriptions and repeat billingEstablish an ongoing payment authority for future collections
Pay & SubscribeUpfront payment plus repeat billingCollect an initial payment and set up an ongoing agreement

How PayTo works

flowchart LR
    A["Customer opens checkoutUrl"] --> B["Selects PayTo"]
    B --> C["Enters PayID or bank details"]
    C --> D["Reviews payment or agreement"]
    D --> E["Authorises in banking app"]
    E --> F["Payment or agreement status updates in checkout"]

Payment patterns

Once-off PayTo

Use Once-off PayTo when you want to collect a single authorised payment from a customer’s bank account.

Best for:

  • one-time purchases
  • account settlement
  • higher-value payments where bank authorisation is preferred

What to expect:

  • the customer authorises a single payment
  • the payment is approved through their banking environment
  • no ongoing payment authority is created

Configure it like this:

  • create a PayTo payment request for a single payment
  • do not configure it as a recurring agreement
{
  "amount": 150.00,
  "description": "Order 12345",
  "PaymentAgreementRequest": {
    "clientTransactionId": "your-unique-id",
    "agreementStartDate": "2026-04-13",
    "agreementEndDate": "2026-04-13",
    "agreementFrequency": "ADHOC"
  },
  "successRedirectURL": "https://merchant.example/success",
  "cancelRedirectURL": "https://merchant.example/cancel"
}
Recurring PayTo

Use Recurring PayTo when you want to establish an ongoing payment authority for future collections from the customer’s bank account.

Best for:

  • subscriptions
  • memberships
  • instalment plans
  • repeat service payments

What to expect:

  • the customer authorises an ongoing PayTo agreement
  • future payments can be collected under that agreement
  • the hosted UX supports repeat payment journeys
  • where enabled, passkeys can streamline the return payment experience

Configure it like this:

  • create a PaymentAgreementRequest
  • set different agreementStartDate and agreementEndDate values
  • set the recurring agreementFrequency
  • set agreementMaximumAmount for future recurring collections
{
  "PaymentAgreementRequest": {
    "clientTransactionId": "your-unique-id",
    "agreementStartDate": "2026-04-13",
    "agreementEndDate": "2027-04-13",
    "agreementFrequency": "MONTHLY",
    "agreementMaximumAmount": 50.00
  },
  "successRedirectURL": "https://merchant.example/success",
  "cancelRedirectURL": "https://merchant.example/cancel"
}
Pay & Subscribe

Use Pay & Subscribe when you want to collect an initial payment now and also establish a recurring PayTo agreement for future payments.

Best for:

  • subscription sign-up flows
  • memberships with an upfront payment
  • services that begin immediately and continue on a recurring basis

What to expect:

  • the customer completes an upfront payment during checkout
  • the customer also authorises an ongoing PayTo agreement
  • the flow combines immediate collection with future recurring billing

Configure it like this:

  • set amount for the payment collected immediately
  • include a PaymentAgreementRequest for future recurring payments
  • set the recurring agreementFrequency
  • set agreementMaximumAmount for future recurring collections
{
  "amount": 20.00,
  "description": "Subscription sign-up",
  "PaymentAgreementRequest": {
    "clientTransactionId": "your-unique-id",
    "agreementStartDate": "2026-04-13",
    "agreementEndDate": "2027-04-13",
    "agreementFrequency": "MONTHLY",
    "agreementMaximumAmount": 50.00
  },
  "successRedirectURL": "https://merchant.example/success",
  "cancelRedirectURL": "https://merchant.example/cancel"
}

What the customer sees

The hosted Pay by Bank App guides the customer through the full PayTo journey, including:

  • entering their payment details
  • reviewing the payment or agreement
  • authorising in their banking app
  • seeing payment or agreement status updates in checkout

Use the checkoutUrl

Once your Payment Request has been created, use the returned checkoutUrl to direct the payer into the hosted Pay by Bank App experience.

The checkout experience will:

  • present the payment or agreement details to the payer
  • guide them through the PayTo authorisation flow
  • support once-off or recurring payment journeys depending on configuration
  • reflect the payment or agreement status through the hosted UX