Log inGet started
Airwallex logo
Online Payments
Transactional FX
Open Banking
Developer Tools
API Reference
Online Payments
Starting with paymentsTransaction and settlement modelPricing model
Payment Methods
OverviewGlobalEU & UK
RegionalAustriaBelgiumEstoniaGermanyItalyLatviaLithuaniaNetherlandsPolandPortugalUnited Kingdom
Pay by Bank app (PbBa)
Desktop/Mobile Website Browser

Desktop/Mobile Website Browser

Accept Pay by Bank app (PbBa) payments on your website by redirecting shopper to PbBa payment page. See checkout process below:

  1. The shopper selects Pay by Bank app as their payment method on the merchant’s checkout page
  2. The shopper is redirected to the payment page where a 6-digit alphanumeric code and information about the payment method are displayed
  3. The shopper logs in to their banking app on their phone and enters the code to authorize the payment
  4. The shopper is redirected back to the merchant confirmation page

Step 1. Initialize a Payment Intent

Create a PaymentIntent object with a request_id, amount, currency and a merchant_order_id from your backend server.


Step 2. Get available payment methods

To be able to display PbBa as a payment option on your checkout page, you need to get available payment methods from Airwallex API.

When the PaymentIntent is created, send a GET request with parameters country_code, transaction_currency, transaction_mode to API endpoint /api/v1/pa/config/payment_method_types to query for a list of available payment method based on the information provided. The response will also contain the required fields and necessary resources of each payment method for you to display them on your page.


Response: Render payment methods in items to show all available payment methods to the shopper at checkout page.

Note for available payment methods:

Alternatively, you can maintain available payment methods and corresponding resources locally on your server if you do not want to use this API endpoint. However, we highly recommend you get available payment methods dynamically from this API to avoid any trouble when payment method information or resources get updated.

Step 3. Redirect to PbBa to complete payment

When a shopper selects to pay with PbBa on their desktop/mobile browser, call the following API endpoints to get the URL which you can use to redirect the shopper to PbBa payment page to complete the payment.

  1. Obtain URL from Airwallex and redirect shopper to PbBa



Response: Render the value of url to redirect shoppers to PbBa.

  1. Wait for notification from Airwallex

Airwallex will notify you on the payment result asynchronously via the webhook API. Please refer to webhook documentation to set up your webhook accordingly. Although subscribing to different events is optional, it is recommended to at least subscribe to the payment_intent.succeeded which indicates that the shopper has successfully paid for the order via PbBa.

  1. Query the PaymentIntent status

You may also query the status of a payment anytime via the PaymentIntents API