Collect payments directly

Collect payments on behalf of connected accounts

Process payments and manage funds

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

With this model, payments belong to the platform account solely. The platform account is responsible for Payments fees, refunds, and chargebacks. The fund will be split from the platform account to one or many connected accounts. It is recommended for the case where the platform directly interacts with end customers and manages daily transactions. Typical cases include marketplaces or on-demand service platforms.

You can specify which connected account to be associated with a given transaction by using the `connected_account_id` attribute. The below chart illustrates the process of a standard one-off 100 GBP payment in this model.

![collect payments directly](//images.ctfassets.net/c3n7jozh84hr/5ugrVhXesVeLm9hCGolnlO/d22f64914b313d3fddfb6cac98dce4c0/collect_payments_directly.png)

In the case of Hosted Payment Page/Embedded Fields/Drop-in/Mobile Integration, platform can bypass step 2&3 but needs to create the `FundsSplit` request after receiving notifications that the payment is successfully captured.

Note:

1. Platform creates `payment_intent` with 100 GBP with connected account id

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", 
  "amount": 100,
  "currency": "GBP",
  "merchant_order_id": "cc9bfc13-ba30-483b-a62c-ee925fc9bfea",
  "connected_account_id": "acct_ad1KMcnQM2Wmo2PFSuvR2g"
}'
```

2. Platform confirms `payment_intent` with normal request body

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/int_e65tkXCSzJrsMpTrzoFrjaa u53/confirm’ \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "payment_method": {
    "card": {
      "expiry_month": "12",
      "expiry_year": "2030",
      "number": "4111111111111111"
    },
  }
}'
```

3. Platform captures `payment_intent` with 100 GBP with normal request body

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/int_e65tkXCSzJrsMpTrzoFrjaa u53/capture’ \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "amount": 100 
}'
```

4. Platform creates `FundsSplit` with 90 GBP where the `source_id` equals to `payment_intent_id`, the `destination` equals to connected account_id

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/funds_splits/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "source_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",
  "source_type":"PAYMENT_INTENT",
  "amount": 90, 
  "destination":"acct_ad1KMcnQM2Wmo2PFSuvR2g",
  "metadata": { 
      "reason": "disbursement to seller A"
  }
}'
```

In the case where funds need to be split into multiple connected accounts, the platform needs to create multiple `FundsSplit` to each connected account as a destination.

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/funds_splits/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "source_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",
  "source_type":"PAYMENT_INTENT",
  "amount": 40, 
  "destination":"acct_ij2YyjhFNv-BGPsjqHuI3w",
  "metadata": { 
      "reason": "disbursement to seller A"
  }
}'
```

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/funds_splits/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "source_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",
  "source_type":"PAYMENT_INTENT",
  "amount": 35, 
  "destination":"acct_aD5rChdqMoCkSn3WseuKLw",
  "metadata": { 
      "reason": "disbursement to seller B"
  }
}'
```

5. Funds will be settled to all parties’ wallets based on split portion, where platform receives 5 GBP (5 GBP Airwallex fees being netted) and connected account receives 90 GBP as disbursement

If you want to create recurring payments in this model you also need to create a `PaymentConsent` with connected account id.

&nbsp;

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_consents/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -d'{
  "customer_id": "cus_aag4MsYdcgHc9UTjVUS15WPvmoX",
  "request_id": "88bf9327-0c10-4e87-b050-7c74ef11e1c6",
  "next_triggered_by": "merchant",
  "connected_account_id": "acct_ad1KMcnQM2Wmo2PFSuvR2g"
  "payment_method": {
    "id": "mtd_0eUIICYocwY8prvHWgWoODiGxPP",
    "type": "card"
   },
  "requires_cvc": false
}'
```

With this model, payments belong to your connected account instead of you as the platform. The connected account is responsible for Payments fees, refunds, and chargebacks. The fund will be split from a connected account to a platform account. It is recommended for the case where the connected account directly interacts with end customers and manages daily transactions, while the platform has limited engagement in every transaction. Typical case includes SaaS platforms.

In this model, the platform will submit all the payments on behalf of the connected account to Airwallex. In order to indicate this relation, you need to specify the account ID of the connected account with the `x-on-behalf-of` header.

The below chart illustrates the process of a standard one-off 100 GBP payment in this model.
![on behalf of connected accounts](//images.ctfassets.net/c3n7jozh84hr/3tzM0k01tIJxVTLHo4MwFI/3b60534450f0617ee45c101ade658677/collect_payments_on_behalf_of_connected_accounts_.png)

1. Platform creates `payment_intent` with 100 GBP on behalf of connected account with id `"acct_ad1KMcnQM2Wmo2PFSuvR2g"`

``` curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "merchant_order_id": "cc9bfc13-ba30-483b-a62c-ee925fc9bfea",
  "amount": 100,
  "currency": "GBP"
}'
```

2. Platform confirms `payment_intent` on behalf of connected account

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/int_e65tkXCSzJrsMpTrzoFrjaa u53/confirm' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "payment_method": {
    "card": {
      "expiry_month": "12",
      "expiry_year": "2030",
      "number": "4111111111111111"
    }
  }
}'
```

3. Platform captures `payment_intent` with 100 GBP on behalf of connected account (you can also skip this process by choosing auto capture)

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_intents/int_e65tkXCSzJrsMpTrzoFrjaa u53/capture’ \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "amount": 100
}'
```

4. Platform creates `FundsSplit` with 10 GBP on behalf of connected account, where the `source_id` equals to `payment_intent_id`, and `destination` equals to platform account’s own `account_id`. Platform can use `metadata` to record values that help better recognition of each split

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/funds_splits/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "request_id": "ee939540-3203-4a2c-9172-89a566485dd9",
  "source_id": "int_e65tkXCSzJrsMpTrzoFrjaau53",
  "source_type":"PAYMENT_INTENT",
  "amount": 10, 
  "destination":"acct_ITNg64dHNgihu9rPpWeiMg",
  "metadata": { 
      "reason": "commission agreed with seller A"
  }
}'
```

5. Funds will be settled to both parties’ wallets based on split portion, where platform receives 10 GBP as commission and connected account receives 85 GBP (5 GBP Airwallex fees being netted)

If you want to create recurring payments in this model you also need to create and verify a `PaymentConsent` on behalf of connected account.

&nbsp
```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_consents/create' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "customer_id": "cus_aag4MsYdcgHc9UTjVUS15WPvmoX",
  "request_id": "88bf9327-0c10-4e87-b050-7c74ef11e1c6",
  "next_triggered_by": "merchant",
  "payment_method": {
    "id": "mtd_0eUIICYocwY8prvHWgWoODiGxPP",
    "type": "card"
  },
  "requires_cvc": false
}'
```

```curl
$ curl --request POST \
> 'https://pci-api-demo.airwallex.com/api/v1/pa/payment_consents/cst_u79lnfufjxxfdc0/verify' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNT I1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
> -H 'x-on-behalf-of: acct_ad1KMcnQM2Wmo2PFSuvR2g \
> -d'{
  "request_id": "88bf9327-0c10-4e87-b050-7c74ef11e1c6",
  "verification_options": {
    "card": { \
      "amount": 0,
      "currency": "GBP",
      "cvc": "string"
    } 
  }
}'
```

When using Airwallex payment gateway, the platform will need to provide in addition to the regular payment details (included in the PaymentIntent and PaymentAttempts) several indicators that allow identifying on behalf of who or to whom a transaction belongs.

In most situations, you will require to split funds from transactions between connected accounts and yourself. Our solution FundsSplit enables you to disburse funds to the appropriate party as needed. FundsSplit represents a bilateral agreement that part of the collected funds (i.e. PaymentIntent) will be divided between multiple destinations (yourself and the other accounts) before settling to the account that owns the original payment. You may create and add multiple FundsSplit to a PaymentIntent.

See step-by-step integration guide for your chosen payment gateway model.

- [Collect payments directly](/payments-for-platforms__process-payments-and-manage-funds__collect-payments-directly)
- [Collect payments on behalf of connected accounts](/payments-for-platforms__process-payments-and-manage-funds__collect-payments-on-behalf-of-connected-accounts)


You can enjoy the flexibility to determine whose information will be displayed to consumers based on your business nature. This includes merchant descriptor name and merchant address on consumers’ account statements. It can help consumers better recognize the payment thereby reducing potential chargeback or fraud claims. Please reach out to our support team for more information on how to achieve this.