Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewHow Airwallex Payouts work
Payout network
Use cases
Payouts
Create a payout
Payout statusesGenerate a confirmation letter
Simulate payout status transition
Validate a payoutManage payouts
Payouts to countries/regions with capital controls
Create a payout to an Airwallex account
Embedded Payout component
Test and go live

Generate a confirmation letter

Call Create confirmation letter API to generate payout confirmation letters by providing the following parameters in your request:

  • format: Specify the format of the confirmation letter - STANDARD (with fee information) or NO_FEE_DISPLAY (without fee information).
  • transaction_id: Provide payment_id of the payout.

Example request

Shell

If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.

A successful request will return the confirmation letter in pdf format as file stream, including the following details:

  • Transfer details: Amount paid, transfer method, creation date, transfer date, amount received, transfer fee, transfer status, exchange rate (if currency conversion involved), etc.
  • Beneficiary details: Recipient's name, bank code, bank name, account number, address, etc.
  • Payer details (if applicable): Payer's name, address, etc.

Please find below example files in the two respective formats:

Confirmation letter - STANDARD

Confirmation letter - NO_FEE_DISPLAY