Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewChoose your payments solutionGet started with payments
Supported currencies
Online payments
Invoice integrations
Payment methods
Payment Methods OverviewGlobal
EU & UK
APAC
NORTH AMERICA & LATAM
ACH Direct Debit - BETA
EFT Pre-Authorized Debit - BETA
Desktop/Mobile Website Browser Save bank details for future payments
Micro-deposit verification
SPEI - BETA

Save bank details for future payments

This guide describes how to save shopper's bank details and use it for subsequent payments.

Save bank details for the first time

  1. Call Create a Customer API if it is a new customer and save the returned Customer ID.

Example request:

Shell

Example response:

JSON
  1. Create a PaymentConsent API with the Customer ID from Step 1, and save Consent ID for subsequent transactions. Note that a payment consent can be created without providing a payment method immediately. You can update payment_consents API to attach payment_method later on.

Example request:

Shell

Example response:

JSON
  1. Verify payment_consents API through a transaction authorization or verification. You have 2 options to get the payment consent verified

Option 1: Save bank account details without a payment

The shopper only attaches the bank account details for future payments.

Plaid verification

Example request:

Shell

Example response:

JSON

Micro deposit verification

Example request:

Shell

Example response:

JSON

Micro deposit + micro debit verification

Example request:

Shell

Example response:

JSON

Option 2: Save bank account details during payment

The shopper pays for the first order and attaches the bank account details for future payments. You can Create a PaymentIntent API and Confirm a PaymentIntent API with payment_consent_reference from Step 2. This will return SUCCEEDED status for the first payment if the verification is successfull.

Example request:

Shell

Example response:

JSON

Plaid verification

Example request:

Shell

Example response:

JSON

Micro deposit verification

Example request:

Shell

Example response:

JSON

Successful verification will result in the status of payment consent changed to VERIFIED. If the payment consent is not verified, the status will stay as PENDING_VERIFICATION, and next_action will appear in the response.

Initiate a subsequent transaction using stored bank account details

  1. Create a PaymentIntent API with the corresponding Customer ID.

Example request:

Shell
Shell

Example response:

JSON
  1. Confirm a PaymentIntent API with payment_consent_reference.id to request payment with reference to the stored PaymentConsent.

Example request:

Shell

Example response:

JSON
  1. You can also get a list of PaymentConsents API with the corresponding Customer ID to render the list of shopper’s payment methods they previously saved.

Example request:

Shell

Example response:

JSON
On this page