Airwallex · JSON Structure

Airwallex Payment Intent Structure

An Airwallex payment intent representing a payment session for collecting customer payment.

Type: object Properties: 13 Required: 4

Cross-Border PaymentsFinTechForeign ExchangePaymentsGlobalEmbedded FinanceMulti-Currency

PaymentIntent is a JSON Structure definition published by Airwallex, describing 13 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id amount currency merchant_order_id status client_secret captured_amount customer_id payment_method_options descriptor metadata created_at updated_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airwallex/refs/heads/main/json-structure/airwallex-payment-intent-structure.json",
  "name": "PaymentIntent",
  "description": "An Airwallex payment intent representing a payment session for collecting customer payment.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique payment intent identifier.",
      "example": "int_abc123def456"
    },
    "amount": {
      "type": "double",
      "description": "Payment amount in the specified currency.",
      "example": 100.0
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code.",
      "example": "USD"
    },
    "merchant_order_id": {
      "type": "string",
      "description": "Merchant's own order identifier.",
      "example": "order-20260419-001"
    },
    "status": {
      "type": "string",
      "enum": [
        "CREATED",
        "REQUIRES_PAYMENT_METHOD",
        "REQUIRES_CUSTOMER_ACTION",
        "REQUIRES_CAPTURE",
        "SUCCEEDED",
        "CANCELLED",
        "EXPIRED"
      ],
      "description": "Current payment intent status.",
      "example": "SUCCEEDED"
    },
    "client_secret": {
      "type": "string",
      "description": "Client secret for frontend SDK initialization.",
      "example": "cs_abc123"
    },
    "captured_amount": {
      "type": "double",
      "description": "Amount captured so far.",
      "example": 100.0
    },
    "customer_id": {
      "type": "string",
      "description": "Airwallex customer ID.",
      "example": "cus_abc123"
    },
    "payment_method_options": {
      "type": "object",
      "description": "Payment method configuration options."
    },
    "descriptor": {
      "type": "string",
      "description": "Statement descriptor shown on customer bank statement.",
      "example": "ACME Corp"
    },
    "metadata": {
      "type": "object",
      "description": "Arbitrary key-value metadata for the payment intent."
    },
    "created_at": {
      "type": "datetime",
      "description": "Timestamp when the payment intent was created.",
      "example": "2026-04-19T10:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "Timestamp of last update.",
      "example": "2026-04-19T10:31:00Z"
    }
  },
  "required": [
    "id",
    "amount",
    "currency",
    "status"
  ]
}