Airwallex Public API v2023-04-15

Authentication-API Access

Obtain access token

Issuing-Authorizations

Get authorization status Get single authorization status

Issuing-Cardholders

Create a cardholder Get all cardholders Get cardholder details Update a cardholder

Create a card Get sensitive card details Get all cards Activate a card Get card details Get card remaining limits Update a card

Get issuing config Update issuing config

Issuing-Transactions

Get transactions Get single transaction

Online Payments-Config

Retrieve available payment method types Retrieve bank names for certain payment method types

Online Payments-Customers

Create a Customer Retrieve a Customer Update a Customer Generate a client secret for a Customer Add PaymentMethod to Customer Remove PaymentMethod from Customer Get list of Customers

Online Payments-Customs Declarations

Create a customs declaration

Online Payments-Fund Splits

Create a FundsSplit Retrieve a FundsSplit Get list of FundsSplits Release a FundsSplit

Online Payments-Payment Attempts

Retrieve a PaymentAttempt by ID Retrieve list of PaymentAttempts

Online Payments-Payment Consents

Create a PaymentConsent - MIT Get list of PaymentConsents

Online Payments-Payment Intents

Create a PaymentIntent - With More Info Retrieve a PaymentIntent Confirm a PaymentIntent - Trigger Netcetera 3DS Continue to confirm a PaymentIntent Capture a PaymentIntent Get list of PaymentIntents

Online Payments-Payment Methods

Create a PaymentMethod Retrieve a PaymentMethod Update a PaymentMethod Get list of PaymentMethods Disable a PaymentMethod

Online Payments-Quote

Create a Quote Get list of Quotes

Online Payments-Refunds

Create a Refund Retrieve a Refund Get list of Refunds

Payouts-Beneficiaries

Get list of beneficiaries Get a beneficiary by ID Create a new beneficiary Delete existing beneficiary Update existing beneficiary Validate beneficiary Get the API schema Get the form schema

Get list of payers Get a payer by ID Create a new payer Update existing payer Delete existing payer Validate payer

Payouts-Payments

Get list of payments Get payment by ID Cancel a payment Create a new payment - to beneficiary_id Retry a payment Update a payment Validate payment

Reporting-Financial Reports

Get list of financial reports Get financial report by ID Get contents of a financial report Create a financial report

Reporting-Financial Transactions

Get list of financial transactions Get a financial transaction by ID

Reporting-Settlements

Get list of settlements Get a settlement by ID Get a settlement report by ID

Scale-Account Links

Create an account invitation link - scale_connect Get an account invitation link by ID

Create an account - Individual Update a connected account Submit account for activation Get account by ID Get list of connected accounts Retrieve account details Agree to terms and conditions

Get list of charges Get a charge by ID Create a new charge

Scale-Hosted Flow

Create flow Get flow Authorize flow

Scale-Transfers

Get list of transfers Get a transfer by ID Create a new transfer

Simulation (Demo Only)-Accounts

Update status of connected account

Simulation (Demo Only)-Cards

Create a transaction for the provided card Capture the transaction with the provided id

Simulation (Demo Only)-Global Account

Create a global account deposit

Simulation (Demo Only)-Payouts

Transition Payment Status

Supporting Services-File Service

Get onboarding file download links Upload a file

Supporting Services-Notification

Create a new notification

Supporting Services-Reference Data

Industry categories Invalid conversion dates Settlement accounts Supported currencies

Transactional FX-Conversion

Create a conversion - sell_amount based Retrieve a specific conversion List conversions Reverse a settled conversion

Transactional FX-Lock FX

Create LockFX quote

Transactional FX-Market FX

Get indicative market quote

Treasury-Balances

Get current balances Get balance history

Treasury-Deposits

Get list of deposits

Treasury-Global Accounts

Get a list of global accounts Get global account by ID Generate global account statement - GENERAL Get global account transactions Open a global account

Treasury-Direct Debit LBA-Simulation

Settle Reverse Reject

Treasury-Direct Debit LBA

Get Linked Bank Accounts Create Linked Bank Account Verify Linked Account with micro-deposits Get mandate Update Mandate for LBA Funding limits

Airwallex Public API v2024-01-31

Supporting Services-File Service

Upload a file Get onboarding file download links

Supporting Services-Reference Data

Industry categories Invalid conversion dates Settlement accounts Supported currencies

Transactional FX-Conversion

Create a conversion - sell_amount based Retrieve a specific conversion List conversions Reverse a settled conversion

Transactional FX-Lock FX

Create LockFX quote

Transactional FX-Market FX

Get indicative market quote

Scale-Account Links

Create an account invitation link - scale_connect Get an account invitation link by ID

Create an account - Individual Update a connected account Submit account for activation Agree to terms and conditions Get account by ID Get list of connected accounts Retrieve account details

Create a new charge Get list of charges Get a charge by ID

Scale-Hosted Flow

Create flow Get flow Authorize flow

Scale-Transfers

Create a new transfer Get list of transfers Get a transfer by ID

Reporting-Financial Reports

Get list of financial reports Get financial report by ID Get contents of a financial report Create a financial report

Reporting-Financial Transactions

Get list of financial transactions Get a financial transaction by ID

Reporting-Settlements

Get list of settlements Get a settlement by ID Get a settlement report by ID

Treasury-Balances

Get current balances Get balance history

Treasury-Deposits

Get list of deposits Get a deposit by ID Create a deposit via Direct Debit

Treasury-Global Accounts

Get a list of global accounts Get global account by ID Generate global account statement - GENERAL Get global account transactions Open a global account

Treasury-Direct Debit LBA

Get Linked Bank Accounts Get Linked Bank Account by id Create Linked Bank Account Verify Linked Account with micro-deposits Get mandate Update Mandate for LBA Funding limits

Issuing-Authorizations

Get authorization status Get single authorization status

Issuing-Cardholders

Create a cardholder Get all cardholders Get cardholder details Update a cardholder

Create a card Get sensitive card details Get all cards Activate a card Get card details Get card remaining limits Update a card

Get issuing config Update issuing config

Issuing-Transactions

Get transactions Get single transaction

Authentication-API Access

Obtain access token

Online Payments-Config

Retrieve available payment method types Retrieve bank names for certain payment method types

Online Payments-Customers

Create a Customer Retrieve a Customer Update a Customer Generate a client secret for a Customer Get list of Customers

Online Payments-Customs Declarations

Create a customs declaration

Online Payments-Fund Splits

Create a FundsSplit Retrieve a FundsSplit Get list of FundsSplits Release a FundsSplit

Online Payments-Payment Attempts

Retrieve a PaymentAttempt by ID Retrieve list of PaymentAttempts

Online Payments-Payment Consents

Create a PaymentConsent - MIT Get list of PaymentConsents

Online Payments-Payment Intents

Create a PaymentIntent - With More Info Retrieve a PaymentIntent Confirm a PaymentIntent - Trigger Netcetera 3DS Continue to confirm a PaymentIntent Capture a PaymentIntent Get list of PaymentIntents

Online Payments-Payment Methods

Create a PaymentMethod Retrieve a PaymentMethod Update a PaymentMethod Get list of PaymentMethods Disable a PaymentMethod

Online Payments-Quote

Create a Quote Get list of Quotes

Online Payments-Refunds

Create a Refund Retrieve a Refund Get list of Refunds

Payouts-Beneficiaries

Get list of beneficiaries Get a beneficiary by ID Create a new beneficiary Delete existing beneficiary Update existing beneficiary Validate beneficiary Get the API schema Get the form schema

Get list of payers Create a new payer Get a payer by ID Update existing payer Validate payer Delete existing payer

Payouts-Payments

Create a new payment - to beneficiary_id Get list of payments Get payment by ID Validate payment Cancel a payment

Simulation (Demo Only)-Accounts

Update status of connected account

Simulation (Demo Only)-Cards

Create a transaction for the provided card Capture the transaction with the provided id

Simulation (Demo Only)-Global Account

Create a global account deposit

Simulation (Demo Only)-Payouts

Transition Payment Status

Simulation (Demo Only)-Deposits

Create a global account deposit Reject a direct debit deposit Reverse a direct debit deposit Settle a direct debit deposit

Airwallex Public API v2023-04-15

Authentication-API Access

Obtain access token

Issuing-Authorizations

Get authorization status Get single authorization status

Issuing-Cardholders

Create a cardholder Get all cardholders Get cardholder details Update a cardholder

Create a card Get sensitive card details Get all cards Activate a card Get card details Get card remaining limits Update a card

Get issuing config Update issuing config

Issuing-Transactions

Get transactions Get single transaction

Online Payments-Config

Retrieve available payment method types Retrieve bank names for certain payment method types

Online Payments-Customers

Create a Customer Retrieve a Customer Update a Customer Generate a client secret for a Customer Add PaymentMethod to Customer Remove PaymentMethod from Customer Get list of Customers

Online Payments-Customs Declarations

Create a customs declaration

Online Payments-Fund Splits

Create a FundsSplit Retrieve a FundsSplit Get list of FundsSplits Release a FundsSplit

Online Payments-Payment Attempts

Retrieve a PaymentAttempt by ID Retrieve list of PaymentAttempts

Online Payments-Payment Consents

Create a PaymentConsent - MIT Get list of PaymentConsents

Online Payments-Payment Intents

Create a PaymentIntent - With More Info Retrieve a PaymentIntent Confirm a PaymentIntent - Trigger Netcetera 3DS Continue to confirm a PaymentIntent Capture a PaymentIntent Get list of PaymentIntents

Online Payments-Payment Methods

Create a PaymentMethod Retrieve a PaymentMethod Update a PaymentMethod Get list of PaymentMethods Disable a PaymentMethod

Online Payments-Quote

Create a Quote Get list of Quotes

Online Payments-Refunds

Create a Refund Retrieve a Refund Get list of Refunds

Payouts-Beneficiaries

Get list of beneficiaries Get a beneficiary by ID Create a new beneficiary Delete existing beneficiary Update existing beneficiary Validate beneficiary Get the API schema Get the form schema

Get list of payers Get a payer by ID Create a new payer Update existing payer Delete existing payer Validate payer

Payouts-Payments

Get list of payments Get payment by ID Cancel a payment Create a new payment - to beneficiary_id Retry a payment Update a payment Validate payment

Reporting-Financial Reports

Get list of financial reports Get financial report by ID Get contents of a financial report Create a financial report

Reporting-Financial Transactions

Get list of financial transactions Get a financial transaction by ID

Reporting-Settlements

Get list of settlements Get a settlement by ID Get a settlement report by ID

Scale-Account Links

Create an account invitation link - scale_connect Get an account invitation link by ID

Create an account - Individual Update a connected account Submit account for activation Get account by ID Get list of connected accounts Retrieve account details Agree to terms and conditions

Get list of charges Get a charge by ID Create a new charge

Scale-Hosted Flow

Create flow Get flow Authorize flow

Scale-Transfers

Get list of transfers Get a transfer by ID Create a new transfer

Simulation (Demo Only)-Accounts

Update status of connected account

Simulation (Demo Only)-Cards

Create a transaction for the provided card Capture the transaction with the provided id

Simulation (Demo Only)-Global Account

Create a global account deposit

Simulation (Demo Only)-Payouts

Transition Payment Status

Supporting Services-File Service

Get onboarding file download links Upload a file

Supporting Services-Notification

Create a new notification

Supporting Services-Reference Data

Industry categories Invalid conversion dates Settlement accounts Supported currencies

Transactional FX-Conversion

Create a conversion - sell_amount based Retrieve a specific conversion List conversions Reverse a settled conversion

Transactional FX-Lock FX

Create LockFX quote

Transactional FX-Market FX

Get indicative market quote

Treasury-Balances

Get current balances Get balance history

Treasury-Deposits

Get list of deposits

Treasury-Global Accounts

Get a list of global accounts Get global account by ID Generate global account statement - GENERAL Get global account transactions Open a global account

Treasury-Direct Debit LBA-Simulation

Settle Reverse Reject

Treasury-Direct Debit LBA

Get Linked Bank Accounts Create Linked Bank Account Verify Linked Account with micro-deposits Get mandate Update Mandate for LBA Funding limits

Airwallex Public API v2024-01-31

Supporting Services-File Service

Upload a file Get onboarding file download links

Supporting Services-Reference Data

Industry categories Invalid conversion dates Settlement accounts Supported currencies

Transactional FX-Conversion

Create a conversion - sell_amount based Retrieve a specific conversion List conversions Reverse a settled conversion

Transactional FX-Lock FX

Create LockFX quote

Transactional FX-Market FX

Get indicative market quote

Scale-Account Links

Create an account invitation link - scale_connect Get an account invitation link by ID

Create an account - Individual Update a connected account Submit account for activation Agree to terms and conditions Get account by ID Get list of connected accounts Retrieve account details

Create a new charge Get list of charges Get a charge by ID

Scale-Hosted Flow

Create flow Get flow Authorize flow

Scale-Transfers

Create a new transfer Get list of transfers Get a transfer by ID

Reporting-Financial Reports

Get list of financial reports Get financial report by ID Get contents of a financial report Create a financial report

Reporting-Financial Transactions

Get list of financial transactions Get a financial transaction by ID

Reporting-Settlements

Get list of settlements Get a settlement by ID Get a settlement report by ID

Treasury-Balances

Get current balances Get balance history

Treasury-Deposits

Get list of deposits Get a deposit by ID Create a deposit via Direct Debit

Treasury-Global Accounts

Get a list of global accounts Get global account by ID Generate global account statement - GENERAL Get global account transactions Open a global account

Treasury-Direct Debit LBA

Get Linked Bank Accounts Get Linked Bank Account by id Create Linked Bank Account Verify Linked Account with micro-deposits Get mandate Update Mandate for LBA Funding limits

Issuing-Authorizations

Get authorization status Get single authorization status

Issuing-Cardholders

Create a cardholder Get all cardholders Get cardholder details Update a cardholder

Create a card Get sensitive card details Get all cards Activate a card Get card details Get card remaining limits Update a card

Get issuing config Update issuing config

Issuing-Transactions

Get transactions Get single transaction

Authentication-API Access

Obtain access token

Online Payments-Config

Retrieve available payment method types Retrieve bank names for certain payment method types

Online Payments-Customers

Create a Customer Retrieve a Customer Update a Customer Generate a client secret for a Customer Get list of Customers

Online Payments-Customs Declarations

Create a customs declaration

Online Payments-Fund Splits

Create a FundsSplit Retrieve a FundsSplit Get list of FundsSplits Release a FundsSplit

Online Payments-Payment Attempts

Retrieve a PaymentAttempt by ID Retrieve list of PaymentAttempts

Online Payments-Payment Consents

Create a PaymentConsent - MIT Get list of PaymentConsents

Online Payments-Payment Intents

Create a PaymentIntent - With More Info Retrieve a PaymentIntent Confirm a PaymentIntent - Trigger Netcetera 3DS Continue to confirm a PaymentIntent Capture a PaymentIntent Get list of PaymentIntents

Online Payments-Payment Methods

Create a PaymentMethod Retrieve a PaymentMethod Update a PaymentMethod Get list of PaymentMethods Disable a PaymentMethod

Online Payments-Quote

Create a Quote Get list of Quotes

Online Payments-Refunds

Create a Refund Retrieve a Refund Get list of Refunds

Payouts-Beneficiaries

Get list of beneficiaries Get a beneficiary by ID Create a new beneficiary Delete existing beneficiary Update existing beneficiary Validate beneficiary Get the API schema Get the form schema

Get list of payers Create a new payer Get a payer by ID Update existing payer Validate payer Delete existing payer

Payouts-Payments

Create a new payment - to beneficiary_id Get list of payments Get payment by ID Validate payment Cancel a payment

Simulation (Demo Only)-Accounts

Update status of connected account

Simulation (Demo Only)-Cards

Create a transaction for the provided card Capture the transaction with the provided id

Simulation (Demo Only)-Global Account

Create a global account deposit

Simulation (Demo Only)-Payouts

Transition Payment Status

Simulation (Demo Only)-Deposits

Create a global account deposit Reject a direct debit deposit Reverse a direct debit deposit Settle a direct debit deposit

Home Airwallex Public API v2023-04-15 Payouts-PaymentsCancel a payment

Cancel a payment

POST {{url}}/api/v1/payments/cancel/:payment_id

HEADERS

Key	Datatype	Required	Description
`x-on-behalf-of`	string

Get payment by ID

Create a new payment - to beneficiary_id