Payments
A payment resource is created when you send funds to a beneficiary, it details the beneficiary, bank details, the amount being paid, its status and other relevant information. You can also create the payment by using the beneficiary unique identifier which was previously created using Beneficiary resource.
GET /api/v1/paymentsGET /api/v1/payments/{payment_id}POST /api/v1/payments/cancel/{payment_id}POST /api/v1/payments/createPOST /api/v1/payments/retry/{payment_id}POST /api/v1/payments/validate
Get list of payments
GET /api/v1/payments
Get list of payments from a specified creation date/time, with optional filters on end creation date/time, buy/sell currency and status. Alternatively, one or neither of the from or to created_at request fields needs to be populated. In the event that neither or only the to created_at fields are populated, then payments 30 days in arrears of today or the to created_at date will be returned.
The start date of created_at in ISO8601 format (inclusive)
Page number, starts from 0.
Number of results per page, defaultValue 2000
Payment currency
Payment request_id
Payment short_reference_id
Status of the payment
The end date of created_at in ISO8601 format (inclusive)
A flag which identifies whether there are more results.
Paged results.
The total amount (in payment payment_currency) the beneficiary receives for this payment, and is governed by value specified in fee_paid_by, i.e. if fee_paid_by is PAYER, then the beneficiary receives the exact same payment_amount since payer is responsible for the payment fee. Otherwise, beneficiary receives payment_amount - fee as the fee is implicitly passed onto the beneficiary
The total amount (in source_currency) the payer has to pay for making this payment. For example, if fee_paid_by is PAYER and FX conversion is not involved, then this is the sum of payment_amount + fee as the payer is responsible for the fee. Otherwise this field is the same as payment_amount
Details of the beneficiary
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
The time this payment request was created
The payment fee (in source_currency) for sending this payment
The payment fee currency. This should always equal to the source_currency
Denotes whether PAYER / BENEFICIARY will be liable for the the payment fee. Defaults to PAYER unless field is populated in the request
The time this payment request was last updated
Details of the payer
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
Amount to be paid
Currency the payment should be made in (3-letter ISO-4217 code)
Date when payment should be made (Copied from the request if specified)
Returned payment_id that can be used to query the status of the payment
Copied from the request if specified. Otherwise the system will populate this field automatically
Reason for the payment instruction
Bank payment reference to be shown on beneficiary's bank transaction history
A unique request identifier specified in the payment request
Short payment reference for support purposes
Amount to be received
Copied from the request if specified
The payment status, can be one of: NEW, IN_APPROVAL, REJECTED, RECALLED, BLOCKED, PENDING_FUNDS,CANCELLED, IN_REVIEW, READY_FOR_DISPATCH, SUSPENDED, DISPATCHED, FAILED, CANCELLATION_REQUESTED, RETRIED
beneficiary_id of the beneficiary contact used to create this payment
Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the payment date.
Empty unless the payment is in an error state
Empty unless the payment is in an error state
A set of key-value pairs for storing your own data together with the payment.
payer_id of the payer contact used to create this payment
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
Underlying conversion_id (if source_currency is different from payment_currency)
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/payments' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "amount_beneficiary_receives": 99996,6 "amount_payer_pays": 10004,7 "beneficiary": {8 "additional_info": {9 "business_area": "Travel",10 "business_phone_number": "689342234",11 "business_registration_number": "IT593003",12 "legal_rep_bank_account_number": "44250100003700000000",13 "legal_rep_first_name_in_chinese": "小芳",14 "legal_rep_id_number": "110108199304203520",15 "legal_rep_last_name_in_chinese": "刘",16 "legal_rep_mobile_number": "13651362890",17 "personal_email": "[email protected]",18 "personal_first_name_in_chinese": "大明",19 "personal_id_number": "1234567890",20 "personal_id_type": "NATIONAL_ID",21 "personal_last_name_in_chinese": "李",22 "personal_mobile_number": "13651362890",23 "security_question": "What is the name of my second puppy?",24 "security_question_answer": "Scooby Doo"25 },26 "address": {27 "city": "Melbourne",28 "country_code": "AU",29 "postcode": "3000",30 "state": "VIC",31 "street_address": "15 William Street"32 },33 "bank_details": {34 "account_currency": "AUD",35 "account_name": "Lee Da Ming",36 "account_name_alias": "Lee D M",37 "account_number": "12750852",38 "account_routing_type1": "bsb",39 "account_routing_type2": "sort_code",40 "account_routing_value1": "083064",41 "account_routing_value2": "123456",42 "bank_account_category": "Checking,Savings,Vista,Maestra",43 "bank_branch": "Melbourne",44 "bank_country_code": "AU",45 "bank_name": "National Australia Bank",46 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",47 "binding_mobile_number": "654897612345",48 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",49 "iban": "ES8023100001180000012345",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S",52 "transaction_reference": "4140110135",53 "intermediary_bank_swift_code": "CTBAAU2S",54 "intermediary_bank_name": "National Australia Bank"55 },56 "company_name": "Complete Concrete Pty Ltd",57 "date_of_birth": "1976-08-26",58 "entity_type": "COMPANY",59 "first_name": "John",60 "last_name": "Walker"61 },62 "created_at": "2017-03-22T16:08:02+1100",63 "dispatch_date": "2017-03-29",64 "failure_reason": "Insufficient funds",65 "failure_type": "UNKNOWN",66 "fee_amount": 4,67 "fee_currency": "AUD",68 "fee_paid_by": "PAYER",69 "last_updated_at": "2017-03-24T18:00:02+1100",70 "metadata": {71 "order_id": "0123456789"72 },73 "payer": {74 "additional_info": {75 "business_registration_number": "EU300503",76 "business_registration_type": "Partnership",77 "external_id": "1234567890",78 "personal_email": "[email protected]",79 "personal_id_number": "1234567890"80 },81 "address": {82 "city": "Melbourne",83 "country_code": "AU",84 "postcode": "3000",85 "state": "VIC",86 "street_address": "15 William Street"87 },88 "company_name": "Complete Concrete Pty Ltd",89 "date_of_birth": "1976-08-26",90 "entity_type": "COMPANY",91 "first_name": "James",92 "last_name": "Smith"93 },94 "payment_amount": 10000,95 "payment_currency": "AUD",96 "payment_date": "2017-03-24",97 "payment_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede",98 "payment_method": "SWIFT",99 "reason": "travel",100 "reference": "PMT1936398",101 "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",102 "short_reference_id": "20170322-9F6ML2",103 "source_amount": 10000,104 "source_currency": "AUD",105 "status": "DISPATCHED",106 "swift_charge_option": "SHARED",107 "underlying_conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede"108 }109 ]110}
Get payment by ID
GET /api/v1/payments/{payment_id}
Get a specific payment by specifying the Airwallex payment_id.
Unique identifier of the payment to retrieve
The total amount (in payment payment_currency) the beneficiary receives for this payment, and is governed by value specified in fee_paid_by, i.e. if fee_paid_by is PAYER, then the beneficiary receives the exact same payment_amount since payer is responsible for the payment fee. Otherwise, beneficiary receives payment_amount - fee as the fee is implicitly passed onto the beneficiary
The total amount (in source_currency) the payer has to pay for making this payment. For example, if fee_paid_by is PAYER and FX conversion is not involved, then this is the sum of payment_amount + fee as the payer is responsible for the fee. Otherwise this field is the same as payment_amount
Details of the beneficiary
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
beneficiary_id of the beneficiary contact used to create this payment
The time this payment request was created
Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the payment date.
Empty unless the payment is in an error state
Empty unless the payment is in an error state
The payment fee (in source_currency) for sending this payment
The payment fee currency. This should always equal to the source_currency
Denotes whether PAYER / BENEFICIARY will be liable for the the payment fee. Defaults to PAYER unless field is populated in the request
The time this payment request was last updated
A set of key-value pairs for storing your own data together with the payment.
Details of the payer
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
payer_id of the payer contact used to create this payment
Amount to be paid
Currency the payment should be made in (3-letter ISO-4217 code)
Date when payment should be made (Copied from the request if specified)
Returned payment_id that can be used to query the status of the payment
Copied from the request if specified. Otherwise the system will populate this field automatically
Reason for the payment instruction
Bank payment reference to be shown on beneficiary's bank transaction history
A unique request identifier specified in the payment request
Short payment reference for support purposes
Amount to be received
Copied from the request if specified
The payment status, can be one of: NEW, IN_APPROVAL, REJECTED, RECALLED, BLOCKED, PENDING_FUNDS,CANCELLED, IN_REVIEW, READY_FOR_DISPATCH, SUSPENDED, DISPATCHED, FAILED, CANCELLATION_REQUESTED, RETRIED
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
Underlying conversion_id (if source_currency is different from payment_currency)
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/payments/payment_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "amount_beneficiary_receives": 99996,3 "amount_payer_pays": 10004,4 "beneficiary": {5 "additional_info": {6 "business_area": "Travel",7 "business_phone_number": "689342234",8 "business_registration_number": "IT593003",9 "external_identifier": "<string>",10 "legal_rep_bank_account_number": "44250100003700000000",11 "legal_rep_first_name_in_chinese": "小芳",12 "legal_rep_id_number": "110108199304203520",13 "legal_rep_last_name_in_chinese": "刘",14 "legal_rep_mobile_number": "13651362890",15 "personal_email": "[email protected]",16 "personal_first_name_in_chinese": "大明",17 "personal_id_number": "1234567890",18 "personal_id_type": "NATIONAL_ID",19 "personal_last_name_in_chinese": "李",20 "personal_mobile_number": "13651362890",21 "recipient_account_id": "<string>",22 "security_question": "What is the name of my second puppy?",23 "security_question_answer": "Scooby Doo"24 },25 "address": {26 "city": "Melbourne",27 "country_code": "AU",28 "postcode": "3000",29 "state": "VIC",30 "street_address": "15 William Street"31 },32 "bank_details": {33 "account_currency": "AUD",34 "account_name": "Lee Da Ming",35 "account_name_alias": "Lee D M",36 "account_number": "12750852",37 "account_routing_type1": "bsb",38 "account_routing_type2": "sort_code",39 "account_routing_value1": "083064",40 "account_routing_value2": "123456",41 "bank_account_category": "Checking,Savings,Vista,Maestra",42 "bank_branch": "Melbourne",43 "bank_country_code": "AU",44 "bank_name": "National Australia Bank",45 "bank_state": "<string>",46 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",47 "binding_mobile_number": "654897612345",48 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",49 "iban": "ES8023100001180000012345",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S",52 "transaction_reference": "4140110135",53 "intermediary_bank_swift_code": "CTBAAU2S",54 "intermediary_bank_name": "National Australia Bank"55 },56 "company_name": "Complete Concrete Pty Ltd",57 "date_of_birth": "1976-08-26",58 "entity_type": "COMPANY",59 "first_name": "John",60 "last_name": "Walker"61 },62 "beneficiary_id": "<uuid>",63 "created_at": "2017-03-22T16:08:02+1100",64 "dispatch_date": "2017-03-29",65 "failure_reason": "Insufficient funds",66 "failure_type": "UNKNOWN",67 "fee_amount": 4,68 "fee_currency": "AUD",69 "fee_paid_by": "PAYER",70 "last_updated_at": "2017-03-24T18:00:02+1100",71 "metadata": {72 "order_id": "0123456789"73 },74 "payer": {75 "additional_info": {76 "business_registration_number": "EU300503",77 "business_registration_type": "Partnership",78 "external_id": "1234567890",79 "personal_email": "[email protected]",80 "personal_id_number": "1234567890"81 },82 "address": {83 "city": "Melbourne",84 "country_code": "AU",85 "postcode": "3000",86 "state": "VIC",87 "street_address": "15 William Street"88 },89 "company_name": "Complete Concrete Pty Ltd",90 "date_of_birth": "1976-08-26",91 "entity_type": "COMPANY",92 "first_name": "James",93 "last_name": "Smith"94 },95 "payer_id": "<uuid>",96 "payment_amount": 10000,97 "payment_currency": "AUD",98 "payment_date": "2017-03-24",99 "payment_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede",100 "payment_method": "SWIFT",101 "reason": "travel",102 "reference": "PMT1936398",103 "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",104 "short_reference_id": "20170322-9F6ML2",105 "source_amount": 10000,106 "source_currency": "AUD",107 "status": "DISPATCHED",108 "swift_charge_option": "SHARED",109 "underlying_conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede"110}
Cancel a payment
POST /api/v1/payments/cancel/{payment_id}
Cancel a payment by payment_id. Only a payment in a status of either NEW, PENDING_FUNDS or FAILED can be cancelled.
Unique identifier of the payment to cancel
OK
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/payments/cancel/payment_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
Create a new payment
POST /api/v1/payments/create
Create a new payment to a beneficiary. The payment can either include an underlying conversion when the payment currency varies from the source currency, or will not include a conversion when the payment currency and source currency match.
We have created a dynamic schema that will return required fields based on some key criteria that we need to determine the destination of the payment and the route it will take to reach that destination.
Payment Fee
By default, payer is responsible for the payment fee but may be passed onto the beneficiary by setting fee_paid_by to BENEFICIARY. The fee_paid_by flag affects the total amount the payer has to pay, and the amount the beneficiary 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 both parties pay and receive are represented by amount_payer_pays and amount_beneficiary_receives respectively.
Approvals
Creating a payment to be submitted for approval is available upon request. When a payment including a conversion is submitted for approval, values for amount_beneficiary_receives, amount_payer_pays, fee_amount, payment_amount and source_amount in the response are tentative based on the exchange rate at the time of creation until the payment status changes to PENDING_FUNDS, at which point the exchange rate is confirmed. When the payment status transitions to PENDING_FUNDS, if the payment_date is a past date, its value will get updated.
Payment currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)
Reason for the payment instruction
A user specified reference that will be displayed to the beneficiary on the payment transaction with their bank
A unique request ID specified by the client. Payout creation requests with a request_id that has been used in the past 7 days are treated as duplicated payout and cannot be processed. When you are not sure about the outcome of a payout creation request, e.g. when there are network issues or system failures such as timeout, you can try to get a payout with this request_id to find out.
Note: Can be non-UUID as long as it is unique among the requests within the past 7 days.
Details for the beneficiary in the payment request. If beneficiary_id provided in the payment request then beneficiary should be empty
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
An Airwallex beneficiary_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the beneficiary section and should be empty if the beneficiary fields are provided
Free text field available to you; can be populated with any additional identifiers that may be required for the payment
Denotes whether PAYER/BENEFICIARY will be liable for the payment fees, and it affects the actual amount the beneficiary receives
A set of key-value pairs for storing your own data together with the payment.
Details for the payer in the payment request. If payer_id provided in the payment request then payer should be empty
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
An Airwallex payer_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the payer section and should be empty if the payer fields are provided
Payment amount in payment_currency
Date when payment should be made
Payment method, i.e. SWIFT, LOCAL
Provide a valid quote_id to execute the conversion at the client_rate provided in the quote.
Source amount in source_currency
Source currency, i.e. the currency that the Payer uses to fund the payment (3-letter ISO-4217 code)
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
The total amount (in payment payment_currency) the beneficiary receives for this payment, and is governed by value specified in fee_paid_by, i.e. if fee_paid_by is PAYER, then the beneficiary receives the exact same payment_amount since payer is responsible for the payment fee. Otherwise, beneficiary receives payment_amount - fee as the fee is implicitly passed onto the beneficiary
The total amount (in source_currency) the payer has to pay for making this payment. For example, if fee_paid_by is PAYER and FX conversion is not involved, then this is the sum of payment_amount + fee as the payer is responsible for the fee. Otherwise this field is the same as payment_amount
Details of the beneficiary
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
beneficiary_id of the beneficiary contact used to create this payment
The time this payment request was created
Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the payment date.
Empty unless the payment is in an error state
Empty unless the payment is in an error state
The payment fee (in source_currency) for sending this payment
The payment fee currency. This should always equal to the source_currency
Denotes whether PAYER / BENEFICIARY will be liable for the the payment fee. Defaults to PAYER unless field is populated in the request
The time this payment request was last updated
A set of key-value pairs for storing your own data together with the payment.
Details of the payer
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
payer_id of the payer contact used to create this payment
Amount to be paid
Currency the payment should be made in (3-letter ISO-4217 code)
Date when payment should be made (Copied from the request if specified)
Returned payment_id that can be used to query the status of the payment
Copied from the request if specified. Otherwise the system will populate this field automatically
Reason for the payment instruction
Bank payment reference to be shown on beneficiary's bank transaction history
A unique request identifier specified in the payment request
Short payment reference for support purposes
Amount to be received
Copied from the request if specified
The payment status, can be one of: NEW, IN_APPROVAL, REJECTED, RECALLED, BLOCKED, PENDING_FUNDS,CANCELLED, IN_REVIEW, READY_FOR_DISPATCH, SUSPENDED, DISPATCHED, FAILED, CANCELLATION_REQUESTED, RETRIED
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
Underlying conversion_id (if source_currency is different from payment_currency)
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/payments/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "beneficiary": {> "additional_info": {> "business_area": "Travel",> "business_phone_number": "689342234",> "business_registration_number": "IT593003",> "external_identifier": "<string>",> "legal_rep_bank_account_number": "44250100003700000000",> "legal_rep_first_name_in_chinese": "小芳",> "legal_rep_id_number": "110108199304203520",> "legal_rep_last_name_in_chinese": "刘",> "legal_rep_mobile_number": "13651362890",> "personal_email": "[email protected]",> "personal_first_name_in_chinese": "大明",> "personal_id_number": "1234567890",> "personal_id_type": "NATIONAL_ID",> "personal_last_name_in_chinese": "李",> "personal_mobile_number": "13651362890",> "recipient_account_id": "<string>",> "security_question": "What is the name of my second puppy?",> "security_question_answer": "Scooby Doo"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "bank_details": {> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S",> "transaction_reference": "4140110135",> "intermediary_bank_swift_code": "CTBAAU2S",> "intermediary_bank_name": "National Australia Bank"> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "entity_type": "COMPANY",> "first_name": "John",> "last_name": "Walker"> },> "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d",> "client_data": "string",> "fee_paid_by": "PAYER",> "metadata": {> "order_id": "0123456789"> },> "payer": {> "additional_info": {> "business_registration_number": "EU300503",> "business_registration_type": "Partnership",> "external_id": "1234567890",> "personal_email": "[email protected]",> "personal_id_number": "1234567890"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "entity_type": "COMPANY",> "first_name": "James",> "last_name": "Smith"> },> "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c",> "payment_amount": "10000",> "payment_currency": "AUD",> "payment_date": "2017-03-20",> "payment_method": "SWIFT",> "quote_id": "<string>",> "reason": "travel",> "reference": "PMT1936398",> "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",> "source_amount": "10000",> "source_currency": "AUD",> "swift_charge_option": "SHARED">}'
1{2 "amount_beneficiary_receives": 99996,3 "amount_payer_pays": 10004,4 "beneficiary": {5 "additional_info": {6 "business_area": "Travel",7 "business_phone_number": "689342234",8 "business_registration_number": "IT593003",9 "external_identifier": "<string>",10 "legal_rep_bank_account_number": "44250100003700000000",11 "legal_rep_first_name_in_chinese": "小芳",12 "legal_rep_id_number": "110108199304203520",13 "legal_rep_last_name_in_chinese": "刘",14 "legal_rep_mobile_number": "13651362890",15 "personal_email": "[email protected]",16 "personal_first_name_in_chinese": "大明",17 "personal_id_number": "1234567890",18 "personal_id_type": "NATIONAL_ID",19 "personal_last_name_in_chinese": "李",20 "personal_mobile_number": "13651362890",21 "recipient_account_id": "<string>",22 "security_question": "What is the name of my second puppy?",23 "security_question_answer": "Scooby Doo"24 },25 "address": {26 "city": "Melbourne",27 "country_code": "AU",28 "postcode": "3000",29 "state": "VIC",30 "street_address": "15 William Street"31 },32 "bank_details": {33 "account_currency": "AUD",34 "account_name": "Lee Da Ming",35 "account_name_alias": "Lee D M",36 "account_number": "12750852",37 "account_routing_type1": "bsb",38 "account_routing_type2": "sort_code",39 "account_routing_value1": "083064",40 "account_routing_value2": "123456",41 "bank_account_category": "Checking,Savings,Vista,Maestra",42 "bank_branch": "Melbourne",43 "bank_country_code": "AU",44 "bank_name": "National Australia Bank",45 "bank_state": "<string>",46 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",47 "binding_mobile_number": "654897612345",48 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",49 "iban": "ES8023100001180000012345",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S",52 "transaction_reference": "4140110135",53 "intermediary_bank_swift_code": "CTBAAU2S",54 "intermediary_bank_name": "National Australia Bank"55 },56 "company_name": "Complete Concrete Pty Ltd",57 "date_of_birth": "1976-08-26",58 "entity_type": "COMPANY",59 "first_name": "John",60 "last_name": "Walker"61 },62 "beneficiary_id": "<uuid>",63 "created_at": "2017-03-22T16:08:02+1100",64 "dispatch_date": "2017-03-29",65 "failure_reason": "Insufficient funds",66 "failure_type": "UNKNOWN",67 "fee_amount": 4,68 "fee_currency": "AUD",69 "fee_paid_by": "PAYER",70 "last_updated_at": "2017-03-24T18:00:02+1100",71 "metadata": {72 "order_id": "0123456789"73 },74 "payer": {75 "additional_info": {76 "business_registration_number": "EU300503",77 "business_registration_type": "Partnership",78 "external_id": "1234567890",79 "personal_email": "[email protected]",80 "personal_id_number": "1234567890"81 },82 "address": {83 "city": "Melbourne",84 "country_code": "AU",85 "postcode": "3000",86 "state": "VIC",87 "street_address": "15 William Street"88 },89 "company_name": "Complete Concrete Pty Ltd",90 "date_of_birth": "1976-08-26",91 "entity_type": "COMPANY",92 "first_name": "James",93 "last_name": "Smith"94 },95 "payer_id": "<uuid>",96 "payment_amount": 10000,97 "payment_currency": "AUD",98 "payment_date": "2017-03-24",99 "payment_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede",100 "payment_method": "SWIFT",101 "reason": "travel",102 "reference": "PMT1936398",103 "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",104 "short_reference_id": "20170322-9F6ML2",105 "source_amount": 10000,106 "source_currency": "AUD",107 "status": "DISPATCHED",108 "swift_charge_option": "SHARED",109 "underlying_conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede"110}
Retry a payment
POST /api/v1/payments/retry/{payment_id}
Retry a payment by payment_id. A payment must be in a status of FAILED to be retried. Only a limited set of the original payment payload can be amended as part of a retry.
If a payment was initially created and submitted for approval, retry is not supported.
Unique identifier of the payment to retry
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
The total amount (in payment payment_currency) the beneficiary receives for this payment, and is governed by value specified in fee_paid_by, i.e. if fee_paid_by is PAYER, then the beneficiary receives the exact same payment_amount since payer is responsible for the payment fee. Otherwise, beneficiary receives payment_amount - fee as the fee is implicitly passed onto the beneficiary
The total amount (in source_currency) the payer has to pay for making this payment. For example, if fee_paid_by is PAYER and FX conversion is not involved, then this is the sum of payment_amount + fee as the payer is responsible for the fee. Otherwise this field is the same as payment_amount
Details of the beneficiary
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
beneficiary_id of the beneficiary contact used to create this payment
The time this payment request was created
Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the payment date.
Empty unless the payment is in an error state
Empty unless the payment is in an error state
The payment fee (in source_currency) for sending this payment
The payment fee currency. This should always equal to the source_currency
Denotes whether PAYER / BENEFICIARY will be liable for the the payment fee. Defaults to PAYER unless field is populated in the request
The time this payment request was last updated
A set of key-value pairs for storing your own data together with the payment.
Details of the payer
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
payer_id of the payer contact used to create this payment
Amount to be paid
Currency the payment should be made in (3-letter ISO-4217 code)
Date when payment should be made (Copied from the request if specified)
Returned payment_id that can be used to query the status of the payment
Copied from the request if specified. Otherwise the system will populate this field automatically
Reason for the payment instruction
Bank payment reference to be shown on beneficiary's bank transaction history
A unique request identifier specified in the payment request
Short payment reference for support purposes
Amount to be received
Copied from the request if specified
The payment status, can be one of: NEW, IN_APPROVAL, REJECTED, RECALLED, BLOCKED, PENDING_FUNDS,CANCELLED, IN_REVIEW, READY_FOR_DISPATCH, SUSPENDED, DISPATCHED, FAILED, CANCELLATION_REQUESTED, RETRIED
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
Underlying conversion_id (if source_currency is different from payment_currency)
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/payments/retry/payment_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S",> "transaction_reference": "4140110135",> "intermediary_bank_swift_code": "CTBAAU2S",> "intermediary_bank_name": "National Australia Bank">}'
1{2 "amount_beneficiary_receives": 99996,3 "amount_payer_pays": 10004,4 "beneficiary": {5 "additional_info": {6 "business_area": "Travel",7 "business_phone_number": "689342234",8 "business_registration_number": "IT593003",9 "external_identifier": "<string>",10 "legal_rep_bank_account_number": "44250100003700000000",11 "legal_rep_first_name_in_chinese": "小芳",12 "legal_rep_id_number": "110108199304203520",13 "legal_rep_last_name_in_chinese": "刘",14 "legal_rep_mobile_number": "13651362890",15 "personal_email": "[email protected]",16 "personal_first_name_in_chinese": "大明",17 "personal_id_number": "1234567890",18 "personal_id_type": "NATIONAL_ID",19 "personal_last_name_in_chinese": "李",20 "personal_mobile_number": "13651362890",21 "recipient_account_id": "<string>",22 "security_question": "What is the name of my second puppy?",23 "security_question_answer": "Scooby Doo"24 },25 "address": {26 "city": "Melbourne",27 "country_code": "AU",28 "postcode": "3000",29 "state": "VIC",30 "street_address": "15 William Street"31 },32 "bank_details": {33 "account_currency": "AUD",34 "account_name": "Lee Da Ming",35 "account_name_alias": "Lee D M",36 "account_number": "12750852",37 "account_routing_type1": "bsb",38 "account_routing_type2": "sort_code",39 "account_routing_value1": "083064",40 "account_routing_value2": "123456",41 "bank_account_category": "Checking,Savings,Vista,Maestra",42 "bank_branch": "Melbourne",43 "bank_country_code": "AU",44 "bank_name": "National Australia Bank",45 "bank_state": "<string>",46 "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",47 "binding_mobile_number": "654897612345",48 "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",49 "iban": "ES8023100001180000012345",50 "local_clearing_system": "ACH",51 "swift_code": "CTBAAU2S",52 "transaction_reference": "4140110135",53 "intermediary_bank_swift_code": "CTBAAU2S",54 "intermediary_bank_name": "National Australia Bank"55 },56 "company_name": "Complete Concrete Pty Ltd",57 "date_of_birth": "1976-08-26",58 "entity_type": "COMPANY",59 "first_name": "John",60 "last_name": "Walker"61 },62 "beneficiary_id": "<uuid>",63 "created_at": "2017-03-22T16:08:02+1100",64 "dispatch_date": "2017-03-29",65 "failure_reason": "Insufficient funds",66 "failure_type": "UNKNOWN",67 "fee_amount": 4,68 "fee_currency": "AUD",69 "fee_paid_by": "PAYER",70 "last_updated_at": "2017-03-24T18:00:02+1100",71 "metadata": {72 "order_id": "0123456789"73 },74 "payer": {75 "additional_info": {76 "business_registration_number": "EU300503",77 "business_registration_type": "Partnership",78 "external_id": "1234567890",79 "personal_email": "[email protected]",80 "personal_id_number": "1234567890"81 },82 "address": {83 "city": "Melbourne",84 "country_code": "AU",85 "postcode": "3000",86 "state": "VIC",87 "street_address": "15 William Street"88 },89 "company_name": "Complete Concrete Pty Ltd",90 "date_of_birth": "1976-08-26",91 "entity_type": "COMPANY",92 "first_name": "James",93 "last_name": "Smith"94 },95 "payer_id": "<uuid>",96 "payment_amount": 10000,97 "payment_currency": "AUD",98 "payment_date": "2017-03-24",99 "payment_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede",100 "payment_method": "SWIFT",101 "reason": "travel",102 "reference": "PMT1936398",103 "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",104 "short_reference_id": "20170322-9F6ML2",105 "source_amount": 10000,106 "source_currency": "AUD",107 "status": "DISPATCHED",108 "swift_charge_option": "SHARED",109 "underlying_conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede"110}
Validate payment
POST /api/v1/payments/validate
Given a payment request, validate it and return all failed fields as a 400 response. No errors will be "OK" as a 200 response.
Payment currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)
Reason for the payment instruction
A user specified reference that will be displayed to the beneficiary on the payment transaction with their bank
A unique request ID specified by the client. Payout creation requests with a request_id that has been used in the past 7 days are treated as duplicated payout and cannot be processed. When you are not sure about the outcome of a payout creation request, e.g. when there are network issues or system failures such as timeout, you can try to get a payout with this request_id to find out.
Note: Can be non-UUID as long as it is unique among the requests within the past 7 days.
Details for the beneficiary in the payment request. If beneficiary_id provided in the payment request then beneficiary should be empty
Beneficiary's bank account details where the payment will be credited
Account Currency
Account holder name of the beneficiary’s bank account
Bank country code (2-letter ISO 3166-2 country code)
Fingerprint of current beneficiary's bank account
The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the Payouts Product Docs .
Account number, mostly for non-european countries, either account_number or iban should be filled
Routing code type
Routing code sub type
Routing code value
Routing code sub type value
bank account type
Specific branch of bank account
Bank name of the beneficiary's bank account
Bank State
Bank street address
The mobile number tied to the Beneficiary's bank account
International bank account number, mostly for european countries
Bank name of the beneficiary's intermediary bank
Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC
Which clearing system should be used for this local bank transfer.
Please refer to our payout guide for details about each option.
We suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option).
Bank swift code
The unique reference number that clients need to add when they doing the deposit so that we can top up the fund to correct account
Entity type of the beneficiary
Additional information about the beneficiary
Category of business activity
Business phone number
Business registration number
The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes
Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number.
Legal representative first name in chinese
Legal representative id number
Legal representative last name in chinese
Legal representative’s mobile number associated with their bank account.
Personal email
Beneficiary's first name in Chinese
Personal unique identifier number
Personal unique identifier type
Beneficiary's last name in Chinese
Personal mobile number
Account unique identifier of the recipient account used for payout processing. The account must be active and have customer_agreements.terms_and_conditions.service_agreement_type set to RECIPIENT (verify via Retrieve account details API).
Security question. Required when the email address is not registered with Interac e-Transfer autodeposit.
Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit.
Beneficiary's address details
Beneficiary's city
Beneficiary's country code (2-letter ISO 3166-2 country code)
Beneficiary's post code
Beneficiary's state
Beneficiary's street address
Company name of the beneficiary
beneficiary date of birth
First name of the beneficiary
Last name of the beneficiary
An Airwallex beneficiary_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the beneficiary section and should be empty if the beneficiary fields are provided
Free text field available to you; can be populated with any additional identifiers that may be required for the payment
Denotes whether PAYER/BENEFICIARY will be liable for the payment fees, and it affects the actual amount the beneficiary receives
A set of key-value pairs for storing your own data together with the payment.
Details for the payer in the payment request. If payer_id provided in the payment request then payer should be empty
Payer's address details
Payer's country code (2-letter ISO 3166-2 country code)
Payer's city
Payer's post code
Payer's state
Payer's street address
Entity type of the payer
Additional information about the payer
Business registration number
Type of business as registered with the local government authority
Unique identifier of the person in your company
Personal email
Personal unique identifier number
Company name of the payer
Payer's date of birth
First name of the payer
Last name of the payer
An Airwallex payer_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the payer section and should be empty if the payer fields are provided
Payment amount in payment_currency
Date when payment should be made
Payment method, i.e. SWIFT, LOCAL
Provide a valid quote_id to execute the conversion at the client_rate provided in the quote.
Source amount in source_currency
Source currency, i.e. the currency that the Payer uses to fund the payment (3-letter ISO-4217 code)
(For SWIFT payments only), specify who should bear SWIFT charges, either SHARED (default) or PAYER
OK
| Error status | Description |
|---|---|
| 400 | Possible errors: |
| 401 | Possible errors: |
| 429 | Too many requests |
| 500 | Service unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/payments/validate' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "beneficiary": {> "additional_info": {> "business_area": "Travel",> "business_phone_number": "689342234",> "business_registration_number": "IT593003",> "external_identifier": "<string>",> "legal_rep_bank_account_number": "44250100003700000000",> "legal_rep_first_name_in_chinese": "小芳",> "legal_rep_id_number": "110108199304203520",> "legal_rep_last_name_in_chinese": "刘",> "legal_rep_mobile_number": "13651362890",> "personal_email": "[email protected]",> "personal_first_name_in_chinese": "大明",> "personal_id_number": "1234567890",> "personal_id_type": "NATIONAL_ID",> "personal_last_name_in_chinese": "李",> "personal_mobile_number": "13651362890",> "recipient_account_id": "<string>",> "security_question": "What is the name of my second puppy?",> "security_question_answer": "Scooby Doo"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "bank_details": {> "account_currency": "AUD",> "account_name": "Lee Da Ming",> "account_name_alias": "Lee D M",> "account_number": "12750852",> "account_routing_type1": "bsb",> "account_routing_type2": "sort_code",> "account_routing_value1": "083064",> "account_routing_value2": "123456",> "bank_account_category": "Checking,Savings,Vista,Maestra",> "bank_branch": "Melbourne",> "bank_country_code": "AU",> "bank_name": "National Australia Bank",> "bank_state": "<string>",> "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia",> "binding_mobile_number": "654897612345",> "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c",> "iban": "ES8023100001180000012345",> "local_clearing_system": "ACH",> "swift_code": "CTBAAU2S",> "transaction_reference": "4140110135",> "intermediary_bank_swift_code": "CTBAAU2S",> "intermediary_bank_name": "National Australia Bank"> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "entity_type": "COMPANY",> "first_name": "John",> "last_name": "Walker"> },> "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d",> "client_data": "string",> "fee_paid_by": "PAYER",> "metadata": {> "order_id": "0123456789"> },> "payer": {> "additional_info": {> "business_registration_number": "EU300503",> "business_registration_type": "Partnership",> "external_id": "1234567890",> "personal_email": "[email protected]",> "personal_id_number": "1234567890"> },> "address": {> "city": "Melbourne",> "country_code": "AU",> "postcode": "3000",> "state": "VIC",> "street_address": "15 William Street"> },> "company_name": "Complete Concrete Pty Ltd",> "date_of_birth": "1976-08-26",> "entity_type": "COMPANY",> "first_name": "James",> "last_name": "Smith"> },> "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c",> "payment_amount": "10000",> "payment_currency": "AUD",> "payment_date": "2017-03-20",> "payment_method": "SWIFT",> "quote_id": "<string>",> "reason": "travel",> "reference": "PMT1936398",> "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",> "source_amount": "10000",> "source_currency": "AUD",> "swift_charge_option": "SHARED">}'