Desktop/Mobile Website Browser
This guide describes how to offer EFT Pre-Authorized Debit as a payment method on your checkout page using Native API integration.
Step 1. Create a PaymentIntent
Create a PaymentIntent object with a request_id, amount, currency and a merchant_order_id from your backend server.
Example request:
Example response:
If you want to skip verification for all transactions, please contact your Airwallex account manager for instructions.
Step 2. Get available payment methods
To be able to display EFT PAD as an 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.
Example request:
Example response:
Render payment methods in items to show all available payment methods to the shopper at checkout page.
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. Collect payment method details and mandate acknowledgement
You should display the exact authorization terms below for your customer on the checkout form. Only upon your customer’s authorization will you be able to initiate debits from your customer’s bank account.
By providing your bank account details and confirming this payment, you authorize Airwallex US, LLC to electronically debit your account via EFT Pre-Authorized Debit for the total payment amount specified on this page, and, if necessary, electronically credit your account to correct erroneous debits. You certify that you are either the holder of, or an authorized signatory on, the bank account.
If you integrate through Hosted Payment Page (HPP) or Drop-in, Airwallex will display the authorisation terms for you.
When a shopper submits EFT PAD on checkout form, you should use payment_intent/confirm to collect the mandate and complete the payment. For EFT PAD, we support two verification methods: Plaid and micro-deposit.
Option 1: Plaid verification
You can select the verification method by setting payment_method_options.eft_direct_debit.verification_method. You can provide owner_name, owner_email and whether it is business_account so that shopper will see these fields pre-filled on the confirmation page.
Example request:
Example response:
Option 2: Micro-deposit verification
You can also verify EFT PAD with micro-deposits by providing the following payload.
Example request
When fraud scanning requires you to VERIFY the account, you will find the next actions in the response of Confirma a PaymentIntent API.
Example response
Airwallex will send a notification email to your shopper automatically to guide them on micro-deposits verification. If you want to customize the experience, please contact our Sales Support to turn off the Airwallex notification email and use the url returned in the response to build your own verification flow.
You can use instructions as below to guide your shoppers on checkout.
You will receive two micro-deposits to your account in 1-2 business days. You can click the verify button or verify through the email we have sent you.
Step 5. Wait for notifications from Airwallex
EFT PAD provides delayed notifications, which means that the transaction cannot be authorized instantly. An EFT PAD PaymentIntent remains in a pending state after submission to the EFT network. Once the payment succeeds, the associated PaymentIntent status updates from pending to succeeded.
The following events are sent when the PaymentIntent status is updated.
| EVENT | DESCRIPTION | NEXT STEPS |
|---|---|---|
payment_intent.pending | The shopper’s payment was submitted to Airwallex successfully. | Wait for the initiated payment to succeed or fail. |
payment_intent.succeeded | The customer’s payment has succeeded. | Provision goods and services. |
payment_attempt.authorization_failed | The customer’s payment was declined. | Contact the shopper and request another payment method. |
payment_consent.pending_verification | The payment is undergoing verification. | N/A. This status should remain short for Plaid verification but may take 1-2 days for micro-deposit verification. |
payment_consent.verified | The customer's bank account has been successfully verified through Plaid or micro-deposits. | If you have disabled the authorization emails sent from Airwallex, you should notify your customers with the mandate confirmation. |
Succeeded payment intents can be disputed due to various reasons. You should familiarise yourself with the dispute risks of direct debits and contact your customers to resolve the situation. Learn more about disputes.
If the transaction fails after the request is sent to the bank, you can get the failed reason using payment_attempt.authorization_failed webhook.
You may also query the status of a payment anytime using Retrieve a PaymentIntent API
Test EFT PAD in demo environment
Use the following details to test EFT PAD in the demo environment.
| Account number | Test scenario |
|---|---|
| 0033441 | Verification required |
| 111122220000 | No verification required |
| Verification amounts | Test scenario |
|---|---|
| 0.04, 0.04 | Verification failed, with remaining attempts to retry |
| 1.04, 1.04 | Verification failed, no remaining attempts |
| Any other amount | Verification succeeded |
EFT PAD return codes reference
There are currently 20 distinct EFT PAD return codes. This list will be continually updated.
The most common of which are:
| Code | Title |
|---|---|
| 900 | Incorrect Bank Account Information |
| 901 | Insufficient Funds |
| 902 | Invalid Debtor Account Number |
| 903 | Order Cancelled |
| 905 | Closed Debtor Account Number |
| 907 | No Debit Allowed |
| 908 | Unsuccessful Direct Debit |
| 909 | Currency Account Mismatch |
| 910 | End Customer Deceased |
| 911 | Blocked Account |
The other return codes, which are less common, include:
| Code | Title |
|---|---|
| 912 | Incorrect Account Number |
| 914 | Missing Name |
| 915 | No Mandate |
| 916 | Not In Accordance With Mandate |
| 917 | Mandate Revoked |
| 918 | Missing Pre Notification |
| 919 | Not In Accordance With Mandate |
| 920 | Mandate Revoked |
| 921 | Missing Pre Notification |
| 990 | Institution In Default |