Guides
Help CentreService DeskStatus PageDashboard | ProductionDashboard | UATTest Bank

Receive PayID Payments

PayID payments

Use PayID payments in the Pay by Bank App when you want to receive real-time account-to-account payments through a generated PayID and hosted checkout experience.

Dynamic PayID

Single exact payment for a single transaction.

Multi-payment PayID

Multiple payments toward a target amount.

Open PayID

Flexible customer-linked payments of any amount.

Reusable customer PayID

The same customer PayID reused across billing cycles.



Choose the right PayID model

Payment modelBest forKey behaviour
Dynamic PayIDOne-off purchases, invoices, bookingsAccepts a single exact payment, then closes
Multi-payment PayIDInstalments or split paymentsAccepts multiple payments until the target amount is reached
Open PayIDWallet top-ups and account fundingAccepts multiple payments of any amount over time
Reusable customer PayIDPeriodic billing and repeat customer paymentsReuses the same customer-specific PayID when a new payment is due

Payment patterns

Dynamic PayID

A Dynamic PayID is a short-lived PayID generated for a single transaction.

Best for: one-off purchases, invoices, bookings, and transaction-based payments where you want a single payment matched to a single event.

What to expect:

  • a unique PayID is generated in real time
  • the payer is prompted to pay the exact amount requested
  • once paid, the PayID is deregistered
  • duplicate or unintended follow-up payments are prevented
  • set amount in the Payment Request
  • do not set multiPayment=true
  • do not provide a payId
Multi-payment PayID

A Multi-payment PayID allows multiple payments to be made toward a target amount.

Best for: instalments, split payments, or payment scenarios where the full amount may not be received in one transfer.

What to expect:

  • the payer can make partial payments against the same PayID
  • the checkout experience updates based on the cumulative amount received
  • once the target amount has been reached, the PayID is deregistered
  • if an overpayment occurs, the excess amount is automatically refunded

When multiPayment=true, the PayTo option is not available for that payment request.

  • set amount in the Payment Request
  • set multiPayment=true
  • do not provide a payId
Open PayID

An Open PayID is a reusable PayID that can accept multiple payments of any amount over time.

Best for: wallet top-ups, account funding, stored-value balances, and customer-linked payment flows.

What to expect:

  • each customer can be assigned their own PayID
  • customers can pay any amount
  • the PayID can remain available over an extended period
  • customers can save the PayID in their banking app for repeat use

Encourage customers to save their PayID in their banking app for faster repeat payments.

  • set multiPayment=true
  • leave expiryTime empty, or set a long-dated expiry
  • optionally provide a meaningful payId for the customer, such as a customer number or recognisable identifier
Reusable customer PayID

A reusable customer PayID is a customer-specific PayID that you reactivate when a new payment is due.

Best for: periodic billing, utilities, account servicing, and repeat customer payment requests.

What to expect:

  • the customer pays to the same PayID each time a bill is issued
  • each Payment Request can carry a new amount and payment description
  • once the requested amount is received, the PayID is deregistered
  • when the next payment is due, you create a new Payment Request using the same payId
  • set amount
  • provide a payId for the customer and retain it in your system
  • leave expiryTime empty, or set a long-dated expiry
  • always use the same payId for the same customer when creating future Payment Requests

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 details to the payer
  • guide them through the PayID payment flow
  • reflect the payment status as funds are received
  • show the correct outcome for successful, partial, expired, or incorrect payments depending on the payment configuration

Updated 2 days ago