Online Payments

A quick introduction to building with Airwallex APIs

Quickstart

Explore our comprehensive reference to integrate with Airwallex API endpoints

API Reference

Learn how to receive push notifications via webhooks

Webhooks

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"payment_intent.created"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve a Payment Intent](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Intents/_api_v1_pa_payment_intents__id_/get)
```json
{
    "request_id": "d6a92e2a-02e5-c37b-c977-13796ec7443a",
    "id": "int_aaaat9w2hgh8mzi1111",
    "merchant_order_id": "0000000000",
    "amount": 16.66,
    "currency": "USD",
    "base_amount": 16.66,
    "captured_amount": 0,
    "payment_method_options": {
        "card": {
            "risk_control": {
                "three_domain_secure_action": "FORCE_3DS",
                "three_ds_action": "FORCE_3DS"
            },
            "three_ds_action": "FORCE_3DS"
        }
    },
    "status": "REQUIRES_PAYMENT_METHOD",
    "created_at": "2023-01-13T07:32:05+0000",
    "updated_at": "2023-01-13T07:32:05+0000"
}
```

payment_intent.*

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"payment_attempt.received"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve a Payment Attempt](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Attempts/_api_v1_pa_payment_attempts__id_/get)
```json
{
    "id": "att_hkpdcpcvbgh8mw11111_wkgwfs",
    "payment_intent_id": "int_hkpdcpcvbgh8mwk1111",
    "payment_consent_id": "cst_hkpdnqn5bgh8mw1111",
    "currency": "KRW",
    "amount": 62723,
    "payment_method": {
        "id": "mtd_hkpdcpcvbgh8m111111",
        "customer_id": "cus_hkpdk7f98gh8ir1111",
        "type": "card",
        "card": {
            "bin": "53651045",
            "brand": "mastercard",
            "card_type": "DEBIT",
            "expiry_month": "09",
            "expiry_year": "2027",
            "fingerprint": "111e4Y759jpc5eC3AAAAaaaa/8=",
            "is_commercial": false,
            "issuer_country_code": "KR",
            "issuer_name": "KB KOOKMIN CARD CO., LTD",
            "last4": "1111",
            "name": "",
            "number_type": "PAN"
        },
        "status": "CREATED",
        "created_at": "2023-01-13T07:29:08+0000",
        "updated_at": "2023-01-13T07:29:08+0000"
    },
    "authentication_data": {
        "avs_result": "U",
        "cvc_result": "U",
        "ds_data": {},
        "fraud_data": {
            "score": "0"
        }
    },
    "captured_amount": 0,
    "refunded_amount": 0,
    "settle_via": "airwallex",
    "status": "RECEIVED",
    "created_at": "2023-01-13T07:29:08+0000",
    "updated_at": "2023-01-13T07:29:08+0000"
}
```

payment_attempt.*

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"payment_consent.verified"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```
__object__ is the response from [Retrive a Payment Consent](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Consents/_api_v1_pa_payment_consents__id_/get):
```json
{
    "id": "cst_hkdm2frl4gh6j8v59mf",
    "request_id": "b1717535-620c-4585-839b-cf4225ff8f5e",
    "customer_id": "cus_hkdmlrgw4gh5g65yhel",
    "merchant_trigger_reason": "unscheduled",
    "next_triggered_by": "merchant",
    "payment_method": {
        "id": "mtd_hkdm2frl4gh6j8uzuel",
        "card": {
            "bin": "41111111",
            "brand": "visa",
            "card_type": "DEBIT",
            "expiry_month": "12",
            "expiry_year": "2034",
            "fingerprint": "55H7FnahCHdynKufFW1CBvlSzqE=",
            "is_commercial": false,
            "issuer_country_code": "US",
            "issuer_name": "JPMORGAN CHASE BANK, N.A.",
            "last4": "1111",
            "name": "321",
            "number_type": "PAN"
        },
        "type": "card"
    },
    "status": "VERIFIED",
    "created_at": "2023-01-11T09:44:15+0000",
    "updated_at": "2023-01-11T09:44:15+0000"
}
```

payment_consent.*

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"payment_method.created"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```
__object__ is the response body from [Retrieve a Payment Method](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Methods/_api_v1_pa_payment_methods__id_/get):
```json
{
    "id": "mtd_hkdm2frl4gh6j8uzuel",
    "request_id": "d7044249-13b2-4b7f-842f-e5398bc4b9f0",
    "customer_id": "cus_hkdmlrgw4gh5g65yhel",
    "type": "card",
    "card": {
        "bin": "41111111",
        "brand": "visa",
        "card_type": "DEBIT",
        "expiry_month": "12",
        "expiry_year": "2034",
        "fingerprint": "55H7FnahCHdynKufFW1CBvlSzqE=",
        "is_commercial": false,
        "issuer_country_code": "US",
        "issuer_name": "JPMORGAN CHASE BANK, N.A.",
        "last4": "1111",
        "name": "321",
        "number_type": "PAN"
    },
    "status": "CREATED",
    "created_at": "2023-01-11T09:44:14+0000",
    "updated_at": "2023-01-11T09:44:14+0000"
}
```

payment_method.*

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"customer.created"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```
__object__ is the response body from [Retrieve a Customer](https://www.airwallex.com/docs/api#/Payment_Acceptance/Customers/_api_v1_pa_customers__id_/get):
```json
{
    "id": "cus_hkdmlrgw4gh5g65yhel",
    "email": "",
    "first_name": "John",
    "last_name": "Doe",
    "merchant_customer_id": "685e74bd-e6b3-4c41-90cc-baacb1fdd8ca",
    "phone_number": "32132112",
    "request_id": "90d0b992-fc8a-49be-98fb-623a885ca2a7",
    "updated_at": "2023-01-10T10:06:37+0000",
    "additional_info": {
        "registered_via_social_media": false
    },
    "created_at": "2023-01-10T10:06:37+0000",
}
```

customer.*

```json
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"refund.accepted"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```
__object__ is the response body from [Retrieve a Refund](https://www.airwallex.com/docs/api#/Payment_Acceptance/Refunds/_api_v1_pa_refunds__id_/get):
```json
{
    "request_id": "GN230113463059337228",
    "id": "rfd_aaaanqn5bgh8mnssssh_ga04nr",
    "payment_attempt_id": "att_hkpdxmj6wggosgaaniy_ga04nr",
    "payment_intent_id": "int_hkpdxmj6wggosga04nr",
    "amount": 21.49,
    "currency": "SGD",
    "reason": "Return good",
    "status": "ACCEPTED",
    "created_at": "2023-01-13T07:20:02+0000",
    "updated_at": "2023-01-13T07:20:02+0000"
}
```

refund.*

```javascript
{
    "id":"evt_100_2019102201549020043_8321220011893766",
    "name":"dispute.accepted"
    "accountId":"78814faa-1b30-4598-a9c8-f0583db8d09d",
    "data":{
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve a Payment Dispute](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Disputes/_api_v1_pa_payment_disputes__id_/get)

```javascript
 {
   "dispute_id": "dst_ch4cfk4lsdEmmgNc3gzyXz7g27n",
   "payment_intent_id": "int_hkpd9mrvng04lcuh2xu",
   "payment_attempt_id": "att_hkpd6tx6tg04lcv60dt_cuh2xu",
   "merchant_account": "7e481c53-c0bc-484b-9b74-62e715c32f0e",
   "card_scheme": "visa",
   "dispute_reason_type": "FRAUDULENT",
   "dispute_original_reason_code": "10.4",
   "accept_reason": null,
   "status": "EVIDENCE_REQUIRED",
   "stage": "DISPUTE", // RFI/DISPUTE/ARBITRATION
   "dispute_amount": 10.10,
   "dispute_currency": "USD",
   "updated_by": "AIRWALLEX",
   "updated_at": "2021-03-03T08:17:27.659+0000",
   "created_at": "2021-03-03T08:17:27.659+0000"

}
```

dispute.*

```json
{
  "account_id": "acct__ncI2nypPKSq2VXKxscAcg",
  "created_at": "2023-06-01T11:00:01+0000",
  "data": {
        "object": {...}
    }
}
```

__object__ is the response body from [Retrieve a Payment Link](https://www.airwallex.com/docs/api#/Payment_Acceptance/Payment_Links/_api_v1_pa_payment_links__id_/get)

```json
{
      "active": true,
      "amount": 165.15,
      "collectable_shopper_info": {
        "message": true,
        "phone_number": false,
        "reference": false,
        "shipping_address": false
      },
      "created_at": "2023-06-01T11:00:00+0000",
      "currency": "USD",
      "customer_id": "cus_hkdmmvww8gaclhotx3j",
      "description": "shoes and dress",
      "expires_at": "2023-11-04T16:00:00+0000",
      "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d",
      "metadata": {
        "foo": "bar"
      },
      "reference": "internal merchant reference",
      "reusable": true,
      "status": "UNPAID",
      "successful_payment_intent_count": 0,
      "supported_currencies": [],
      "title": "Order #1529",
      "updated_at": "2023-06-01T11:00:00+0000",
      "url": "https://www.airwallex.com/pay/hk/link/acdab0d955b5"
    }
  },
  "id": "bb443cdb-a1fb-4700-8f29-af41e3e4728b",
  "name": "payment_link.created",
  "version": "2022-11-11"
}
```

payment_link.*

docsLogo

Desktop/Mobile Website Browser

Paysafecash

Store Detail Requirement 

Payment Method List

Native API

Configure remote authorization

iOS SDK

Android SDK

Registered user checkout

Install the Airwallex Google Pay Payments App

Getting Started

Install Airwallex Card Payments app

Install Airwallex Online Payments App

Install Airwallex Klarna Payments App

Install Airwallex Afterpay Payments App

Install the Airwallex Apple Pay Payments App

Shopline

Supported currencies

 Micro-deposit verification

Transfer webhooks (older versions)

Desktop/Mobile Website Browser - Afterpay / Clearpay

Afterpay / Clearpay

Pakistan

Bangladesh

Indonesia

Market & infrastructure coverage

Settlement report

Transaction & fee types

Payment activity export

Payments rounding logic

Reporting

Enable Native Credit/Debit Cards

Hungary

Zambia

Wallis and Futuna

Virgin Islands (British)

Viet Nam

Vanuatu

Uzbekistan

Uruguay

United States

United Kingdom

United Arab Emirates

Ukraine

Uganda

Turkey

Tunisia

Togo

Timor-Leste

Thailand

Tanzania, United Republic of

Tajikistan

Taiwan (China)

Switzerland

Sweden

Sri Lanka

Spain

South Africa

Slovenia

Slovakia

Singapore

Seychelles

Serbia

Senegal

Saudi Arabia

San Marino

Saint Pierre and Miquelon

Saint Martin (French part)

Saint Lucia

Saint Barthélemy

Rwanda

Romania

Réunion

Republic of the Congo

Qatar

Puerto Rico

Portugal

Poland

Philippines

Peru

Paraguay

Panama

Palestine, State of

Oman

Norway

Nigeria

Niger

New Zealand

New Caledonia

Netherlands

Nepal

Namibia

Morocco

Montenegro

Albania

Algeria

Andorra

Angola

Anguilla

Antigua and Barbuda

Argentina

Armenia

Aruba

Australia

Austria

Azerbaijan

Bahrain

Belgium

Belize

Benin

Bolivia

Bosnia and Herzegovina

Botswana

Brazil

Bulgaria

Burkina Faso

Cambodia

Cameroon

Canada

Canary Islands

Central African Republic

Chad

Chile

China

Colombia

Costa Rica

Côte d'Ivoire

Croatia

Curaçao

Cyprus

Czech Republic

Denmark

Dominican Republic

Dominica

Ecuador

Egypt

El Salvador

Equatorial Guinea

Estonia

Faroe Islands

Fiji

Finland

France

French Guiana

French Polynesia

French Southern Territories

Gabon

Gambia

Georgia

Germany

Gibraltar

Greece

Greenland

Grenada

Guatemala

Guernsey

Guinea-Bissau

Guyana

Honduras

Hong Kong SAR

Iceland

India

Ireland

Isle of Man

Israel

Italy

Jamaica

Japan

Jersey

Jordan

Kazakhstan

Kenya

Korea, Republic of

Kosovo

Kuwait

Kyrgyzstan

Payout network