Payment Intents
A PaymentIntent guides you through the process of collecting a payment from your customer. It tracks a payment when your customer first checks out, through to when payment is successfully paid by your customer. A PaymentIntent transitions through a number of states throughout the customer's payment journey.
You may specify the following on a PaymentIntent.
- How much the payment is for? Denoted by
amountandcurrency. - Who is making the payment? This is described by the optional
customer_idfield. - Which PaymentMethod to use? Denoted by
payment_method.
You/your customer will get back the following hints at different stages of the payment process:
- The available PaymentMethods.
- The PaymentMethod attached to this customer (if
customer_idis set).
A combination of status and next_action guide you and your customers through the payment process, including triggering additional authentication flows as required.
Data Retention Policy: You can query and operate PaymentIntent resources for a maximum of 2 years since creation.
POST /api/v1/pa/payment_intents/createGET /api/v1/pa/payment_intents/{id}POST /api/v1/pa/payment_intents/{id}/updatePOST /api/v1/pa/payment_intents/{id}/confirmPOST /api/v1/pa/payment_intents/{id}/confirm_continuePOST /api/v1/pa/payment_intents/{id}/increment_authorizationPOST /api/v1/pa/payment_intents/{id}/capturePOST /api/v1/pa/payment_intents/{id}/cancelGET /api/v1/pa/payment_intents
Create a PaymentIntent
POST /api/v1/pa/payment_intents/create
Start collecting payment from your customer by creating a PaymentIntent. The payment amount and currency, as well as the merchant order unique identifier must be provided.
Payment amount. This is the order amount you would like to charge your customer. Please refer to supported currencies for supported minor units.
Payment currency in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent. Maximum length is 64.
Unique request identifier specified by the merchant. Maximum length is 64.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Airwallex assigned account identifier of the connected entity(another account which is linked with platform). It is to be used by the platform to indicate the connected entity in the transaction where platform is the owner of transaction. Notice: This can not be used with x-on-behalf-of header together.
Details of the customer making a payment for this Payment Intent. When customer_id is provided in the request you must leave this object empty unless you want to provide additional_info related to the customer for this payment.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the customer making a payment for this Payment Intent. This field is required if the Payment Intent is created for recurring payments. Leave this field empty if the customer is unknown (guest checkout) or if the customer details are provided via the customer object. If only additional_info is provided in the customer object for the Payment Intent, you can still include customer_id in the request.
Descriptor that will display to the customer. Maximum length is 32.
Client device information applicable when payment_method is set. It is recommended to provide this data for risk analysis.
Accept header value
Browser specific data
Is Java enabled?
Is JavaScript enabled?
User Agent header value
Device unique identifier or Advertisement unique identifier or IMEI
Public IP address, both IPv4 and IPv6 are supported.
Language or locale
Location data
Latitude
Longitude
Mobile specific data
Device model
OS type
OS version
Screen color depth in bits
Screen height in pixels
Screen width in pixels
Timezone offset to UTC in hours, with added minutes if necessary
Some merchants prefer to maintain the recurring payments on their own instead of using PaymentConsent. Providing this data indicates the request is an external recurring payment.
Only effective when the payment_method.type is card, applepay, googlepay.
The party who initiated this subsequent payment request. One of merchant, customer.
Set this to true if it is the initial transaction request in a recurring series.
Default: false.
Indicate if this subsequent payment is scheduled. Only applicable when triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: scheduled
The original transaction reference which can be provided to increase the odds of getting approved by issuer when triggered_by is merchant (not in customer's presence).
Do not pass this value when initial_payment is true or if you are not clear about the valid formats (as listed below).
- Visa (
card) - 15 digits unique ID Visa assigns to the response of the original authorization request, i.e.123456789012345 - Mastercard (
card) - 13 characters trace id (DE 63 Subfield 1 & 2 + DE 15) from the response of the original authorization request, i.e.MCC123ABC0101
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
When provided, it creates specified funds splits that are automatically released after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
A set of key-value pairs that you can attach to the PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent. Only effective when the payment_method.type is card.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
The payment method details to confirm the PaymentIntent. The PaymentIntent will be confirmed automatically when payment_method is set.
Applepay information. This must be provided if type is set to applepay
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
Payment data from ApplePayPaymentToken
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Authentication method
The authentication method type. One of emv or three_ds.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Device manufacturer identifier
Cardholder name
Information required for online card transactions. This must be provided if type is set to card
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Additional information of external network token requestor. Should be provided when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
CVC code of this card. Required for all transactions except merchant initiated transactions and network tokenized transactions
Information for Korean Card
Card password first 2 digits.
A 10-digit business number of the company. Either business_number or date_of_birth must be provided.
A 6-digit date of birth in the format of YYMMDD. Either business_number or date_of_birth must be provided.
Card holder name. Maximum length is 128.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN. Default: PAN
Information required for card-present transactions. This must be provided if type is set to card_present
Cardholder verification method.
offline_pin: The PIN is verified offline by the EMV chip card.online_pin: The PIN is encrypted and verified online by issuers or card schemes.encrypted_pinis required foronline_pin.manual_signature: The cardholder signature on the receipt is compared to the signature on the back of the card.no_cvm: No verification needed.cdcvm: Cardholder device verification method. The cardholder is verified using a device's authentication method.offline_pin_and_signature: Both an offline PIN and a manual signature are used to verify the cardholder.skipped: Verification process was bypassed.
The way the terminal reads the card information.
manual_entry: Manually keyed into POS terminal.chip: Read from direct contact with a chip card.magstripe: Read from direct contact with magnetic stripe card.contactless_chip: Read from a contactless interface using chip data.contactless_magstripe: Read from a contactless interface using magnetic stripe data (MSD).
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Encrypted personal identification number. Required when cardholder_verification_method is online_pin.
Two digit number representing the card’s expiration month. Required when pan_entry_mode is manual_entry.
Four digit number representing the card’s expiration year. Required when pan_entry_mode is manual_entry.
The default is false. Set to true when:
- Chip card at a chip-capable terminal was unable to process transactions using data on the chip or magnetic strip and use entry mode
manual. - Chip card at a chip-capable terminal was unable to process transactions using data on the chip and use entry mode
contact_magnetic_stripe_card.
Fallback reason applicable when fallback is true.
Set to chip_read_failure when all of the following conditions are met:
- The transaction is initiated at a chip-capable terminal.
pan_entry_modeismagstripe.- The previous transaction initiated by the terminal was an unsuccessful chip read.
Key serial number while using DUKPT for PIN encryption.
Card number. Required when pan_entry_mode is manual_entry.
Track 1 read from magnetic stripe card
Track 2 is read from a magnetic stripe card or is track 2 equivalent data get from the chip card.
Track 2 is required when pan_entry_mode is not manual_entry.
Googlepay information. This must be provided if type is set to googlepay
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
A UTF-8 encoded, serialized JSON object with the keys specified.
Authentication data from an external 3D-Secure provider. Only applicable when Google Pay PAN_ONLY authentication method is used.
Authentication value, will be used to provide proof of authentication for 3DS v2
UUID assigned by the Directory Server to identify a single transaction for 3DS v2
Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder
Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of TRA, LVP, ANONYMOUS
UUID assigned by the 3DS server to identify a single transaction for 3DS v2
3DS version in the format major.minor.patch
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Authentication method
The authentication method type. One of emv or three_ds.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Device manufacturer identifier
Cardholder name
The ID of the payment method. If this field is provided, you must also include either payment_consent or triggered_by. Requests that include payment_method.id without either of these fields are rejected with a validation_error.
Pay now information. This must be provided if type is set to pay_now
Payment channel. Use pos for POS transactions.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, googlepay, wechatpay, pay_now.
Wechatpay information. This must be provided if type is set to wechatpay
The specific WeChat Pay flow to use. One of webqr, jsapi, miniprog, inapp, mweb
Payment channel. Use pos for POS transactions.
Required when flow is miniprog
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Indicates who initiated the payment — the merchant or the customer. Only effective when payment_method.id is provided.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: If |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "amount": 100,> "currency": "USD",> "merchant_order_id": "D202503210001",> "request_id": "b01737e5-c5ab-4765-8834-cbd92dfeaf81",> "descriptor": "Airwallex - Test Descriptor",> "return_url": "https://www.airwallex.com",> "metadata": {> "foo": "bar"> }>}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "b01737e5-c5ab-4765-8834-cbd92dfeaf81",4 "amount": 100,5 "currency": "USD",6 "status": "REQUIRES_PAYMENT_METHOD",7 "merchant_order_id": "D202503210001",8 "return_url": "https://www.airwallex.com",9 "descriptor": "Airwallex - Test Descriptor",10 "metadata": {11 "foo": "bar"12 },13 "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiaW50ZW50X2lkIjoiaW50X2hrcGRza3o3dmcxeGM3dXNjZGoiLCJjdXN0b21lcl9pZCI6IjlmYWZjMmZiLTQyNjItNGZmOC1hMjA1LWQ2MGZiNDc4MWNiMCJ9.Rg1M2Vl0GDARU0rnTghenUVe9v1ix1IrSQOxQO7Zqyw",14 "created_at": "2025-01-31T06:57:10+0000",15 "updated_at": "2025-01-31T06:57:10+0000"16}
Retrieve a PaymentIntent
GET /api/v1/pa/payment_intents/{id}
Retrieve a PaymentIntent by unique identifier.
PaymentIntent unique identifier
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "0955e7df-0422-4766-b3b1-5aec5a0d6314",4 "amount": 100,5 "currency": "USD",6 "status": "SUCCEEDED",7 "merchant_order_id": "D202503210001",8 "descriptor": "Airwallex - Test Descriptor",9 "metadata": {10 "foo": "bar"11 },12 "created_at": "2025-01-31T06:57:10+0000",13 "updated_at": "2025-01-31T07:01:10+0000",14 "latest_payment_attempt": {15 "id": "att_hkpdskz7vg1xc7uscdj",16 "amount": 100,17 "currency": "USD",18 "payment_method": {19 "type": "card",20 "card": {21 "expiry_month": "03",22 "expiry_year": "2030",23 "name": "John Doe",24 "bin": "403550",25 "last4": "0008",26 "brand": "visa",27 "issuer_country_code": "US",28 "card_type": "CREDIT",29 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",30 "billing": {31 "first_name": "John",32 "last_name": "Doe",33 "email": "[email protected]",34 "phone_number": "+1 1234567890",35 "address": {36 "country_code": "US",37 "state": "CA",38 "city": "San Francisco",39 "street": "1460 Mission St.#02W101",40 "postcode": "94103"41 }42 },43 "issuer_name": "JPMorgan Chase",44 "is_commercial": false,45 "number_type": "PAN"46 }47 },48 "payment_intent_id": "int_hkpdskz7vg1xc7uscdj",49 "status": "AUTHORIZED",50 "payment_method_transaction_id": "1234567890",51 "provider_original_response_code": "00",52 "authorization_code": "123456",53 "captured_amount": 0,54 "created_at": "2025-01-31T07:02:15+0000",55 "updated_at": "2025-01-31T07:02:15+0000",56 "settle_via": "airwallex",57 "authentication_data": {58 "ds_data": {},59 "fraud_data": {60 "action": "ACCEPT",61 "score": "85",62 "risk_factors": []63 },64 "avs_result": "U",65 "cvc_result": "U"66 }67 }68}
Update a PaymentIntent
POST /api/v1/pa/payment_intents/{id}/update
Update properties on a PaymentIntent.
Some properties are only allowed to be updated in REQUIRES_PAYMENT_METHOD or REQUIRES_CUSTOMER_ACTION status. Depending on which properties you update and the status of PaymentIntent, you might need to confirm the PaymentIntent again. For example, updating the currency and amount in REQUIRES_CUSTOMER_ACTION status always requires you to confirm the PaymentIntent again.
The update behavior follows these principles:
1. Omitted fields in the request payload will be ignored and have no impact on the existing value.
2. Provided fields in the request payload will be merged to the existing data(except for array fields, it will be a full replacement).
3. Conditional fields can be nullified by passing a null value or empty value(for string type only).
PaymentIntent unique identifier
Unique request identifier specified by the merchant. Maximum length is 64.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
(Optional) Additional customer information to be sent to the external risk control system. This information may increase the success rate of your transactions if provided.
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
Payment amount. This is the order amount you would like to charge your customer. Please refer to supported currencies for supported minor units.
The unique identifier of the conversion quote to be applied to the intent.
Payment currency. Please refer to supported currencies .
Details of the customer making a payment for this Payment Intent. When customer_id is provided in the request you must leave this object empty unless you want to provide additional_info related to the customer for this payment.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the customer making a payment for this Payment Intent. This field is required if the Payment Intent is created for recurring payments. Leave this field empty if the customer is unknown (guest checkout) or if the customer details are provided via the customer object. If only additional_info is provided in the customer object for the Payment Intent, you can still include customer_id in the request.
Descriptor that will display to the customer. Maximum length is 32.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent. Maximum length is 64.
A set of key-value pairs that you can attach to the PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Purchase order related to the PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itinerary list
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount. The currency is the same as transaction currency.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
Tip information
The tip amount. This amount is included in the total amount.
Traveler list
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The web page URL or application scheme URI to redirect the customer after payment authentication.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/update' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "28f0a16f-4e97-4d77-a310-3cf7be2ba6ed",> "order": {> "shipping": {> "shipping_company": "Shipping Company",> "tracking_url": "https://www.example.com/tracking?id=1234567890",> "tracking_number": "1234567890"> }> }>}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "28f0a16f-4e97-4d77-a310-3cf7be2ba6ed",4 "amount": 100,5 "currency": "USD",6 "status": "REQUIRES_PAYMENT_METHOD",7 "merchant_order_id": "D202503210001",8 "order": {9 "shipping": {10 "shipping_company": "Shipping Company",11 "tracking_number": "1234567890",12 "tracking_url": "https://www.example.com/tracking?id=1234567890"13 }14 },15 "return_url": "https://www.airwallex.com",16 "descriptor": "Airwallex - Test Descriptor",17 "metadata": {18 "foo": "bar"19 },20 "created_at": "2025-01-31T06:57:10+0000",21 "updated_at": "2025-01-31T07:01:10+0000"22}
Confirm a PaymentIntent
POST /api/v1/pa/payment_intents/{id}/confirm
Call this endpoint when your customer is ready to make a payment as per the details in the PaymentIntent.
At a minimum, a PaymentMethod must be set as the funding source of the payment. This is done by providing a payment_method object when confirming the PaymentIntent.
PaymentIntent unique identifier
Unique request identifier specified by the merchant. Maximum length is 64.
Customer who intends to pay for the PaymentIntent
Client device information. It is recommended to provide this data to increase the odds of having frictionless 3DS.
Accept header value
Browser specific data
Is Java enabled?
Is JavaScript enabled?
User Agent header value
Device unique identifier or Advertisement unique identifier or IMEI
Public IP address, both IPv4 and IPv6 are supported.
Language or locale
Location data
Latitude
Longitude
Mobile specific data
Device model
OS type
OS version
Screen color depth in bits
Screen height in pixels
Screen width in pixels
Timezone offset to UTC in hours, with added minutes if necessary
Some merchants prefer to maintain the recurring payments on their own instead of using PaymentConsent. Providing this data indicates the request is an external recurring payment.
Only effective when payment_consent_reference is not present, and the payment_method.type must be one of card, applepay, googlepay.
The party who initiated this subsequent payment request. One of merchant, customer.
Set this to true if it is the initial transaction request in a recurring series.
Default: false.
Indicate if this subsequent payment is scheduled. Only applicable when triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: scheduled
The original transaction reference which can be provided to increase the odds of getting approved by issuer when triggered_by is merchant (not in customer's presence).
Do not pass this value when initial_payment is true or if you are not clear about the valid formats (as listed below).
- Visa (
card) - 15 digits unique ID Visa assigns to the response of the original authorization request, i.e.123456789012345 - Mastercard (
card) - 13 characters trace id (DE 63 Subfield 1 & 2 + DE 15) from the response of the original authorization request, i.e.MCC123ABC0101
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
When provided, it creates specified funds splits that are automatically released after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Reference to an existing PaymentConsent
Unique identifier of the PaymentConsent referenced for this recurring payment
For initial payment, or subsequent payments when next_triggered_by is customer, this attribute must be provided in order to confirm successfully
The PaymentMethod to use for the PaymentIntent.
ACH Direct Debit information.
9-digit number to identify a bank in the US. Required when verification method is micro_deposit. Should not be set when verification method is plaid
4-17 digits number to identify a bank account in the US. Required when verification method is micro_deposit. Should not be set when verification method is plaid
Indicate whether the account is a business account. Default to false.
The version of mandate language. Custom mandate version if you render your own mandate document to the payer instead of the default version provided by Airwallex.
Email of the account holder. Required when verification method is micro_deposit.
Name of the account holder. Required when verification method is micro_deposit.
Afterpay information. This must be provided if type is set to afterpay
Email address of the shopper.
Billing information.
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
First name of the customer
Last name of the customer
Phone number of the customer
Alframart information. This must be provided if type is set to alfamart
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
AlipayCN information. This must be provided if type is set to alipaycn
One of webqr, mweb, inapp, miniprog.
Required when flow is mweb, inapp or miniprog. One of ios, android.
AlipayHK information. This must be provided if type is set to alipayhk
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Applepay information. This must be provided if type is set to applepay
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
Payment data from ApplePayPaymentToken
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Authentication method
The authentication method type. One of emv or three_ds.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Device manufacturer identifier
Cardholder name
Atome information. This must be provided if type is set to atome
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
Required when verification method is micro_deposit. Should not be set when verification method is truelayer
Account holder's address. Required when verification method is micro_deposit.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. Required when verification method is truelayer. Should not be set when verification method is micro_deposit
Indicate whether the account is a business account. Default to false.
The version of mandate language. Custom mandate version if you render your own mandate document to the payer instead of the default version provided by Airwallex.
Email of the account holder. Required when verification method is micro_deposit.
Name of the account holder. Required when verification method is micro_deposit.
6-digit number to identify a bank in the UK. Required when verification method is micro_deposit. Should not be set when verification method is truelayer
Bancontact information. This must be provided if type is set to bancontact
The name of the shopper. Must be between 3 and 100 characters in length.
Bank Transfer information. This must be provided if type is set to bank_transfer
The name of the bank. Supported banks are:
ID: mandiri, danamon, cimb_niaga, permata, maybank, bri, bni.
You can call API to retrieve the available bank names
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The type of GA mode. One of PAYMENT_GA, PAYER_GA
Email address of the shopper.
The name of the shopper.
The type of Transfer. One of SWIFT, LOCAL, BOTH
BECS Direct Debit information. This must be provided if type is set to becs_direct_debit
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Account holder's email.
Account holder name.
Indicate whether the account is a business account. Default to false.
The version of mandate language. Custom mandate version if you render your own mandate document to the payer instead of the default version provided by Airwallex.
BitPay information. This must be provided if type is set to bitpay
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper. Must be between 3 and 100 characters in length.
BLIK information. This must be provided if type is set to blik
The name of the shopper. Must be between 3 and 100 characters in length.
Boost information. It takes effect when type is set to boost
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information. This must be provided if type is set to card
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Additional information of external network token requestor. Should be provided when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
CVC code of this card. Required for all transactions except merchant initiated transactions and network tokenized transactions
Information for Korean Card
Card password first 2 digits.
A 10-digit business number of the company. Either business_number or date_of_birth must be provided.
A 6-digit date of birth in the format of YYMMDD. Either business_number or date_of_birth must be provided.
Card holder name. Maximum length is 128.
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN. Default: PAN
Information required for card-present transactions. This must be provided if type is set to card_present
Cardholder verification method.
offline_pin: The PIN is verified offline by the EMV chip card.online_pin: The PIN is encrypted and verified online by issuers or card schemes.encrypted_pinis required foronline_pin.manual_signature: The cardholder signature on the receipt is compared to the signature on the back of the card.no_cvm: No verification needed.cdcvm: Cardholder device verification method. The cardholder is verified using a device's authentication method.offline_pin_and_signature: Both an offline PIN and a manual signature are used to verify the cardholder.skipped: Verification process was bypassed.
The way the terminal reads the card information.
manual_entry: Manually keyed into POS terminal.chip: Read from direct contact with a chip card.magstripe: Read from direct contact with magnetic stripe card.contactless_chip: Read from a contactless interface using chip data.contactless_magstripe: Read from a contactless interface using magnetic stripe data (MSD).
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Encrypted personal identification number. Required when cardholder_verification_method is online_pin.
Two digit number representing the card’s expiration month. Required when pan_entry_mode is manual_entry.
Four digit number representing the card’s expiration year. Required when pan_entry_mode is manual_entry.
The default is false. Set to true when:
- Chip card at a chip-capable terminal was unable to process transactions using data on the chip or magnetic strip and use entry mode
manual. - Chip card at a chip-capable terminal was unable to process transactions using data on the chip and use entry mode
contact_magnetic_stripe_card.
Fallback reason applicable when fallback is true.
Set to chip_read_failure when all of the following conditions are met:
- The transaction is initiated at a chip-capable terminal.
pan_entry_modeismagstripe.- The previous transaction initiated by the terminal was an unsuccessful chip read.
Key serial number while using DUKPT for PIN encryption.
Card number. Required when pan_entry_mode is manual_entry.
Track 1 read from magnetic stripe card
Track 2 is read from a magnetic stripe card or is track 2 equivalent data get from the chip card.
Track 2 is required when pan_entry_mode is not manual_entry.
cash app pay information. This must be provided if type is set to cash_app_pay
The specific CashAppPay flow to use. Only webqr, mweb and inapp
Dana information. This must be provided if type is set to dana
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Doku E-Wallet information. This must be provided if type is set to doku_ewallet
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
Dragonpay information. It takes effect when type is set to dragonpay
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information. It takes effect when type is set to duit_now
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada. Required when verification method is micro_deposit. Should not be set when verification method is plaid
Indicate whether the account is a business account. Default to false.
3-digit number to identify a institution in Canada. Required when verification method is micro_deposit.Should not be set when verification method is plaid
The version of mandate language. Custom mandate version if you render your own mandate document to the payer instead of the default version provided by Airwallex.
Email of the account holder. Required when verification method is micro_deposit.
Name of the account holder. Required when verification method is micro_deposit.
5-digit number to identify a bank in Canada. Required when verification method is micro_deposit. Should not be set when verification method is plaid
EPS information. It takes effect when type is set to eps
The name of the shopper.
ESUN information. It takes effect when type is set to esun
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information. It takes effect when type is set to family_mart
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information. This must be provided if type is set to fps
The specific FPS flow to use. Currently only support webqr.
FPX Transfer information. This must be provided if type is set to fpx
The name of the bank. One of affin, agrobank, alliance, ambank, bank_islam, muamalat, rakyat, bsn, cimb_clicks, hong_leong, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob.
You can call API to retrieve the available bank names
Email address of the shopper.
The name of the shopper
Phone number of the shopper.
Gcash information. This must be provided if type is set to gcash
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
GoPay information. It takes effect when type is set to go_pay
The name of the shopper.
Googlepay information. This must be provided if type is set to googlepay
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the customer
First name of the customer. Maximum length is 128.
Last name of the customer. Maximum length is 128.
Phone number of the customer
A UTF-8 encoded, serialized JSON object with the keys specified.
Authentication data from an external 3D-Secure provider. Only applicable when Google Pay PAN_ONLY authentication method is used.
Authentication value, will be used to provide proof of authentication for 3DS v2
UUID assigned by the Directory Server to identify a single transaction for 3DS v2
Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder
Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of TRA, LVP, ANONYMOUS
UUID assigned by the 3DS server to identify a single transaction for 3DS v2
3DS version in the format major.minor.patch
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Card number
Authentication method
The authentication method type. One of emv or three_ds.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Device manufacturer identifier
Cardholder name
GrabPay information. It takes effect when type is set to grabpay
The name of the shopper.
Hi-Life information. It takes effect when type is set to hi_life
Email address of the shopper
The name of the shopper.
Phone number of the shopper
The unique identifier of the payment method. If this field is provided, you must also include either payment_consent or triggered_by. Requests that include payment_method.id without either of these fields are rejected with a validation_error.
iDEAL information. It takes effect when type is set to ideal
The name of the bank. One of rabobank, abn_amro, van_lanschot_kempen, triodos, ing, sns, asn, regiobank, knab, bunq, revolut, yoursafe, n26, nationale_nederlanden, buut.
The name of the shopper.
Indomaret information. This must be provided if type is set to indomaret
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
JeniusPay information. This must be provided if type is set to jenius_pay
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
Kakaopay information. This must be provided if type is set to kakaopay
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Klarna information. This must be provided if type is set to klarna
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US, NZ
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information. This must be provided if type is set to konbini
Email address of the shopper.
The name of the shopper.
Phone number of the shopper. Must be 10-11 digits of numbers.
LinkAja information. This must be provided if type is set to linkaja
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
Maxima information. This must be provided if type is set to maxima
The name of the shopper. Must be between 3 and 100 characters in length.
Multibanco information. This must be provided if type is set to multibanco
The name of the shopper. Must be between 3 and 100 characters in length.
MyBank information. This must be provided if type is set to mybank
The name of the shopper. Must be between 3 and 100 characters in length.
Narvesen information. This must be provided if type is set to narvesen
The name of the shopper. Must be between 3 and 100 characters in length.
Octopus method information. It takes effect when type is set to octopus
Payment channel. Use pos for POS transactions.
Payment flow type. One of webqr, mweb, inapp. Required when channel is not pos.
OS type. Required when flow is inapp or mweb. One of ios, android.
Online Banking information. This must be provided if type is set to online_banking
The 2-letter ISO country/region code from which the consumer will be paying. One of: TH, EE, LV, LT, VN, ID, PH, KR
The name of the bank. Supported banks are:
TH: bangkok, krungsri, krungthai, siam_commercial, kasikorn.
EE: citadele, lhv, seb, luminor, revolut, swedbank, coop, n26.
LV: swedbank, seb, luminor, citadele, revolut, n26.
LT: swedbank, seb, luminor, revolut, siauliu, citadele, medicinos, lithuanian_credit_union.
ID: permatanet, muamalat_id, cimb_clicks, danamon, bca, bri.
VN: techcombank, vietinbank, bidv, sacombank, vietcombank, military_bank, agribank, oceanbank, shb, vib, maritime, eximbank, namabank, saigonbank, vietabank, vpbank, tien_phong, seabank, pgbank, gpbank, bacabank, abbank, dongabank, acb, hdbank, navibank, ocb, lvpb, bao_viet.
PH: bpi.
You can call API to retrieve the available bank names
Email address of the shopper. Required when country_code is EE, LV, LT, VN or ID.
The name of the shopper. Required when country_code is EE, LV, LT, VN or ID.
Phone number of the shopper. Required when country_code is EE, LV, LT, VN or ID.
OVO information. It takes effect when type is set to ovo
Email address of the shopper.
The name of the shopper. If provided, it must be between 3 and 100 characters in length.
P24 information. This must be provided if type is set to p24
Email address of the shopper.
The name of the shopper. Must be between 3 and 100 characters in length.
PayNow information. It takes effect when type is set to pay_now
Payment channel. Use pos for POS transactions.
The name of the shopper.
Pay by Bank app information. This must be provided if type is set to paybybankapp
The name of the shopper. Must be between 3 and 100 characters in length.
PayEasy information. This must be provided if type is set to payeasy
Email address of the shopper
The name of the shopper
Phone number of the shopper. Must be 10-11 digits of numbers.
PayPal information. It takes effect when type is set to paypal
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
PayPost information. This must be provided if type is set to paypost
The name of the shopper.
paysafecard information. This must be provided if type is set to paysafecard
The 2-letter ISO country/region code from which the consumer will be paying. One of: AT, BE, CA, CH, CY, CZ, DK, ES, FR, GB, GR, HR, HU, IE, IT, LU, LT, MT, NL, PL, PT, RO, SE, SI, SK
The name of the shopper.
Email address of the shopper.
Paysafecash information. This must be provided if type is set to paysafecash
The 2-letter ISO country/region code from which the consumer will be paying. One of: AT, BE, CA, CH, CY, CZ, DK, ES, FR, GB, GR, HR, HU, IE, IT, LU, LT, MT, NL, PL, PT, RO, SE, SI, SK.
Email address of the shopper.
The name of the shopper.
Paysera information. This must be provided if type is set to paysera
The name of the bank. One of: citadele, n26, revolut, swedbank, lhv, luminor, seb.
The 2-letter ISO country/region code from which the consumer will be paying. Available values including all EEA countries.
The name of the shopper. Must be between 3 and 100 characters in length.
Payto information. This must be provided if type is set to payto
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
Payer name of the PayId.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information. This must be provided if type is set to payu
The name of the shopper. Must be between 3 and 100 characters in length.
Perlas terminals information. This must be provided if type is set to perlas_terminals
The name of the shopper. Must be between 3 and 100 characters in length.
PromptPay information. It takes effect when type is set to prompt_pay
The name of the shopper.
Rabbit LINE Pay information. This must be provided if type is set to rabbit_line_pay
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Satispay information. This must be provided if type is set to satispay
The 2-letter ISO country/region code from which the consumer will be paying. One of BE, DE, FR, IT, LU
The name of the shopper. Must be between 3 and 100 characters in length.
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. Required when verification method is truelayer. You can call API to retrieve the available bank names.
Indicate whether the account is a business account. Default to false.
The 2-letter ISO country/region code of the bank account. Required when verification method is truelayer. One of GB, AT, BE, DE, ES, FI, FR, IE, IT, LT, NL, PL, PT, SE.
IBAN of the bank account. Required when verification method is micro_deposit. Should not be set when verification method is truelayer
The version of mandate language. Custom mandate version if you render your own mandate document to the payer instead of the default version provided by Airwallex.
Email of the account holder. Required when verification method is micro_deposit.
Name of the account holder. Required when verification method is micro_deposit.
7-Eleven information. It takes effect when if type is set to seven_eleven
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Shopee Pay information. It takes effect when type is set to shopee_pay
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information. This must be provided if type is set to skrill
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper. Should be in the format <firstname><space><lastname>. The minimum length of lastname is two characters and the minimum length of the entire string is five characters.
Tabby method information. This must be provided if type is set to tabby
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can choose ar.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
Tng information. This must be provided if type is set to tng
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Truemoney information. This must be provided if type is set to truemoney
One of webqr, mweb, inapp.
Required when flow is mweb or inapp. One of ios, android.
Trustly information. This must be provided if type is set to trustly
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
The name of the shopper.
Email address of the shopper.
Type of the PaymentMethod. One of card, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, linkaja, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, eft_direct_debit, zip, afterpay, tabby, wero, spaylater, jkopay, affirm, octopus, bizum, swish.
Verkkopankki information. This must be provided if type is set to verkkopankki
The name of the bank. One of aktia, danske, handelsbanken, nordea, osuuspankki, pop_pankki, s_pankki, saastopankki, tapiola, alandsbanken.
Email address of the shopper.
The name of the shopper.
WeChat Pay information. This must be provided if type is set to wechatpay
The specific WeChat Pay flow to use. One of webqr, jsapi, miniprog, inapp, mweb
Payment channel. Use pos for POS transactions.
Required when flow is miniprog
Zip information. This must be provided if type is set to zip
The name of the shopper. Must be between 3 and 100 characters in length.
Options for PaymentMethod
The PaymentMethod options for ACH Direct Debit
Verification method. Can be plaid or micro_deposit. Default: micro_deposit
The PaymentMethod options for Afterpay
Whether the PaymentIntent should be automatically captured after authorization. Defaults to true.
The PaymentMethod options for BACS Direct Debit
Verification method. Can be truelayer or micro_deposit. Default: micro_deposit
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true. Set it to false if you want to capture the funds sometimes later.
The cryptogram value. Must be provided if card.number_type is EXTERNAL_NETWORK_TOKEN. Maximum length is 28.
Authentication data from an external 3D-Secure provider (3RI for MIT subsequent transaction)
Authentication value, will be used to provide proof of authentication for 3DS v2
UUID assigned by the Directory Server to identify a single transaction for 3DS v2
Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder
Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of TRA, LVP, ANONYMOUS
UUID assigned by the 3DS server to identify a single transaction for 3DS v2
3DS version in the format major.minor.patch
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Three Domain Secure
3DS ACS response (application/x-www-form-urlencoded)
Device data collection response (deprecated in favor of acs_response)
3DS transactionId (deprecated in favor of acs_response)
Return URL for 3ds callbacks (in case 3ds is triggered)
The PaymentMethod options for EFT Direct Debit
Verification method. Only supports micro_deposit.
The PaymentMethod options for Klarna
Whether the PaymentIntent should be automatically captured after authorization. Defaults to false.
The PaymentMethod options for SEPA Direct Debit
Verification method. Can be truelayer or micro_deposit. Default: micro_deposit
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
The web page URL or application scheme URI to redirect the customer after payment authentication or cancellation.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e",> "payment_method": {> "type": "card",> "card": {> "number": "4035501000000008",> "expiry_month": "03",> "expiry_year": "2030",> "name": "John Doe",> "cvc": "737",> "three_ds": {> "return_url": "https://www.airwallex.com"> },> "billing": {> "email": "[email protected]",> "phone_number": "+1 1234567890",> "first_name": "John",> "last_name": "Doe",> "address": {> "country_code": "US",> "city": "San Francisco",> "state": "CA",> "street": "1460 Mission St.#02W101",> "postcode": "94103"> }> }> }> },> "return_url": "https://www.airwallex.com">}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e",4 "amount": 100,5 "currency": "USD",6 "status": "SUCCEEDED",7 "merchant_order_id": "D202503210001",8 "descriptor": "Airwallex - Test Descriptor",9 "metadata": {10 "foo": "bar"11 },12 "created_at": "2025-01-31T06:57:10+0000",13 "updated_at": "2025-01-31T07:02:15+0000",14 "latest_payment_attempt": {15 "id": "att_hkpdskz7vg1xc7uscdj",16 "amount": 100,17 "currency": "USD",18 "payment_method": {19 "type": "card",20 "card": {21 "expiry_month": "03",22 "expiry_year": "2030",23 "name": "John Doe",24 "bin": "403550",25 "last4": "0008",26 "brand": "visa",27 "issuer_country_code": "US",28 "card_type": "CREDIT",29 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",30 "billing": {31 "first_name": "John",32 "last_name": "Doe",33 "email": "[email protected]",34 "phone_number": "+1 1234567890",35 "address": {36 "country_code": "US",37 "state": "CA",38 "city": "San Francisco",39 "street": "1460 Mission St.#02W101",40 "postcode": "94103"41 }42 },43 "issuer_name": "JPMorgan Chase",44 "is_commercial": false,45 "number_type": "PAN"46 }47 },48 "payment_intent_id": "int_hkpdskz7vg1xc7uscdj",49 "status": "AUTHORIZED",50 "payment_method_transaction_id": "1234567890",51 "provider_original_response_code": "00",52 "authorization_code": "123456",53 "captured_amount": 0,54 "created_at": "2025-01-31T07:02:15+0000",55 "updated_at": "2025-01-31T07:02:15+0000",56 "settle_via": "airwallex",57 "authentication_data": {58 "ds_data": {},59 "fraud_data": {60 "action": "ACCEPT",61 "score": "85",62 "risk_factors": []63 },64 "avs_result": "U",65 "cvc_result": "U"66 }67 }68}
Continue to confirm a PaymentIntent
POST /api/v1/pa/payment_intents/{id}/confirm_continue
In certain scenarios (i.e. 3DS and DCC), customer is required to provide additional information multiple times after the initial confirmation request.
PaymentIntent unique identifier
Unique request identifier specified by the merchant. Maximum length is 64.
PIN data to continue a card-present transaction, required only if type = submit_card_pin_data
Encrypted personal identification number.
Key serial number while using DUKPT for PIN encryption.
The verification request of micro-deposit
The amounts of the micro-deposit in the shopper’s bank statement. Please refer to supported currencies for supported minor units.
Three Domain Secure object, required only if type is 3ds_continue
3DS ACS response (application/x-www-form-urlencoded)
Device data collection response (deprecated in favor of acs_response)
3DS transactionId (deprecated in favor of acs_response)
Return URL for 3ds callbacks (in case 3ds is triggered)
Type of the continue type. One of 3ds_continue, verify_micro_deposits
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm_continue' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6",> "type": "verify_micro_deposits",> "micro_deposit": {> "amounts": [> 0.01,> 0.02> ]> }>}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6",4 "amount": 100,5 "currency": "USD",6 "status": "PENDING",7 "merchant_order_id": "D202503210001",8 "return_url": "https://www.airwallex.com",9 "descriptor": "Airwallex - Test Descriptor",10 "created_at": "2025-01-31T06:57:10+0000",11 "updated_at": "2025-01-31T06:57:10+0000",12 "latest_payment_attempt": {13 "id": "att_hkpdskz7vg1xc7uscdj",14 "amount": 100,15 "currency": "USD",16 "payment_method": {17 "id": "mtd_hkpd5jjp8h6bg6x8lpn",18 "type": "sepadirectdebit",19 "sepa_direct_debit": {20 "iban": "DE012345678901234567890",21 "owner_name": "John Doe",22 "owner_email": "[email protected]",23 "micro_deposit": {24 "status": "VERIFIED"25 },26 "business_account": false27 },28 "status": "CREATED",29 "created_at": "2023-10-01T12:00:00+0000",30 "updated_at": "2023-10-01T12:01:00+0000"31 },32 "payment_intent_id": "int_hkpdskz7vg1xc7uscdj",33 "status": "PENDING_AUTHORIZATION",34 "payment_method_transaction_id": "1234567890",35 "provider_original_response_code": "00",36 "authorization_code": "123456",37 "captured_amount": 0,38 "created_at": "2025-01-31T07:02:15+0000",39 "updated_at": "2025-01-31T07:02:15+0000",40 "settle_via": "airwallex",41 "authentication_data": {42 "ds_data": {},43 "fraud_data": {44 "action": "ACCEPT",45 "score": "85",46 "risk_factors": []47 },48 "avs_result": "U",49 "cvc_result": "U"50 }51 }52}
Capture a PaymentIntent
POST /api/v1/pa/payment_intents/{id}/capture
Capture funds that have been confirmed but have not yet been captured or have only been captured partially. A PaymentIntent is capturable if auto_capture=false and its next_action indicates that capture is required.
PaymentIntent unique identifier
Unique request identifier specified by the merchant. Maximum length is 64.
Amount to capture. Please refer to supported currencies for supported minor units.
When provided, it creates specified funds splits that are automatically released after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/capture' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "amount": 100,> "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268">}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268",4 "amount": 100,5 "currency": "USD",6 "status": "SUCCEEDED",7 "merchant_order_id": "D202503210001",8 "descriptor": "Airwallex - Test Descriptor",9 "metadata": {10 "foo": "bar"11 },12 "created_at": "2025-01-31T06:57:10+0000",13 "updated_at": "2025-01-31T07:01:10+0000",14 "latest_payment_attempt": {15 "id": "att_hkpdskz7vg1xc7uscdj",16 "amount": 100,17 "currency": "USD",18 "payment_method": {19 "type": "card",20 "card": {21 "expiry_month": "03",22 "expiry_year": "2030",23 "name": "John Doe",24 "bin": "403550",25 "last4": "0008",26 "brand": "visa",27 "issuer_country_code": "US",28 "card_type": "CREDIT",29 "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==",30 "billing": {31 "first_name": "John",32 "last_name": "Doe",33 "email": "[email protected]",34 "phone_number": "+1 1234567890",35 "address": {36 "country_code": "US",37 "state": "CA",38 "city": "San Francisco",39 "street": "1460 Mission St.#02W101",40 "postcode": "94103"41 }42 },43 "issuer_name": "JPMorgan Chase",44 "is_commercial": false,45 "number_type": "PAN"46 }47 },48 "payment_intent_id": "int_hkpdskz7vg1xc7uscdj",49 "status": "AUTHORIZED",50 "payment_method_transaction_id": "1234567890",51 "provider_original_response_code": "00",52 "authorization_code": "123456",53 "captured_amount": 0,54 "created_at": "2025-01-31T07:02:15+0000",55 "updated_at": "2025-01-31T07:02:15+0000",56 "settle_via": "airwallex",57 "authentication_data": {58 "ds_data": {},59 "fraud_data": {60 "action": "ACCEPT",61 "score": "85",62 "risk_factors": []63 },64 "avs_result": "U",65 "cvc_result": "U"66 }67 }68}
Cancel a PaymentIntent
POST /api/v1/pa/payment_intents/{id}/cancel
A PaymentIntent can be cancelled when it is in one of these statuses: REQUIRES_PAYMENT_METHOD, REQUIRES_CUSTOMER_ACTION, REQUIRES_CAPTURE.
Any outstanding, un-captured funds will be refunded once cancelled.
PaymentIntent unique identifier
Unique request identifier specified by the merchant. Maximum length is 64.
The reason for canceling the PaymentIntent
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the CAPTURE_REQUESTED or SETTLED status.
Amount of the PaymentAttempt
Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result
The method used to authenticate this transaction. Possible values: passkey, 3ds, none.
AVS result.
CVC result.
3DS data.
Cardholder Authentication Verification Value. Base64-encoded 28-character string.
Challenge cancellation reason
Electronic Commerce Indicator. As defined by 3D-Secure.
00: Mastercard variant: Authentication failed.01: Mastercard variant: Authentication attempted.02: Mastercard variant: Authentication succeeded.04: Mastercard variant: Frictionless authentication via data only mode.05: Authentication succeeded.06: Authentication attempted. Mastercard variant: Exempted from Strong Customer Authentication.07: Authentication failed or exempted. Mastercard variant: Recurring transaction successfully authenticated.null: Not applicable or 3DS authentication was not performed.
Indicates whether the cardholder is enrolled in 3D-Secure.
Y: Cardholder is enrolled.N: Cardholder is not enrolled.U: Unable to determine enrollment status.null: Not applicable or enrollment check was not performed.
Indicates whether 3DS passed in frictionless flow.
Y: 3DS passed in frictionless flow.N: 3DS entered challenge flow.null: Not applicable or 3DS authentication was not performed.
Indicates whether liability has shifted to the card issuer.
Y: Liability has shifted to the issuer.N: Liability has not shifted.null: Not applicable or unable to determine.
Payment Authentication Response (PARes) status.
Y: Authentication successful.N: Authentication failed.U: Authentication could not be performed.A: Authentication attempted but not completed.C: Challenge required.R: Authentication rejected.null: Not applicable or authentication was not performed.
3ds version
XID
Fraud data.
Fraud action
Risk factors
Risk factor description
Fraud score
Status of payment passkey setup for the card/device used in the transaction, during cardholder authentication. Possible values: SETUP_COMPLETED, ALREADY_SETUP, FAILED_TO_SETUP, NOT_TRIGGERED
SETUP_COMPLETED: Payment passkey was successfully set up.ALREADY_SETUP: Payment passkey was already set up for this card/device combination in a previous transaction.FAILED_TO_SETUP: Attempted to set up a payment passkey, but the setup failed.NOT_TRIGGERED: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow).
SCA exemption indicators for this transaction.
The SCA exemption type actually applied by Airwallex in the authorization request sent downstream. If this field is null, SCA exemption was not applied. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT.
The SCA exemption type requested by the merchant for Airwallex to use. Possible values: LOW_RISK_TRANSACTION, LOW_VALUE, SECURE_CORPORATE_PAYMENT, ANONYMOUS.
Captured amount
Time at which this PaymentAttempt was created
Currency of the PaymentAttempt
Present when DCC amount is available and DCC currency is different from PaymentIntent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product
DCC amount
DCC currency
PaymentAttempt failure code. One of authentication_failed, capture_failed, authorization_failed, provider_unavailable, system_unavailable, fraud_rejected
Failure details. Only applicable when status is FAILED.
The failure code returned by Airwallex
Additional details that may include original_response_code, original_response_message from provider, and other contextual information such as card details, risk factors, etc. depending on the specific error code.
The failure description.
The unique identifier for tracing the failure.
Unique identifier for the PaymentAttempt
An advice code from issuer to provide more details about the payment. It can be useful when implementing a retry logic for declined payments.
Merchant order unique identifier of the PaymentAttempt
PaymentConsent unique identifier of the PaymentAttempt
PaymentIntent unique identifier of the PaymentAttempt
PaymentMethod used by the PaymentAttempt
ACH Direct Debit information.
9-digit number to identify a bank in the US.
4-17 digits number to identify a bank account in the US.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
AirwallexPay information.
Name of the payer. Only returned for successful payments.
Alfamart information.
Email address of the shopper.
The name of the shopper.
Alipay CN information.
One of webqr, mweb, inapp, miniprog
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Alipay HK information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Apple pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
Atome information.
Customer's mobile number, formatted in E.164 standard.
BACS Direct Debit information.
8 digits number to identify a bank account in the UK.
Account holder's address.
House number and street name, e.g., 777 Casino Drive
Postcode of the address.
Post town.
Country code of the address. Use the two-character ISO Standard Country Codes. One of GB, US. Default to GB if not provided
Locality name, e.g., Apartment 123
State or province of the address. Should be provided if country code is US. Use the two-character ISO3166-2:US state code.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
6-digit number to identify a bank in the UK.
Bancontact information.
The name of the shopper.
Bank Transfer information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Expiry time of this attempt, in ISO-8601 format
The type of GA mode.
Email address of the shopper.
The name of the shopper.
BECS Direct Debit information.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
Indicate whether the account is a business account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Account holder's email.
Account holder name.
BitPay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
BLIK information.
The name of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Card information
Additional information of external network token requestor. Would return when number_type is EXTERNAL_NETWORK_TOKEN
Merchant Verification Value (Provided by VISA during onboarding) or MasterCard Assigned ID (Provided by MasterCard during onboarding)
Token requestor unique identifier (Provided by card schemes during onboarding)
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
Bank identify number of this card
Brand of the card. One of mastercard, visa, union pay, american express, jcb, discover, diners club international.
Funding type of the card
Specifies if card information got updated
Expiry was updated (true or false)
Account number was updated (true or false)
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Information for Korean Card
A 10-digit business number of the company.
A 6-digit date of birth in the format of YYMMDD.
Card password first 2 digits.
Last four digits of the card number
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Card holder name
Type of the number. One of PAN, EXTERNAL_NETWORK_TOKEN, AIRWALLEX_NETWORK_TOKEN.
Card-present information
Application Identifier (AID) of the card.
Bank identify number of this card
Brand of the card
A unique identifier to distinguish among separate cards having the save PAN.
Funding type of the card
Cardholder verification method.
Contactless Card Form Factor.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Whether fallback happens when reading the card.
Fallback reason.
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Card holder name
The way the terminal reads the card information.
Data used for receipt printing of the transaction.
Retrieval reference number of the transaction.
System trace audit number of the transaction.
Terminal verification result (EMV tag 95) of the transaction.
Data obtained by the POS terminal from the card and terminal properties.
Describe the capability of the terminal device to accept PIN.
unsupported: Terminal does not have PIN entry capability.supported: Terminal has PIN entry capability. Except the case suitable for software_based.software_based: For a mobile POS device, a user can input PIN through software-based keyboard.disabled: Terminal has PIN entry capability but PIN pad is not currently operative.
List of pan_entry_modes supported by the terminal.
An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system.
Indicate whether the POS terminal is a mobile POS device. Default is false.
Indicate whether the POS terminal could respond to a request_pin action. Default is false.
Type of the POS terminal that processes this payment.
attended_pos: dedicated pos devices that attended by a merchant staff.unattended_pos: dedicated pos devices that not attended.android_softpos: android mobile devices that can work as pos device with software.ios_softpos: iOS mobile devices that can work as pos device with software.
Indicate whether the reader is embedded in a mobile POS device. Default is true.
Time at which the PaymentMethod was created
Customer id
Dana information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Doku E-Wallet information.
Email address of the shopper.
The name of the shopper.
Dragonpay information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
DuitNow information.
The name of the shopper.
EFT Direct Debit information.
4-17 digits number to identify a bank account in Canada.
Indicate whether the account is a business account.
3-digit number to identify a bank institution in Canada.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
Identify a bank branch transit in Canada.
EPS information.
The name of the shopper.
ESUN information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FamilyMart information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
FPS information.
The specific FPS flow to use. Currently only support webqr.
FPX information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Gcash information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
GoPay information.
The name of the shopper.
Google pay information.
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The Lifecycle Identifier is a unique code that links all related transaction events - Capture, refund & disputes, making it easy to track a transaction throughout its lifecycle. This identifier is currently supported only when the card brand is MasterCard.
Type of the payment data details. One of tokenized_card or encrypted_payment_token.
Payment data with the tokenized card details.
Two digit number representing the card’s expiration month
Four digit number representing the card’s expiration year
Authentication method
The authentication method type. One of CRYPTOGRAM_3DS, PAN_ONLY.
EMV data
Output from the Secure Element
The PIN encrypted using the bank’s key
3D-Secure authentication data
Online payment cryptogram, as defined by 3-D Secure
Electronic Commerce Indicator, as defined by 3-D Secure
Bank identify number of this card
Brand of the card. One of visa, mastercard, maestro, chinaunionpay.
Device manufacturer identifier
Fingerprint of the card
A boolean field referring whether the card is commercial or not
Country code of the card issuer
Issuer name
Last four digits of the card number
Cardholder name
The card's type of payment. One of credit or debit.
GrabPay information.
The name of the shopper.
Hi-Life information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Unique identifier for the PaymentMethod
iDEAL information.
The name of the bank.
The name of the shopper.
Indomaret information.
Email address of the shopper.
The name of the shopper.
JeniusPay information.
Email address of the shopper.
The name of the shopper.
Kakaopay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Klarna information.
The ISO 3166 alpha-2 standard country/region code from which the consumer will be paying. One of AT, BE, CH, CZ, DE, DK, ES, FI, FR, GB, GR, IE, IT, NL, NO, PL, PT, SE, US
Billing information
The billing address as it appears on the credit card issuer’s records
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Date of birth of the customer in the format: YYYY-MM-DD
Email address of the customer
First name of the customer
Last name of the customer
Phone number of the customer
The ISO 639-1 alpha-2 language code. Default value is en. Besides en, you can specify other local languages (see below) for some countries to render the payment page.
AT: de; BE: be, nl, fr; CH: it, de, fr; CZ: cs; DE: de; DK: da; ES: es; FI: fi, sv; FR: fr; GR: el; IT: it; NL: nl; NO: nb; PL: pl; PT: pt; SE: sv; US: es
Konbini information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
LinkAja information.
Email address of the shopper.
The name of the shopper.
Maxima information.
The name of the shopper.
A set of key-value pairs that you can attach to the PaymentMethod. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Multibanco information.
The name of the shopper.
MyBank information.
The name of the shopper.
Narvesen information.
The name of the shopper.
Online Banking information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
OVO information.
Email address of the shopper.
The name of the shopper.
P24 information.
Email address of the shopper.
The name of the shopper.
PayNow information.
The payment channel.
The name of the shopper.
Pay by Bank app information.
The name of the shopper.
PayEasy information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
PayPal information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Paypost information.
The name of the shopper.
paysafecard information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysafecash information.
The 2-letter ISO country/region code from which the consumer will be paying.
Email address of the shopper.
The name of the shopper.
Paysera information.
The name of the bank.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper.
Payto information
The account name.
4-9 digits number to identify a bank account in Australia.
6-digit Bank-State-Branch number.
The PayID of the recipient.
11 digits number to identify the PayId. Required when phone_number, owner_email, and organisation_id is null.
The organisation id of the recipient. The PayID must be in the format of payid:airwallex.com.
owner email to identify the PayId. Required when phone_number, australian_business_number, and organisation_id is null.
The phone number of the PayId. Required when owner_email, australian_business_number, and organisation_id is null.
PayU information.
The name of the shopper.
Perlas terminals information.
The name of the shopper.
PromptPay information.
The name of the shopper.
Rabbit LINE Pay information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Satispay information.
The 2-letter ISO country/region code from which the consumer will be paying.
The name of the shopper
SEPA Direct Debit information.
Account holder's address.
Postcode of the address.
street of the address.
town of the address.
Country code of the address. Use the two-character ISO Standard Country Codes.
Bank of the account. You can call API to retrieve the available bank names.
Indicate whether the account is a business account.
The 2-letter ISO country/region code from which the consumer will be paying.
15–34 characters to identify a bank account.
The result of micro debit.
The status of micro_debit.
The result of micro deposit.
The status of micro_deposit.
Email of the account holder.
Name of the account holder.
7-Eleven information.
Email address of the shopper.
The name of the shopper.
Phone number of the shopper.
Boost information.
Email address of the shopper
The name of the shopper.
Phone number of the shopper
Skrill information.
The 2-letter ISO country/region code from which the consumer will be paying. Applicable worldwide except for blacklisted countries. For the forbidden countries, please refer to Skrill Non-serviced Countries
Email address of the shopper.
The name of the shopper.
Status of the PaymentMethod. One of CREATED, DISABLED
Tabby information
The ISO 639-1 alpha-2 language code.
The email of the shopper.
The name of the shopper.
The phone of the shopper.
TNG information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Truemoney information.
One of webqr, mweb, inapp
ios, android
Alipay's User LoginId (Shopper) for Payment Consent Verification
Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified.
Trustly information.
The 2-letter ISO country/region code from which the consumer will be paying. One of DE, DK, EE, ES, FI, GB, LT, LV, NL, NO, PL, SE, SK.
Email address of the shopper.
The name of the shopper.
Type of the PaymentMethod. One of card, card_present, applepay, wechatpay, alipaycn, alipayhk, googlepay, gcash, dana, kakaopay, tng, truemoney, rabbit_line_pay, family_mart, hi_life, esun, boost, shopee_pay, fpx, bank_transfer, alfamart, doku_ewallet, grabpay, indomaret, konbini, online_banking, payeasy, seven_eleven, skrill, eps, bancontact, ideal, multibanco, p24, trustly, dragonpay, blik, mybank, paybybankapp, verkkopankki, maxima, narvesen, paypost, perlas_terminals, paysafecash, paysafecard, paysera, satispay, atome, duit_now, pay_now, prompt_pay, go_pay, jenius_pay, fps, ach_direct_debit, bacs_direct_debit, becs_direct_debit, klarna, sepa_direct_debit, korean_local_card, payco, samsung_pay, naver_pay, toss_pay, ovo, bitpay, linkaja, eft_direct_debit, zip, afterpay.
Last time at which the PaymentMethod was updated
Verkkopankki information.
The name of the bank.
Email address of the shopper.
The name of the shopper.
WeChat Pay information.
The payment channel.
The specific WechatPay flow to use. One of webqr, jsapi, inapp, mweb
Zip information.
The name of the shopper.
Options for PaymentMethod.
The PaymentMethod options for card.
Specifies whether the funds should be requested automatically after the payment is authorized. Default to true.
The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, iDEAL, etc.).
The original response code from the payment method provider (or issuer for card)
Human-readable description of provider_original_response_code, describing the reason returned by the issuer.
Deprecated.
Use payment_method_transaction_id instead.
Refunded amount
Through which channel the merchant will get this payment settled. Possible values are airwallex, paypal, amex.
If airwallex is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally.
- RECEIVED: The PaymentAttempt has been created upon request.
- AUTHENTICATION_REDIRECTED: The PaymentAttempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.
- PENDING_AUTHORIZATION: The PaymentAttempt authorization request has been accepted and is pending the final result from the provider.
- AUTHORIZED: The PaymentAttempt was successfully authorized. It will either be automatically captured or require a manual capture to finalize the payment. Please be aware that capturing the payment is not possible if the PaymentIntent status is PENDING_REVIEW.
- CAPTURE_REQUESTED: The PaymentAttempt has been successfully requested for capture. The payment is complete.
- EXPIRED: The PaymentAttempt expired after the allowed payment time. Please create a new PaymentAttempt to retry.
- CANCELLED: The PaymentAttempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.
- FAILED: The PaymentAttempt has failed. Please create a new PaymentAttempt to retry.
- SETTLED: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.
- PAID: Airwallex has settled the funds in your wallet.
Airwallex terminal unique identifier used to process the payment attempt.
Last time at which this PaymentAttempt was updated or operated on
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/cancel' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "cancellation_reason": "Payment cancelled by shopper",> "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066">}'
1{2 "id": "int_hkpdskz7vg1xc7uscdj",3 "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066",4 "amount": 100,5 "currency": "USD",6 "status": "CANCELLED",7 "merchant_order_id": "D202503210001",8 "descriptor": "Airwallex - Test Descriptor",9 "metadata": {10 "foo": "bar"11 },12 "created_at": "2025-01-31T06:57:10+0000",13 "updated_at": "2025-01-31T07:01:10+0000"14}
Get list of PaymentIntents
GET /api/v1/pa/payment_intents
Retrieve list of PaymentIntents.
Airwallex assigned account identifier of the connected entity. Only applicable for platforms.
PaymentIntent currency
The start time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Merchant Order unique identifier
Page number starting from 0
Number of PaymentIntents to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.
Payment Consent unique identifier
PaymentIntent status
The end time of created_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
A flag which identifies whether there are more results.
List items
Additional info for the transaction.
Additional info for account funding transactions to ensure compliance with card networks.
Account funding transaction type. Possible values:
- ACCOUNT_TO_ACCOUNT_TRANSFER: An account-to-account transfer, either within the same financial institution or to a different one.
- STORED_VALUE_DIGITAL_WALLET_TRANSFER: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.
- STAGED_DIGITAL_WALLET_TRANSFER: Funding a Staged Digital Wallet before the cardholder makes a purchase.
- PREPAID_CARD_TOP_UP: Prepaid card or gift card top-up (adding value to an eligible reloadable prepaid card or funding the cardholder’s own prepaid account).
- LIQUID_ASSET_PURCHASE: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).
Details of the recipient for this account funding transaction.
Account number of the recipient receiving funds. If you are funding a card, provide the first six digits and last four digits of the card number (e.g., "411111xxxxxxxx1111").
Address of the recipient.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
First name of the recipient.
Last name of the recipient.
Middle name of the recipient.
Details of the sender for this account funding transaction.
Address of the sender.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address.
Address line1.
Address line2.
Postcode of the address.
State or province of the address.
The sender’s date of birth. Format: YYYY-MM-DD (e.g., "1989-07-15").
First name of the sender.
Last name of the sender.
Middle name of the sender.
Indicates whether the transfer is between the customer's own accounts. If true, Airwallex will compare the cardholder's name and the recipient's name, and will trigger 3DS if the names do not match.
Level 2 & Level 3 data that will be sent to card schemes. By providing Level 2 or Level 3 data with your transactions, you may be able to qualify for reduced interchange rates.
Details of the customer making a payment for this Payment Intent.
First name of the customer
Last name of the customer
A reference number or code supplied by the cardholder to the merchant, which could be used for invoice management at the cardholder's side. Maximum of 17 characters.
Tax identifier of the customer. Maximum of 13 characters.
The total charges for any import or export duty included in the transaction. This amount must be expressed in the original currency of the transaction.
Invoice reference number. Maximum of 17 characters.
The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters.
The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction.
Product list
Merchant’s product identifier code. Maximum of 12 characters.
The UNSPSC Commodity Code for the product. Maximum of 12 characters.
Product description. Maximum of 26 characters.
The discount amount for the product. This amount must be expressed in the original currency of the transaction.
Product quantity
The tax rate percentage for the product. Should be less than 100, up to 2 decimal places.
The total amount for the product. This amount must be expressed in the original currency of the transaction.
The total amount of tax for the product. This amount must be expressed in the original currency of the transaction.
The unit of measure code used for the product. Maximum of 12 characters.
Product unit price. This amount must be expressed in the original currency of the transaction.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The date the goods were shipped to the destination, in YYYY-MM-DD format.
Shipping fee amount. This amount must be expressed in the same currency as the transaction amount.
The postcode of the location the goods are being shipped from. Maximum of 10 characters.
The first 2,4 or 6 digits of UNSPSC Commodity Code that best categorizes the items being purchased. If the items belong to different categories, choose a category that best represents the items. Maximum of 15 characters
The total amount of sales tax or value added tax (VAT) on the transaction amount. This amount must be expressed in the original currency of the transaction.
Value added tax invoice reference number. Maximum of 15 characters.
The additional information for online ticket agency data.
The details of the event.
The name of the event.
The location of the venue.
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
The name of the venue.
The seat number of the venue.
The name of the company arranging the event.
The name of the customer.
The title used before the customer’s name. One of mr, ms, and mrs.
The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The category or type of the event.
The additional information for online travel agency data.
The details of accommodation.
The address of this accommodation.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Postcode of the address. Maximum of 10 characters.
Street of the address. Maximum of 1000 characters.
State or province of the address. Maximum of 100 characters.
Check-in date, in YYYY-MM-DD format.
Check-out date, in YYYY-MM-DD format.
Nationality of the guest (ISO 3166-1 alpha-2 code).
Guest phone number.
Name of the accommodation.
Type of room. For example Presidential Suite, Single Room, Double Room, Suite
Type of accommodation. For example Hotel, Hostel, Resort, Apartment
Indicates if early check-in was paid for.
Guest email address for communication and confirmations.
Full legal name of the guest
Indicates if late checkout was paid for.
Accommodation amount excluding tax.
Hotel rating(s) (from various sources).
The score of this rating.
The source of this rating.
The type of this rating. For example Internal, External
Taxes and fees applied to the accommodation price.
The details of the buses travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the car rental.
Rental agreement number.
Full legal name of the driver.
Nationality of the driver (ISO 3166-1 alpha-2 code)
Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Driver email address for communication and confirmations.
Driver phone number.
The return address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
The list of insurances.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The start address of this rental.
City of the address. Maximum of 100 characters.
The two-letter country code in ISO 3166-1 alpha-2 format.
Street of the address. Maximum of 1000 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Rental amount excluding tax.
Taxes and fees applied to the rental price.
The details of the vehicle.
License plate number.
Manufacturer of the vehicle.
Model of the vehicle.
Condition of the vehicle. One of GOOD, FAIR, POOR.
Year of manufacture.
Vehicle Identification Number.
Details of the customer making a payment for this Payment Intent.
The name of the loyalty program.
Points or miles in the loyalty program.
Tier of the loyalty program. For example Silver, Gold, Platinum.
Customer account type. One of GUEST, MEMBER.
The details of the ferries travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The details of the flights.
IATA code of the arrival airport.
City where the arrival airport is located.
Country where the arrival airport is located (ISO 3166-1 alpha-2 code).
IATA code of the departure airport.
City where the departure airport is located.
Country where the departure airport is located (ISO 3166-1 alpha-2 code).
Airline's unique flight number.
Full legal name of the passenger.
Nationality of the passenger (ISO 3166-1 alpha-2 code).
Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Whether the flight is domestic or international. One of DOMESTIC, INTERNATIONAL.
Class of service. For example Economy, Premium Economy, Business, First.
The list of insurance.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Passenger email address for communication and confirmations.
Passenger phone number.
Ticket amount excluding tax.
Assigned seat number on the flight.
Taxes and fees applied to the ticket price.
Purchase order related to this PaymentIntent.
Indicates if the booking is cancellable.
The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The model of payment. One of FULL, PARTIAL
The details of the trains travel.
The city of the arrival. Maximum length is 100.
The itinerary service class.
The city of the departure. Maximum length is 100.
The name of the traveler. Maximum length is 100.
The name of the transportation company.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The title used before the traveler’s name. One of mr, ms, and mrs.
The itinerary unit price in payment intent currency.
The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Payment amount. This is the order amount you would like to charge your customer
Reason for cancelling the PaymentIntent. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED
Amount that captured from this PaymentIntent
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API
The provided client_secret is valid for 60 minutes
Account identifier of the connected account.
The unique identifier of the conversion quote applied to the intent.
Time at which this PaymentIntent was created
Amount currency
The details of the customer who is making a business payment for this PaymentIntent, in which case it's not desired to create a Customer API resource.
Additional information of the customer
Customer account type. One of GUEST, PRIVATE, BUSINESS, VIP, MERCHANT_OPERATED, TRIAL, MERCHANT_EMPLOYEE, PREMIUM_PAID, SMALL_BUSINESS, AGENT
Date at which the customer completes the first order on the merchant's site
The public IP address used by the customer in the last login.
The last time at which the customer modified their account in the merchant's system. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis
Payment method type, one of affirm, afterpay, atome, klarna, and other
The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to supported currencies .
The date on which the customer completed their first purchase in the merchant's system with the specified payment method type
The date on which the customer completed their last purchase in the merchant's system with the specified payment method type
Total volume of successful purchases. Please refer to supported currencies for supported minor units.
Total number of successful purchases
Date at which the customer registers on the merchant's site
The public IP address used by the customer when registering on the merchant's site.
Address of the customer
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the customer
Email address of the customer
First name of the customer
Last name of the customer
Unique identifier of the customer in merchant's system. Maximum length is 64.
Phone number of the customer
The unique identifier of the Customer who is paying for this PaymentIntent
Descriptor that will be displayed to the customer
The data that will create funds splits automatically after the PaymentIntent succeeds.
Amount of this split. Please refer to supported currencies for supported minor units.
The destination that the money is splitting to. The value could be either:
- a connected account ID. Used to split funds when collecting payments directly
- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts If a value is not specified, the destination will be as specified in the PaymentIntent.
Unique identifier for the PaymentIntent
Invoice unique identifier
Latest PaymentAttempt that was created under the PaymentIntent
Unique identifier for the PaymentAttempt
Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code.
The order unique identifier created in merchant's order system that corresponds to this PaymentIntent
A set of key-value pairs that you can attach to this PaymentIntent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Next action for merchant
The content type of the request when method is POST. If not provided, the content type should be application/json
The additional data that can be used to complete this action
The DCC data that can be used to complete this action
The proposed payment amount after Dynamic Currency Conversion (DCC)
The proposed client rate for DCC
Three-letter ISO code of the payment currency after DCC
Six-letter code representing the pair of PaymentIntent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the PaymentIntent currency. The order of currencies only indicates the exchanging direction of client_rate.
Time at which the proposed client_rate expires
Time at which the proposed client_rate was generated
Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is inapp.
The redirect method if the action type is redirect. One of GET, POST
Android package name. Returned only if the flow is inapp and the os_type is android.
QR Code text representation if the action type is render_qrcode or redirect, only applicable to wechatpay, alipaycn, alipayhk, kakaopay, gcash, tng, truemoney, rabbit_line_pay, fps.
Stage of the request flow
Type of next action. One of render_qrcode, call_sdk, redirect, redirect_iframe, request_pin
The redirect url
Purchase order related to this PaymentIntent
Discount used by the customer.
Coupon code used
The total amount from all foreign retailers in a marketplace transaction. Must be greater than or equal to 0 and less than or equal to the payment intent amount.
Itineraries list. Required for Online Travel Agency.
The departure datetime in ISO 8601 format.
The itinerary unit price in payment intent currency.
The itinerary service class. One of first_class, business, economy.
The traveler’s identifier in order.travelers. Maximum length is 64.
The 2-letter IATA airline carrier code if the itinerary is for airline.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the arrival. Maximum length is 100.
The estimated arrival datetime in ISO 8601 format.
The 3-letter IATA airport code, required if the itinerary is for airline.
The city of the departure. Maximum length is 100.
The insurance list for the itinerary.
The insurance company name. Maximum length is 100.
The insurance price in payment intent currency.
The insurance type. One of cancellation, delay, casualty, baggage, and other.
Product list
Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories
Merchant’s product identifier code. Maximum of 128 characters.
Product description. Maximum of 500 characters.
The effective end time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The effective start time of the product, only applicable when product type is intangible_good. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The preview image url for this product, which is usually displayed as thumbnail in the order details.
Name of the product. Maximum of 255 characters.
Product quantity
Seller info of the purchase order
The identifier of the seller in the merchant's system
The name of the seller in the merchant's system
Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters.
Type of product, such as physical_good, intangible_good, or service. Maximum of 128 characters.
Product unit price
The url that links to the product page at merchant site.
Seller list
The additional information of the seller in the merchant's system for risk analysis
The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. Z or -04:00).
The sales summary of this seller during the last period
The currency of sales amount
The period of this sales summary. Default to 12M (last 12 months).
The volume of sales completed by the seller in the last period
The number of sales completed by the seller in the last period
The business information of the seller in the merchant's system for risk analysis
Address of the seller
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Email address of the seller
Phone number of the seller
This field is deprecated in favor of address.postcode. Postal code of the seller company address. Maximum length is 10.
The latest customer rating (out of 10) for this seller
The date on which the seller registered in the merchant's system
The identifier of the seller in the merchant's system. Maximum length is 64.
The name of the seller in the merchant's system. Maximum length is 100.
Shipping information
Shipping address
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Shipping fee amount.
First name of the recipient. Maximum of 128 characters.
Last name of the recipient. Maximum of 128 characters.
Phone number of the recipient. Maximum of 50 characters.
Name of the shipping company. Maximum of 100 characters.
Use if customer chose to deliver the item at a later time. The timestamp must include an explicit timezone (e.g. Z or -04:00).
Shipping method for the product. Maximum of 128 characters.
Tracking number of the shipment. Maximum of 100 characters.
URL where the customer can track the shipment. Maximum of 1024 characters.
Deprecated.
Use order.sellers instead
Address of the supplier
The two-letter country code in ISO 3166-1 alpha-2 format.
City of the address. Maximum of 100 characters.
Postcode of the address. Maximum of 10 characters.
State or province of the address. Maximum of 100 characters.
Street of the address. Maximum of 1000 characters.
Business name of the supplier. Maximum length is 128.
Email address of the supplier
First name of the supplier. Maximum length is 128.
Last name of the supplier. Maximum length is 128.
Phone number of the supplier
Surcharge Information.
The surcharge amount. This amount is included in the PaymentIntent's total amount.
The surcharge rate in percentage. For example, 5 represents a 5% surcharge.
Tip information
The tip amount. This amount is included in the total amount.
Travelers list. Required for Online Travel Agency.
The identifier of the traveler in the merchant's system. Maximum length is 64.
The name of the traveler. Maximum length is 100.
The title used before the traveler’s name. One of mr, ms, and mrs.
Industry category of the order. Maximum of 128 characters.
The associated PaymentConsent to set up along with the PaymentIntent.
The party to trigger subsequent payments. One of merchant, customer.
Indicate whether the subsequent payments are scheduled. Only applicable when next_triggered_by is merchant. One of scheduled, unscheduled, installments.
Default: unscheduled
Terms to specify how this Payment Consent will be used.
The agreed type of amounts for subsequent payment. Should be one of FIXED, VARIABLE.
- FIXED: payment amount is fixed. A specific amount is required.
- VARIABLE: payment amount is variable at each collection. A max limit is recommended.
The granularity per billing cycle. Required when payment_schedule.period_unit is WEEK, MONTH, or YEAR. (e.g. charge_day_per_billing_cycle= 5, payment_schedule.period_unit = MONTH, payment_schedule.period = 1 if collect payment on the 5th of each month).
End date to expect payment request.
The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is VARIABLE.
The fixed payment amount that can be charged for a single payment.Required if payment agreement type is FIXED.
The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is VARIABLE.
The currency of this payment. Please refer to supported currencies .
The number of period units between billing cycles. For example, the payment cycle is one month if period=1 and period_unit=MONTH. Required when merchant_trigger_reason = scheduled
Specifies billing frequency. One of DAY, WEEK, MONTH, and YEAR. Required when merchant_trigger_reason = scheduled
Start date to expect payment request.
The total number of billing cycles. For example, the mandate will last for 1 year if total_billing_cycles=12, payment_schedule.period=1 and payment_schedule.period_unit=MONTH if the merchant_trigger_reason is scheduled. Merchant can bill customers 12 times when total_billing_cycles=12 if the merchant_trigger_reason is unscheduledThe mandate will continue indefinitely if total_billing_cycles is null.
Unique identifier of the PaymentConsent related to this PaymentIntent
Payment Link unique identifier (if this intent was created by Payment Link)
Options for PaymentMethod
The PaymentMethod options for card
Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when payment_method is provided. Default to true.
The channel through which the cardholder inputs the card. One of ecommerce, moto
Types of transactions where the merchant is allowed to initiate payments because it is a customary, legitimate need of the merchant’s industry. Only applicable for merchant-initiated transactions. One of incremental_authorization, reauthorization, resubmission, delayed_charges, partial_shipment, no_show.
Deprecated.
Use risk_control_options.skip_risk_processing instead of payment_method_options.card.risk_control.skip_risk_processing.
Use payment_method_options.card.three_ds_action instead of payment_method_options.card.risk_control.three_ds_action
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Deprecated, use three_ds_action - Set it to FORCE_3DS if you want to enforce 3ds. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
Set it to FORCE_3DS if you want to enforce 3DS with our 3DS provider. Set it to EXTERNAL_3DS if you want to use your own 3DS provider, in this case payment_method_options.card.external_three_ds should be provided in the confirm request. Set it to SKIP_3DS if you want to skip 3DS regardless of the risk score. null by default
The PaymentMethod options for wechatpay
Indicates whether funds split will be enabled for this WeChatPay order
Unique request identifier specified by the merchant in the last operation
The web page URL or application scheme URI to redirect the customer after payment authentication.
Risk Control Options
Set it to true if you want to skip fraud processing. Please contact your account manager to enable the feature to take effect. Defaults to false.
Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing
Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.
- REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.
- This status is returned right after the PaymentIntent is created or the previous PaymentAttempt has failed or expired.
- REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the
next_action. - PENDING_REVIEW: The PaymentIntent was successfully authorized, but it is currently under review for risk compliance.
- REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.
- PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.
- SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.
- CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.
Indicates who initiated the payment — the merchant or the customer.
merchant: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.customer: The payment is initiated by the customer using stored payment method details.
Last time at which this PaymentIntent was updated or operated on
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api-demo.airwallex.com/api/v1/pa/payment_intents' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "latest_payment_attempt": {6 "id": "att_hkpdskz7vg1xc7uscdj"7 },8 "id": "int_hkpdskz7vg1xc7uscdj",9 "request_id": "1cd461eb-cfa5-4215-a59d-fb1e2c3b2cd0",10 "amount": 100,11 "currency": "USD",12 "merchant_order_id": "D202503210001",13 "descriptor": "Airwallex - Test Descriptor",14 "metadata": {15 "foo": "bar"16 },17 "status": "REQUIRES_PAYMENT_METHOD",18 "created_at": "2025-01-31T06:57:10+0000",19 "updated_at": "2025-01-31T07:01:10+0000"20 }21 ]22}