 Account

A quick introduction to the essential dev tools for building with Airwallex

Developer Essentials

Explore the flexibility and power of Airwallex APIs

Quickly and securely integrate with Airwallex products using Airwallex SDKs

SDKs

Learn how to receive push notifications via webhooks

Webhooks

Use Airwallex's demo environment to simulate transactions before going live

Demo environment

Payload of webhook events: 
- account.active
- account.suspended

```curl
{
    "accountId":"acct_TOslkS7-MnyXlQuV8Lb4og",
    "data":Object{...},
    "id":"86b69f91-06f0-3fe8-8faf-4de58954ca8e",
    "name":"account.active"
}
```

__data__ is the response body of [Get account by ID](https://www.airwallex.com/docs/api#/Scale/Accounts/_api_v1_accounts__id_/get)

```curl
{
    "accountDetails": {
    "authorisedPersonDetails": {
        "attachments": {
        "identityFiles": [
            {
            "description": "string",
            "fileId": "string",
            "tag": "DRIVERS_LICENSE_FRONT"
            }
        ]
        },
        "email": "alice.smith@company.com",
        "fillingAs": "string",
        "firstName": "Alice",
        "firstNameEnglish": "Alice",
        "identificationNumber": "CKKK784512",
        "lastName": "Smith",
        "lastNameEnglish": "Smith",
        "nationality": "HK"
    },
    "beneficialOwners": [
        {
        "address": {
            "addressLine1": "200 Collins Street",
            "addressLine2": "200 Collins Street",
            "countryCode": "AU",
            "postcode": "3000",
            "state": "VIC",
            "suburb": "Melbourne"
        },
        "attachments": {
            "identityFiles": [
            {
                "description": "string",
                "fileId": "string",
                "tag": "DRIVERS_LICENSE_FRONT"
            }
            ]
        },
        "dateOfBirth": "1980-10-10",
        "firstName": "John",
        "firstNameEnglish": "Alice",
        "identificationNumber": "AAA5417287BB",
        "identificationType": "personalId",
        "lastName": "Smith",
        "lastNameEnglish": "Smith",
        "nationality": "CN"
        }
    ],
    "businessDetails": {
        "address": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "addressEnglish": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "asTrustee": true,
        "attachments": {
        "businessDocuments": [
            {
            "description": "string",
            "fileId": "string",
            "tag": "BUSINESS_LICENSE"
            }
        ]
        },
        "businessAddress": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "businessName": "Swift Concrete Pty Ltd",
        "businessNameEnglish": "Swift Concrete Pty Ltd",
        "businessRegistrationNumber": "A1098762872",
        "businessStructure": "COMPANY",
        "contactNumber": "6457892324",
        "descriptionOfGoodsOrServices": "string",
        "descriptionOfIndustry": "string",
        "industryCategory": "Financial Services and Products",
        "industryCategoryLevel3": "Mortgage broker and dealers",
        "industrySubCategory": "Lending",
        "operatingCountry": [
        "US",
        "AU"
        ],
        "purpose": "string",
        "trustName": "name",
        "url": "http://www.your_company.com",
        "vatNumbers": [
        {
            "countryCode": "UK",
            "vatNumber": "0000"
        }
        ]
    },
    "directorDetails": [
        {
        "address": {
            "addressLine1": "200 Collins Street",
            "addressLine2": "200 Collins Street",
            "countryCode": "AU",
            "postcode": "3000",
            "state": "VIC",
            "suburb": "Melbourne"
        },
        "attachments": {
            "identityFiles": [
            {
                "description": "string",
                "fileId": "string",
                "tag": "DRIVERS_LICENSE_FRONT"
            }
            ]
        },
        "dateOfBirth": "1980-10-10",
        "firstName": "Alice",
        "firstNameEnglish": "Alice",
        "identificationNumber": "RRHK784512",
        "identificationType": "personalId",
        "lastName": "Smith",
        "lastNameEnglish": "Smith",
        "nationality": "HK"
        }
    ],
    "individualDetails": {
        "address": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "addressEnglish": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "attachments": {
        "individualDocuments": [
            {
            "description": "string",
            "fileId": "string",
            "tag": "DRIVERS_LICENSE_FRONT"
            }
        ]
        },
        "dateOfBirth": "1970-11-28",
        "firstName": "Alice",
        "firstNameEnglish": "Alice",
        "lastName": "Smith",
        "lastNameEnglish": "Smith",
        "middleName": "Benedict",
        "nationality": "HK",
        "photoFileId": "string",
        "primaryIdentification": {
        "driversLicense": {
            "backFileId": "string",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "gender": "F",
            "issuingState": "VIC",
            "licenseNumber": "6275046",
            "version": "string"
        },
        "identificationType": "PASSPORT",
        "issuingCountryCode": "AU",
        "medicareCard": {
            "backFileId": "string",
            "cardNumber": "3395653571",
            "color": "GREEN",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "referenceNumber": "string"
        },
        "passport": {
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "mrzLine1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",
            "mrzLine2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",
            "passportNumber": "4107306240"
        },
        "personalId": {
            "backFileId": "string",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "idNumber": "string"
        }
        },
        "secondaryIdentification": {
        "driversLicense": {
            "backFileId": "string",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "gender": "F",
            "issuingState": "VIC",
            "licenseNumber": "6275046",
            "version": "string"
        },
        "identificationType": "PASSPORT",
        "issuingCountryCode": "AU",
        "medicareCard": {
            "backFileId": "string",
            "cardNumber": "3395653571",
            "color": "GREEN",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "referenceNumber": "string"
        },
        "passport": {
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "mrzLine1": "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<",
            "mrzLine2": "L898902C<3UTO6908061F9406236ZE184226B<<<<<14",
            "passportNumber": "4107306240"
        },
        "personalId": {
            "backFileId": "string",
            "effectiveAt": "2020-11-01",
            "expireAt": "2040-11-01",
            "frontFileId": "string",
            "idNumber": "string"
        }
        },
        "userIdOnPlatform": "string"
    },
    "legalEntityType": "INDIVIDUAL",
    "legalRepDetails": {
        "address": {
        "addressLine1": "200 Collins Street",
        "addressLine2": "200 Collins Street",
        "countryCode": "AU",
        "postcode": "3000",
        "state": "VIC",
        "suburb": "Melbourne"
        },
        "attachments": {
        "identityFiles": [
            {
            "description": "string",
            "fileId": "string",
            "tag": "DRIVERS_LICENSE_FRONT"
            }
        ]
        },
        "dateOfBirth": "1980-10-10",
        "firstName": "Alice",
        "firstNameEnglish": "Alice",
        "identificationNumber": "RRHK784512",
        "identificationType": "personalId",
        "lastName": "Smith",
        "lastNameEnglish": "Smith",
        "nationality": "HK"
    },
    "trusteeDetails": {
        "businessDetails": {
        "address": {
            "addressLine1": "200 Collins Street",
            "addressLine2": "200 Collins Street",
            "countryCode": "AU",
            "postcode": "3000",
            "state": "VIC",
            "suburb": "Melbourne"
        },
        "addressEnglish": {
            "addressLine1": "200 Collins Street",
            "addressLine2": "200 Collins Street",
            "countryCode": "AU",
            "postcode": "3000",
            "state": "VIC",
            "suburb": "Melbourne"
        },
        "attachments": {
            "businessDocuments": [
            {
                "description": "string",
                "fileId": "string",
                "tag": "BUSINESS_LICENSE"
            }
            ]
        },
        "beneficialOwners": [
            {
            "address": {
                "addressLine1": "200 Collins Street",
                "addressLine2": "200 Collins Street",
                "countryCode": "AU",
                "postcode": "3000",
                "state": "VIC",
                "suburb": "Melbourne"
            },
            "attachments": {
                "identityFiles": [
                {
                    "description": "string",
                    "fileId": "string",
                    "tag": "DRIVERS_LICENSE_FRONT"
                }
                ]
            },
            "dateOfBirth": "1980-10-10",
            "firstName": "John",
            "firstNameEnglish": "Alice",
            "identificationNumber": "AAA5417287BB",
            "identificationType": "personalId",
            "lastName": "Smith",
            "lastNameEnglish": "Smith",
            "nationality": "CN"
            }
        ],
        "businessName": "Swift Concrete Pty Ltd",
        "businessNameEnglish": "Swift Concrete Pty Ltd",
        "businessRegistrationNumber": "A1098762872",
        "businessStructure": "COMPANY",
        "contactNumber": "6457892324",
        "descriptionOfGoodsOrServices": "string",
        "descriptionOfIndustry": "string",
        "directorDetails": [
            {
            "address": {
                "addressLine1": "200 Collins Street",
                "addressLine2": "200 Collins Street",
                "countryCode": "AU",
                "postcode": "3000",
                "state": "VIC",
                "suburb": "Melbourne"
            },
            "attachments": {
                "identityFiles": [
                {
                    "description": "string",
                    "fileId": "string",
                    "tag": "DRIVERS_LICENSE_FRONT"
                }
                ]
            },
            "dateOfBirth": "1980-10-10",
            "firstName": "Alice",
            "firstNameEnglish": "Alice",
            "identificationNumber": "RRHK784512",
            "identificationType": "personalId",
            "lastName": "Smith",
            "lastNameEnglish": "Smith",
            "nationality": "HK"
            }
        ],
        "industryCategory": "Financial Services and Products",
        "industryCategoryLevel3": "Mortgage broker and dealers",
        "industrySubCategory": "Lending",
        "operatingCountry": [
            "US",
            "AU"
        ],
        "url": "http://www.your_company.com"
        },
        "individualDetails": [
        {
            "address": {
            "addressLine1": "200 Collins Street",
            "addressLine2": "200 Collins Street",
            "countryCode": "AU",
            "postcode": "3000",
            "state": "VIC",
            "suburb": "Melbourne"
            },
            "attachments": {
            "identityFiles": [
                {
                "description": "string",
                "fileId": "string",
                "tag": "DRIVERS_LICENSE_FRONT"
                }
            ]
            },
            "dateOfBirth": "1980-10-10",
            "firstName": "John",
            "firstNameEnglish": "Alice",
            "identificationNumber": "AAA5417287BB",
            "identificationType": "personalId",
            "lastName": "Smith",
            "lastNameEnglish": "Smith",
            "nationality": "CN"
        }
        ],
        "legalEntityType": "INDIVIDUAL"
    }
    },
    "accountUsage": {
    "cardUsage": [
        "string"
    ],
    "collectionCountryCodes": [
        "US",
        "AU"
    ],
    "collectionFrom": "Self top up, payment gateway, marketplaces, etc.",
    "expectedMonthlyTransactionVolume": {
        "amount": "50000"
    },
    "payoutCountryCodes": [
        "HK",
        "CN"
    ],
    "payoutTo": "Self top up, payment gateway, marketplaces, etc."
    },
    "createdAt": "string",
    "customerAgreements": {
    "agreedToDataUsage": true,
    "agreedToTermsAndConditions": true,
    "optInForMarketing": true
    },
    "id": "string",
    "identifier": "string",
    "metadata": {
    "{fieldPath}": {
    }
    },
    "nextAction": {
    "type": "string"
    },
    "primaryContact": {
    "email": "alice.smith@gmail.com",
    "mobile": "string"
    },
    "requirements": {
    "agreementToTermsAndConditionsRequired": {
        "endpoint": "string",
        "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.",
        "method": "POST"
    },
    "photoFileIdRequired": {
        "message": "Identity verification failed",
        "photoFileId": "Njg3MzkzNWMtMmNlNC00NDM3L="
    },
    "primaryIdentificationRequired": [
        {
        "backFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",
        "firstName": "Alice",
        "frontFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",
        "lastName": "Smith",
        "message": "Identity verification failed",
        "middleName": "Benedict"
        }
    ],
    "secondaryIdentificationRequired": [
        {
        "backFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",
        "firstName": "Alice",
        "frontFileId": "Njg3MzkzNWMtMmNlNC00NDM3L=",
        "lastName": "Smith",
        "message": "Identity verification failed",
        "middleName": "Benedict"
        }
    ]
    },
    "status": "ACTIVE"
}
```

account.active, account.suspended

Relevant webhook events: 
- account.connected

```json 
{
    "accountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",
    "data":{
      "connectedAccountId":"acct_c9njGfy5PQOwfLeKGWox0A",
      "connectedAccountIdentifier":"12345",
      "connectedAccountName":"Ludwig Zamenhof",
      "createdAt":"2019-06-19T06:14:58+0000",
      "connectedAccountStatus":"ACTIVE",
      "platformAccountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",
      "platformName":"Wishcom Shanghai"
    },
    "id":"45a6d9c3-bdcd-3bbf-b592-10f287a87ccd",
    "name":"account.connected"
}
```

account.connected

Relevant webhook events:
- account.action_required

```json
{
    "accountId":"acct_IDSCMmzqMCeKRFcgwbtAdQ",
    "data":{
      "agreedToTermsAndConditionsRequired": {
        "endpoint": "app/v1/accounts/acct_GyxgVwu_NhGTWOgXZHwLBg/terms_and_conditions/agree",
        "method": "POST",
        "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint"
      }
    },
    "id":"45a6d9c3-bdcd-3bbf-b592-10f287a87ccd",
    "name":"account.action_required"
}
```


account.action_required

Relevant webhook events: 
- account.submitted

```json
{
  "id": "evt_h-qg-qLaNaGiqFHSlD8lHg",
  "name": "account.submitted",
  "account_id": "acct_tl429bI0MCelEyQfAMtnGw",
  "data": {},
  "created_at": "2023-07-13T10:51:25+0000"
}
```

account.submitted

docsLogo

Desktop/Mobile Website Browser 

GoPay

Pay with QR Code (Desktop Website Browser) - DANA

Mobile Website Browser - DANA

Mobile App - DANA

DANA

Enhance fraud protection with comprehensive payment data

Risk management

Guest user checkout

Registered user checkout

Place a hold on a payment method

Cancellations

Refunds

3D Secure authentication

Network Tokenization

Card Account Updater

Device fingerprinting

Multi-currency pricing

Error response codes

Native API

Batch transfer webhooks (older versions)

Error codes (older versions)

Batch transfers

Payment Methods Overview

Payment methods overview

Connected Account Console overview

Connected Account Console

 Desktop/Mobile Website Browser

 Save bank details for future payments

 Micro-deposit verification

 EFT Pre-Authorized Debit

Desktop/Mobile Website Browser

Save bank details for future payments

Micro-deposit verification

Bacs Direct Debit

Desktop / Mobile Website Browser

SEPA Direct Debit

ACH Direct Debit

Airwallex.js

Mobile SDKs

Server-side SDKs (Beta)

Enable Native Credit/Debit Cards

Enable Apple Pay (Express Checkout)

Enable Google Pay (Express Checkout)

Enable cards and local payment methods (Redirect)

Enable and Configure Payment Methods

Retrieve supported beneficiary banks

Error codes

7-Eleven

Alipay CN

Alipay HK

Atome

Boost

DOKU Wallet

Dragonpay

DuitNow

E.SUN (Taiwan ATM & Internet banking)

GCash

GrabPay - Malaysia

GrabPay - Singapore

Indonesian Bank Transfer

Indonesian Convenience Stores - BETA

Jenius Pay

Kakao Pay

Kiosk Payments

Konbini

Korean Local Cards - BETA

Laybuy by Klarna

LinkAja

Naver Pay - BETA

Pay-easy

Payco - BETA

PayNow

Philippines Online Banking

PromptPay

Rabbit LINE Pay

Samsung Pay - BETA

ShopeePay

Taiwan Convenience Stores

Tesco Lotus

Thailand Online Banking

Toss Pay - BETA

Touch 'n Go

TrueMoney

WeChat Pay

Zip - BETA

APAC

View connected accounts

Handle RFIs

Getting Started

Install the Airwallex Apple Pay Payments App

Install the Airwallex Google Pay Payments App

Install Airwallex Card Payments app

Install Airwallex Online Payments App

Install Airwallex Klarna Payments App

Install Airwallex Afterpay Payments App

Shopline

Install the Magento plugin

View and Manage Transactions

Advanced Configuration

Magento

Integration guide

Accept bank transfer payments

Bank transfer - BETA

Upgrade from Payouts Web SDK

Upgrade from Payment Elements SDK

Upgrade to Airwallex.js

Customization options

Cash App Pay - BETA

 SPEI - BETA

Venmo - BETA

PIX - BETA

North America & LATAM

Cards

Airwallex Pay

Apple Pay

Google Pay™

Klarna

Afterpay / Clearpay

PayPal

Skrill

Global

Extra Merchant Data (EMD) - Klarna

Transaction limits

Blocked Transaction Usage Scopes

Authorization controls

Automatic Currency Conversion

Batch transfer error codes

Transfers

Provide Fraud Feedback

Install Airwallex Online Payments app

Enable MOTO Payments

Handle Overcaptures

Install Airwallex Sales Order App

Shopify

Dispute your direct debit payouts

Transaction Lifecycle

Issuing

Online payments overview

Hosted Payment Page

Payment Links overview

Embedded KYC RFI component

Hosted KYC RFI flow

Native KYC RFI API

Handle KYC RFI

Review direct debit mandate requirements

South Africa

United States

Failure reasons

Retrieve physical card delivery details

Integration checklist

Manage your direct debit payout mandates

Manage your direct debit payouts

Direct debit payout statuses

Authorize direct debit payouts

Retrieve your deposits

Supported regions and currencies

Overview

Accounts

Move funds between accounts

Embedded Transaction RFI component

Hosted Transaction RFI flow

Native Transaction RFI API

Handle Transaction RFI

Embedded Payment Enablement RFI component

Hosted Payment Enablement RFI flow

Native Payment Enablement RFI API

Handle Payment Enablement RFI

Embedded KYB component

Hosted Onboarding 

Payment Method Onboarding Requirement

KYB and onboarding

Individual KYC Requirements - AU

Individual KYC Requirements - HK

Individual KYC Requirements - SG

UK & EEA

Individual KYC Requirements - UK & EEA

Individual KYC Requirements

Australia (AU) 

Canada (CA)

China (CN)

Germany (DE)

Business KYC requirements

Account

.css-1xcsryl>.e1x8zjqq1{opacity:0;-webkit-transition:opacity 250ms ease-in-out;transition:opacity 250ms ease-in-out;}.css-1xcsryl:hover>.e1x8zjqq1{opacity:1;}account.active, account.suspended.css-158icaa{margin-left:4px;}

account.connected

account.action_required

account.submitted

account.active, account.suspended