Airwallex · Schema

Transfer

An Airwallex cross-border transfer to a beneficiary account.

Cross-Border PaymentsFinTechForeign ExchangePaymentsGlobalEmbedded FinanceMulti-Currency

Properties

Name Type Description
id string Unique transfer identifier.
source_amount number Amount debited from the source account.
source_currency string ISO 4217 currency code of the source amount.
target_amount number Amount received by the beneficiary.
target_currency string ISO 4217 currency code of the target amount.
status string Current transfer status.
beneficiary_id string ID of the beneficiary account.
reference string Payment reference for the transfer.
fee number Transfer fee charged.
fee_currency string Currency of the fee.
fx_rate number Applied foreign exchange rate.
created_at string Timestamp when the transfer was created.
View JSON Schema on GitHub

JSON Schema

airwallex-transfer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airwallex/refs/heads/main/json-schema/airwallex-transfer-schema.json",
  "title": "Transfer",
  "description": "An Airwallex cross-border transfer to a beneficiary account.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique transfer identifier.",
      "example": "txf_abc123def456"
    },
    "source_amount": {
      "type": "number",
      "description": "Amount debited from the source account.",
      "example": 1000.00
    },
    "source_currency": {
      "type": "string",
      "description": "ISO 4217 currency code of the source amount.",
      "example": "USD"
    },
    "target_amount": {
      "type": "number",
      "description": "Amount received by the beneficiary.",
      "example": 920.50
    },
    "target_currency": {
      "type": "string",
      "description": "ISO 4217 currency code of the target amount.",
      "example": "EUR"
    },
    "status": {
      "type": "string",
      "enum": ["CREATED", "PENDING", "SUBMITTED", "SETTLED", "FAILED", "CANCELLED"],
      "description": "Current transfer status.",
      "example": "SETTLED"
    },
    "beneficiary_id": {
      "type": "string",
      "description": "ID of the beneficiary account.",
      "example": "ben_abc123"
    },
    "reference": {
      "type": "string",
      "description": "Payment reference for the transfer.",
      "example": "Invoice-2026-001"
    },
    "fee": {
      "type": "number",
      "description": "Transfer fee charged.",
      "example": 5.00
    },
    "fee_currency": {
      "type": "string",
      "description": "Currency of the fee.",
      "example": "USD"
    },
    "fx_rate": {
      "type": "number",
      "description": "Applied foreign exchange rate.",
      "example": 0.9205
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the transfer was created.",
      "example": "2026-04-19T10:30:00Z"
    }
  },
  "required": ["id", "source_amount", "source_currency", "status"]
}