Log inGet started
Airwallex logo
Online Payments
Transactional FX
Open Banking
Developer Tools
API Reference
IntroductionPayment Network
Getting Started
Create Payment
Get PaymentGet List of PaymentsPayout Guide

Create Payment

To create a new payment API, you need to provide payer, recipient and payment details. If your Airwallex account allows you to pay on behalf of another entity (POBO), you will need to specify payer details to create a new payment. By default, POBO is disabled for newly opened Airwallex Accounts and payer details do not need to be specified.

The parameters in the request will be different depending on payment method, payment currency etc.). We have created a dynamic schema that will return required fields based on these key criteria.

By default, the payer is responsible for the payment fee. This may be passed onto the recipient by setting fee_paid_by to RECIPIENT. The fee_paid_by flag affects the total amount the payer has to pay, and the amount the recipient receives. The fee component is calculated by the system and is communicated back via fee_currency and fee_amount in the API response. The actual amounts the parties pay and receive are represented by amount_payer_pays and amount_beneficiary_receives respectively.

If the payment_currency and the source_currency are different, an underlying currency conversion in the payment request will be triggered. Currency conversion will be booked at the prevailing rate based on market conditions or based on the lock rate (please refer to Transactional FX for more details).

Sample Code

curl --request POST \
--url 'https://api-demo.airwallex.com/api/v1/payments/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0b20iLCJyb2xlcyI6WyJ1c2VyIl0sImlhdCI6MTQ4ODQxNTI1NywiZXhwIjoxNDg4NDE1MjY3fQ.UHqau03y5kEk5lFbTp7J4a-U6LXsfxIVNEsux85hj-Q' \
--header 'headers: [object Object]' \
--data '{ \
  "beneficiary": { \
    "additional_info": { \
      "personal_email": "john.walker@gmail.com" \
    }, \
    "address": { \
      "city": "Seattle", \
      "country_code": "US", \
      "postcode": "98104", \
      "state": "Washington", \
      "street_address": "412 5th Avenue" \
    }, \
    "bank_details": { \
      "account_currency": "USD", \
      "account_name": "John Walker", \
      "account_number": "50001121", \
      "account_routing_type1": "aba", \
      "account_routing_value1": "021000021", \
      "bank_country_code": "US", \
      "bank_name": "JP Morgan Chase Bank" \
    }, \
    "company_name": "ABC University", \
    "entity_type": "COMPANY" \
  }, \
  "payer": { \
    "additional_info": { \
      "business_registration_number": "EU300503", \
      "personal_email": "james.smith@google.com" \
    }, \
    "address": { \
      "city": "Melbourne", \
      "country_code": "CN", \
      "postcode": "3000", \
      "state": "VIC", \
      "street_address": "15 William Street" \
    }, \
    "company_name": "Complete Concrete Pty Ltd", \
    "entity_type": "COMPANY" \
  }, \
  "payment_amount": "10000", \
  "payment_currency": "USD", \
  "payment_method": "LOCAL", \
  "quote_id": "string", \
  "reason": "travel", \
  "reference": "PMT1936398", \
  "request_id": "08d669e5-b43c-4a93-a5bb-3ca4ebb82ffa", \
  "source_currency": "CNY" \