Configurations
Configuration
Use configuration settings to control how the Pay by Bank App is launched, which payment options are offered, and how the hosted checkout experience looks and behaves.
This page covers the main settings available for the Pay by Bank App, including:
- launch mode
- payment experience options
- default payment method order
- suggested payer details
- branding
- additional settings managed by Azupay support
At a glance
| Configuration area | What it controls |
|---|---|
| Checkout launch mode | Whether the payment experience opens as a hosted redirect or inside an iFrame |
| Payment experience options | Whether customers see PayID, PayTo, or both |
| Default payment method | Which payment option is shown first when both are enabled |
| Suggested payer details | Whether payer details are prefilled to streamline checkout |
| Branding | Your logo and theme colour in the hosted payment experience |
| Support-managed settings | Additional PayTo behaviour configured by Azupay support |
Configuration options
Checkout launch mode
Choose how customers enter the Pay by Bank App.
Redirect checkout
- opens the hosted payment experience as a full-page journey
- best when you want a simple, dedicated payment flow
- suited to most implementations
iFrame checkout
- embeds the hosted payment experience inside your own page
- best when you want the payment step to remain within your existing journey
- useful when maintaining an on-page checkout experience is important
What to expect
- both options use the returned
checkoutUrl - the same hosted payment experience is used, but the way it is presented to the customer differs
Payment experience options
Choose which payment methods customers can use in the Pay by Bank App.

PayID only
- offer real-time account-to-account payments using PayID
- suited to transaction-based payments, customer-linked payments, and flexible funding flows
PayTo only
- offer authorised bank payments using PayTo
- suited to once-off or recurring agreement-based payment journeys
PayID and PayTo
- offer both payment methods in the same hosted experience
- suited when you want to give customers a choice between payment types
What to expect
- the payment methods shown in checkout will reflect your configured experience
- if both are enabled, you can choose which one is shown first
- these settings are self-service through the Azupay Dashboard
Default payment method
If both PayID and PayTo are enabled, you can choose which payment option the customer sees first.
Default to PayID
- best when PayID is your primary payment collection method
- useful for transaction-based and customer-linked payment flows
Default to PayTo
- best when PayTo is your preferred payment experience
- useful when agreement-based payments are the primary use case
What to expect
- customers can still switch between payment methods when both are enabled
- this setting controls the default landing experience only
- these settings are self-service through the Azupay Dashboard
Suggested payer details
Use suggested payer details when you already know the customer’s preferred PayID or bank details.
What this helps with
- reduces customer input during checkout
- helps guide customers toward the expected payment account
- can improve conversion by making the payment experience faster and simpler
How it can be used
- prefill a customer’s PayID
- prefill customer bank details where supported
- in some flows, payer details can also be guided more strictly so the expected account is used
What to expect
- the hosted payment experience displays the provided payer details
- this is most useful when the merchant already knows which payer account should be used
- this is to be provided in the API call
Branding and appearance
Use branding settings to make the hosted payment experience feel like part of your business.
You can configure
- logo
- theme or accent colour
Why it matters
- creates a more familiar customer experience
- helps the hosted flow feel consistent with your brand
- reduces the sense that customers are leaving your environment to complete payment
What to expect
- your branding is applied throughout the hosted Pay by Bank App experience
- these settings are self-service through the Azupay Dashboard
Support-managed settings
Some Pay by Bank App settings are managed by Azupay and may require a support request to change.
Examples include
- whether PayTo is offered as a once-off experience or as a return-enabled experience
- default merchant-level settings applied to PayTo agreements
- other backend-managed payment experience defaults
What to expect
- these settings are not always self-service in the portal
- if you need to change them, contact Azupay support
When to raise a support request
- when you want to change how PayTo behaves for your hosted checkout
- when you need merchant-level defaults updated, such as agreement-related settings
Use the checkoutUrl
checkoutUrlOnce your Payment Request has been created, use the returned checkoutUrl to direct the customer into the hosted Pay by Bank App experience.
The checkoutUrl can be:
- opened as a redirect
- embedded in an iFrame, where supported
The hosted experience will then:
- present the configured payment methods
- reflect your default payment method order
- display your branding
- guide the customer through the payment journey based on your selected configuration
Updated 2 days ago
