{ "openapi": "3.1.0", "info": { "title": "Airwallex Client Api Documentation", "description": "Airwallex Client Api Documentation.", "version": "2026-08-21", "termsOfService": "https://www.airwallex.com/terms", "contact": {}, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" } }, "servers": [ { "url": "https://api.airwallex.com", "description": "Production" }, { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "name": "Account Capability > Account Capability", "description": "The Account Capability resource represents [capabilities](/docs/connected-accounts/about/account-capabilities) you can enable or query on your Airwallex account like accepting card payments or making fund transfers.", "x-displayName": "Account Capability" }, { "name": "Accounting > General Ledger Accounts", "description": "Manages General Ledger (GL) account entries used when coding Airwallex Spend transactions, such as expenses and bills.", "x-displayName": "General Ledger Accounts" }, { "name": "Accounting > Tax Codes", "description": "Manages tax codes used when coding Airwallex Spend transactions, such as expenses and bills.", "x-displayName": "Tax Codes" }, { "name": "Accounting > Accounting Fields", "description": "Manages custom accounting fields that define additional accounting dimensions for Airwallex Spend, such as projects or cost centers.", "x-displayName": "Accounting Fields" }, { "name": "Accounting > Accounting Field Values", "description": "Manages selectable values for custom accounting fields used when coding Airwallex Spend transactions.", "x-displayName": "Accounting Field Values" }, { "name": "Authentication > Embedded Components", "description": "Authorize to use embedded components.", "x-displayName": "Embedded Components" }, { "name": "Authentication > Authentication", "description": "Airwallex uses an [API key](/docs/developer-tools/api/manage-api-keys) and Client ID to authenticate requests. You authenticate by exchanging your API key and Client ID for a short-lived access token, then sending that token as `Authorization: Bearer ` on every subsequent call. The access token is valid for 30 minutes and can be reused until it expires. Do not call the authentication endpoint before each request. Track expiration using the `expires_at` field from the login response. To get an access token, call [Obtain an access token](/docs/api/authentication/api_access_token/login).\n\nYou can view and manage API keys in the [Airwallex web app](https://www.airwallex.com/app). Do not share your API key in publicly accessible places such as GitHub repositories, client-side code, and so forth. For guidance on scoping, storing, and rotating your keys, see [API key best practices](/docs/developer-tools/api/api-key-best-practices).\n\nAirwallex authorizes each request against the scopes attached to your API key. For the full catalog of key permissions, see [API key scopes](/docs/developer-tools/api/api-key-scopes).\n\nAll requests must be made over HTTPS. Only [PCI-DSS recommended TLS versions and cipher suites](/docs/developer-tools/security/securing-connections-to-airwallex) are supported.", "x-displayName": "API Access Token" }, { "name": "Billing > Credit Notes", "description": "Issue a [Credit Note](/docs/billing/invoicing/credit-notes) to adjust the amount of a finalized invoice.", "x-displayName": "Credit Notes" }, { "name": "Billing > E-Invoicing Documents", "description": "An E-Invoicing Document represents the regulatory (e-invoicing or e-reporting) processing record for an [Invoice](/docs/api/billing/invoices) or [Credit Note](/docs/api/billing/credit_notes). It tracks the processing status, regulatory artifacts, the recipient's response, and processing errors.", "x-displayName": "E-Invoicing Documents" }, { "name": "Billing > Billing Checkouts", "description": "A [Billing Checkout](/docs/billing/billing-components/checkout/hosted-billing-checkout) manages the setup and lifecycle of an Airwallex-hosted customer checkout experience, enabling customers to confirm and pay for line items or set up payment details for future transactions. \nWe recommend creating a new Billing Checkout each time a customer initiates a purchase. After the customer successfully completes the checkout, resources such as Customer, Payment Source, and Subscription will be automatically created in the Billing Checkout object.", "x-displayName": "Billing Checkouts" }, { "name": "Billing > Billing Customers", "description": "A [Billing Customer](/docs/billing/billing-components/customers) is an individual or business who purchases or subscribes to your products or services.", "x-displayName": "Billing Customers" }, { "name": "Billing > Billing Transactions", "description": "A Billing Transaction describes a transaction on your invoice such as a payment or refund.", "x-displayName": "Billing Transactions" }, { "name": "Billing > Coupons", "description": "[Coupon](/docs/billing/billing-components/coupons/coupons) management APIs for creating and managing coupon templates.", "x-displayName": "Coupons" }, { "name": "Billing > Invoices", "description": "An [Invoice](/docs/billing/invoicing/get-started-with-invoicing) represents an official request for payment that details products or services purchased, pricing and payment instructions. It can be issued directly (one-time invoices) or via a [Subscription](/docs/api/billing/subscriptions) (recurring invoices).", "x-displayName": "Invoices" }, { "name": "Billing > Meters", "description": "A [Meter](/docs/billing/usage-based-billing/meters) defines how to aggregate usage events over a billing period to determine how much a customer should be billed.", "x-displayName": "Meters" }, { "name": "Billing > Payment Sources", "description": "A [Payment Source](/docs/billing/billing-components/payment-sources) represents a [Billing Customer](/docs/api/billing/billing_customers)'s funding instrument that can be used to pay for invoices.", "x-displayName": "Payment Sources" }, { "name": "Billing > Prices", "description": "A [Price](/docs/billing/billing-components/prices) defines the pricing information for a [Product](/docs/api/billing/products) such as amount, currency, and billing frequency. A Product can have multiple Prices. For example, you can offer the following pricing options for a software license Product:\n- 1. Standard Price: $10 / month\n- 2. Student Price: $5 / month\n- 3. Lifetime Access: $200 one-off purchase\n\nPrices are primarily used in [Invoice](/docs/api/billing/invoices) and [Subscription](/docs/api/billing/subscriptions) APIs.", "x-displayName": "Prices" }, { "name": "Billing > Products", "description": "[Products](/docs/billing/billing-components/products) represent the goods or services you offer to customers (e.g. books, memberships). When associated with [Prices](/docs/api/billing/prices), they can be used with the [Invoice](/docs/api/billing/invoices) and [Subscription](/docs/api/billing/subscriptions) APIs.", "x-displayName": "Products" }, { "name": "Billing > Rate Cards", "description": "A [Rate Card](/docs/billing/usage-based-billing/rate-cards) is a versioned container for multi-dimensional pricing. It groups multiple Rate Card Items, each representing the price for one combination of dimensions (e.g. `model` × `token_type`), under shared billing fields (`product_id`, `meter_id`, `currency`, `recurring`). This lets you define pricing for an entire matrix for a single [Product](/docs/api/billing/products) and add it to a [Subscription](/docs/api/billing/subscriptions) as a single item, instead of creating one Price for each combination.\n\nPricing is organized in three layers:\n- Rate Card — the container and its shared billing fields.\n- Rate Card Version — an immutable snapshot of the pricing. Change pricing by publishing a new version; existing subscriptions stay pinned to the version they were created with.\n- Rate Card Item — one entry in the matrix: the price for a specific set of `dimension_values`.\n\nWhen usage is billed, each usage record is matched against the version's items in order and billed at the first item whose `dimension_values` match (an omitted key matches any value; an empty object matches all usage). So one Rate Card subscription item expands into one invoice line item per priced dimension combination that had usage.", "x-displayName": "Rate Cards" }, { "name": "Billing > Subscriptions", "description": "A [Subscription](/docs/billing/subscriptions/get-started-with-subscription-management) manages the billing lifecycle for the recurring products or services that a customer purchases. One or more Products and Prices can be added as Subscription Items to a Subscription.\n\nCustomers can be charged automatically, or be issued invoices that they will pay manually every billing cycle.\n\nIf a Subscription is set to charge a Billing Customer's Payment Source automatically, the charge will either happen at the start or end of a billing cycle depending on whether a Price's billing type is `IN_ADVANCE` or `IN_ARREARS`:\n\n- `IN_ADVANCE`: billed at the beginning of the billing cycle.\n- `IN_ARREARS`: billed at the end of the billing cycle.\n\nA Subscription with a free trial moves from `IN_TRIAL` status to `ACTIVE` status when the trial period ends. If a Subscription is created with a future start time, it will be in `PENDING` status until the trial period or paid billing period starts. The status of a Subscription is `UNPAID` when a payment initially fails. When this happens, Airwallex will retry payment up to 4 times (after 1 day, 2 days, 5 days and 7 days).\n\nThe status of a Subscription moves to `ACTIVE` if a payment retry attempt succeeds, or `CANCELLED` if all retries fail. A Subscription moves to `CANCELLED` when it ends or if cancelled.", "x-displayName": "Subscriptions" }, { "name": "Billing > Usage Events", "description": "A [Usage Event](/docs/billing/usage-based-billing/usage-events) represents a customer's usage of a product at a specific timestamp.", "x-displayName": "Usage Events" }, { "name": "Checkout > Checkout Sessions", "description": "A [Checkout Session](/docs/payments/integration-options/web-checkout/checkout-session/quickstart) manages the setup and lifecycle of an Airwallex-hosted customer checkout experience, including billing subscriptions, one-off payments and payment setup flows.\nWe recommend creating a new Checkout Session each time a customer initiates a purchase. After the customer successfully completes the session, downstream resources such as Billing Customer, Customer, Payment Source, Payment Consent, Subscription, or Invoice may be created depending on the session mode.", "x-badges": [ { "name": "Beta" } ], "x-displayName": "Checkout Sessions" }, { "name": "Confirmation Letter > Confirmation Letter", "x-displayName": "Confirmation Letter" }, { "name": "Core Resources > Direct Debits", "description": "Direct Debits are transactions that third party made to pull funds out of your Airwallex account.", "x-displayName": "Direct Debits" }, { "name": "Core Resources > Balances", "description": "Different types of balances such as available and pending can be retrieved to reflect the present balances under your Airwallex account.", "x-displayName": "Balances" }, { "name": "Core Resources > Deposits", "description": "Deposits are transfers made into your Airwallex account via Global Accounts, Airwallex Pay, or Aggregate Funds for adding funds or collecting funds from third parties.", "x-displayName": "Deposits" }, { "name": "Core Resources > Global Accounts", "description": "[Global Accounts](/docs/accounts/get-started/global-accounts) are foreign currency accounts that function as local bank accounts. They can be used to collect funds from around the world. You get account details that enable you to collect funds from various platforms such as Amazon, eBay and Shopify, among others. Global Accounts can also be used to top up your Airwallex balance.", "x-displayName": "Global Accounts" }, { "name": "Core Resources > Linked Accounts", "description": "[Linked Accounts](/docs/global-treasury/get-started/linked-accounts) are external financial accounts associated with your Airwallex account. You can use Linked Accounts to fund your Airwallex wallet via Direct Debit.", "x-displayName": "Linked Accounts" }, { "name": "Finance > Financial Reports", "description": "The [Financial Reports](/docs/global-treasury/reporting/financial-reports) resources provide the capability to create and get the contents of reports on your Airwallex account's historical transaction activity.", "x-displayName": "Financial Reports" }, { "name": "Finance > Financial Transactions", "x-displayName": "Financial Transactions" }, { "name": "Finance > Settlements", "description": "Represents the set of endpoints you use to track and manage payment [settlements](/docs/payments/about-airwallex-payments/settle-into-your-airwallex-balance) that contribute to your Airwallex account balance. You can list settlements with optional filters, retrieve a settlements overview for a specific settlement by settlement batch unique identifier, and download batch settlement reports for reconciliation or record keeping.", "x-displayName": "Settlements" }, { "name": "Issuing > Cards", "description": "You can create [virtual cards](/docs/issuing/get-started/create-cards) associated with your organisation, these cards can be single or multi-usage and be restricted by merchant code, currency and transaction amount. \n \nPlease note, this API version is incompatible with any Airwallex Business Account Products such as \"Borderless Cards\" or \"Expense Management\" via Airwallex web or mobile applications. If you're using any of these products, please use API version 2024-02-22. Contact your account manager for more information and to verify compatibility.", "x-displayName": "Cards" }, { "name": "Issuing > Authorizations", "description": "You can view authorizations such as pre auth and capture processed against individual cards or for all cards created within your organisation.", "x-displayName": "Authorizations" }, { "name": "Issuing > Card Transaction Events", "description": "\nA **[transaction event](/docs/issuing/transactions/transaction-lifecycle/transaction-events-and-categories)** is the most granular level of the three-level transaction model \n(**Lifecycle → Card Transaction → Transaction Event**).\n\nEach transaction event represents an individual network message or fund movement, with an immutable \nfund movement per event. Use transaction events when you need per-event \ndetails such as failure reasons, authorization subtypes, or individual amounts.\n\n**Event types:** `AUTHORIZATION`, `CLEARING`, `REVERSAL_AUTH`.\n\n**Event subtypes:** `AUTHORIZATION`, `INCREMENTAL_AUTHORIZATION`, `VERIFICATION`, `REVERSAL`, \n`PARTIAL_REVERSAL`, `EXPIRED_AUTHORIZATION`, `CLEARING`, `PARTIAL_CLEARING`, `CLEARING_REVERSAL`.\n\n**Data retention:** Resources can be queried for a maximum of 2 years from creation.\n\nLearn more about the [transaction lifecycle](/docs/issuing/transactions/transaction-lifecycle).\n", "x-displayName": "Card Transaction Events" }, { "name": "Issuing > Card Transactions", "description": "\nA **card transaction** is the middle level of the three-level transaction model \n(**Lifecycle → Card Transaction → Transaction Event**).\n\nIt groups related transaction events and represents Airwallex's interpretation of a single card \ntransaction. Each card transaction has a guaranteed terminal status and a fund direction, making it \nthe recommended level for tracking payment outcomes without implementing custom grouping logic.\n\n**Statuses:** `AUTHORIZED` (non-terminal), `CLEARED`, `REVERSED`, `EXPIRED`, `DECLINED`, \n`VERIFIED` (terminal).\n\n**Fund directions:** `DEBIT`, `CREDIT`, or `NO_MOVEMENT`.\n\nAll card transactions within the same payment flow share a common lifecycle ID.\n\n**Data retention:** Resources can be queried for a maximum of 2 years from creation.\n\nLearn more about the [transaction lifecycle](/docs/issuing/transactions/transaction-lifecycle).\n", "x-displayName": "Card Transactions" }, { "name": "Issuing > Cardholders", "description": "You can create [cardholders](/docs/issuing/get-started/create-cardholders), which are authorized representatives of your business that can be issued cards. \n \nPlease note, this API version is incompatible with any Airwallex Business Account Products such as \"Borderless Cards\" or \"Expense Management\" via Airwallex web or mobile applications. If you're using any of these products, please use API version 2024-02-22. Contact your account manager for more information and to verify compatibility.", "x-displayName": "Cardholders" }, { "name": "Issuing > Config", "description": "You can view config for cards such as default and maximum limit when creating card and remote auth setting to process authorization on your side.", "x-displayName": "Config" }, { "name": "Issuing > Digital Wallet Tokens", "description": "Query and manage digital wallet tokens.", "x-displayName": "Digital Wallet Tokens" }, { "name": "Issuing > Card Transaction Lifecycles", "description": "\nA **lifecycle** is the top level of the three-level transaction model \n(**Lifecycle → Card Transaction → Transaction Event**).\n\nIt is a container that groups all related card transactions and transaction events belonging to \nthe same payment flow, based on network information. Lifecycles provide a network-level view \nof a payment along with aggregated billing amounts across all related card transactions and events.\n\n**Key characteristics:**\n* Lifecycles do not have a status. Use card transactions if you need guaranteed terminal statuses.\n* Grouping is **best-effort**: it depends on payment networks and acquirers providing consistent \n identifiers. For example, matched refunds link to the original lifecycle; unmatched refunds \n create a new one.\n* Use the lifecycle ID to retrieve all associated card transactions and transaction events.\n\n**Data retention:** Resources can be queried for a maximum of 2 years from creation.\n\nLearn more about the [transaction lifecycle](/docs/issuing/transactions/transaction-lifecycle).\n", "x-displayName": "Card Transaction Lifecycles" }, { "name": "Issuing > Merchant Brands", "description": "Searches [Merchant Brands](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories), primarily for configuring the set of Merchant Brand unique identifiers permitted on a card.", "x-displayName": "Merchant Brands" }, { "name": "Issuing > Transaction Disputes", "description": "You can create a [dispute](/docs/issuing/transactions/handle-transaction-disputes) for a card transaction. You can also update/submit/cancel it.", "x-displayName": "Transaction Disputes" }, { "name": "Issuing > Transactions", "description": "You can view [transactions](/docs/issuing/transactions/retrieve-card-transactions) processed against individual cards or for all cards created within your organisation.", "x-displayName": "Transactions" }, { "name": "Issuing > Card Profiles", "description": "View the card profiles available to your account.", "x-displayName": "Card Profiles" }, { "name": "Payment Acceptance > Reference Data", "description": "All card schemes publish account range information which helps understand the product, issuer country code, issuer name etc. Hence, merchants can request account range data under a particular PAN thereby enabling business logic such as:\n\n- Merchants query for BIN info using the PAN to get information about card type so that they can surcharge if the card used is commercial / credit or other cases.\n- Merchants would like to know the brand and product information to run discounts and offers on the website. The cart amount will be dynamically updated to reflect the discounted price.\n- Merchants query on the card details like country code to run some risk level checks at their side without depending on the acquirer. Merchants may not want to accept cards issued in a certain country, because sending this to the acquirer may cost them additional charges (gateway fee / authorization fee, etc.).", "x-displayName": "Reference Data" }, { "name": "Payment Acceptance > Payment Links", "description": "The **[Payment Links](/docs/payments/integration-options/invoices-and-payment-links/payment-links)** API allows you to accept payments from shoppers using a payment link URL. The payment link URL takes your shopper to an Airwallex hosted secure checkout page where they can make the payment with their preferred payment method.\n\nThe Payment Link supports two pricing options:\n\n1. Fixed pricing - Both the payment `amount` and `currency` are locked. The shopper must pay the exact amount in the given currency.\n2. Flexible pricing - The shopper chooses to pay from a list of supported currencies you specify and decide on the exact amount to pay.", "x-displayName": "Payment Links" }, { "name": "Payment Acceptance > Config", "description": "The **Config** API allows you to query for active merchant configurations.", "x-displayName": "Config" }, { "name": "Payment Acceptance > Conversion Quotes", "description": "A conversion quote locks the conversion rate between the merchant and shopper currencies for a certain period of time. Merchants can repeatedly use it to price payments in the shopper's local currency during its validity period. Please refer to our [product documentation](/docs/payments/optimize-your-integration/increase-conversion/multi-currency-pricing-api) for integration details. \n \nData Retention Policy: You can query Conversion Quote resources for a maximum of 31 days since creation.", "x-displayName": "Conversion Quotes" }, { "name": "Payment Acceptance > Customers", "description": "**Customer** is an API resource for you to save your customer's information, which is required by the [Payment Method](/docs/api/payments/payment_methods) and [Payment Consent](/docs/api/payments/payment_consents) APIs.", "x-displayName": "Customers" }, { "name": "Payment Acceptance > Customs Declarations", "description": "The **Customs Declaration** API help merchants to complete customs clearance process as regulation required. This API applies only to China customs requirements and workflows.", "x-displayName": "Customs Declarations" }, { "name": "Payment Acceptance > Funds Split Reversals", "description": "The **[Funds Split Reversal](/docs/payments-for-platforms/airwallex-gateway/manage-funds-split)** API helps you reverse an existing **Funds Split** made to a connected account, either entirely or partially. \n \nData Retention Policy: You can query and operate Funds Split Reversal resources for a maximum of 2 years since creation.", "x-displayName": "Funds Split Reversals" }, { "name": "Payment Acceptance > Funds Splits", "description": "A **[Funds Split](/docs/payments-for-platforms/airwallex-gateway/manage-funds-split)** will guide you through the process to divide part of the collected funds to another destination before settling to the account that owns the funds.\n\nYou may create multiple **Funds Splits** for the same source of funds to send money to different destinations. However, one **Funds Split** will only have one destination.\n\nYou may specify the following on a Funds Split.\n\n1. What is the source of funds? Denoted by `source_type`.\n2. How much do you want to split? Denoted by `amount`.\n3. Who will receive the funds? Denoted by `destination`.\n\nCurrently, Funds Split only works when the source of funds is a payment acceptance transaction, and the destinations are connected accounts to the funds owner.\n\nData Retention Policy: You can query and operate Funds Split resources for a maximum of 2 years since creation.", "x-displayName": "Funds Splits" }, { "name": "Payment Acceptance > Payment Attempts", "description": "A **Payment Attempt** object is created whenever a customer makes a payment with the chosen Payment Method. This API allows you to find out how your customer paid for your order. \n \nA customer may attempt to pay for the same order multiple times. However, only one attempt should succeed. Use the [List all Payment Attempts](/docs/api/payments/payment_attempts/list) endpoint to list each and every Payment Attempt made by your customer. \n \nData Retention Policy: You can query Payment Attempt resources for a maximum of 2 years since creation.", "x-displayName": "Payment Attempts" }, { "name": "Payment Acceptance > Payment Consents", "description": "**Payment Consent** is an API resource to represent the agreement between merchant and Customer of making subsequent payments using the provided Payment Method. In general, we can categorize the usages of Payment Consent into two groups.\n\n- Merchant can initiate the payment without customer's presence (MIT). For example, membership subscription and utilities.\n- Customer can initiate the payment without having to input payment method information again (CIT). For example, fast checkout with saved method.\n\nTo make payments, you can [confirm](/docs/api/payments/payment_intents/confirm) a Payment Intent with the reference of Payment Consent, which must be in the status of `VERIFIED`, `REQUIRES_PAYMENT_METHOD` or `REQUIRES_CUSTOMER_ACTION`. The latter two are only allowed for card and direct debit payment methods as they can be verified directly by the success of the initial payment.", "x-displayName": "Payment Consents" }, { "name": "Payment Acceptance > Payment Disputes", "description": " A [dispute](/docs/payments/payment-operations/disputes) occurs when a shopper contests legitimacy of a payment. **PaymentDispute** APIs will enable you to manage your dispute events removing the need to managing dispute events manually via web-app, there by reducing your manual efforts.\n\nCombination of a stage & status of a PaymentDispute will indicate the current situation of dispute. You can use our [product documentation](/docs/payments/manage-payments/disputes/dispute-flow) to understand the possible next actions based on stage & status combination.\n\nData Retention Policy: You can query and operate PaymentDispute resources for a maximum of 2 years since creation.", "x-displayName": "Payment Disputes" }, { "name": "Payment Acceptance > Payment Intents", "description": "A **[Payment Intent](/docs/payments/get-started/using-payments-intent-api)** 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 Payment Intent transitions through a number of states throughout the customer's payment journey.\n\nYou may specify the following on a Payment Intent.\n\n1. How much the payment is for? Denoted by `amount` and `currency`.\n2. Who is making the payment? This is described by the optional `customer_id` field.\n3. Which Payment Method to use? Denoted by `payment_method`.\n\nYou/your customer will get back the following hints at different stages of the payment process:\n\n1. The available Payment Methods.\n2. The Payment Method attached to this customer (if `customer_id` is set).\n\nA combination of `status` and `next_action` guide you and your customers through the payment process, including triggering additional authentication flows as required.\n\nData Retention Policy: You can query and operate Payment Intent resources for a maximum of 2 years since creation.", "x-displayName": "Payment Intents" }, { "name": "Payment Acceptance > Payment Methods", "description": "A **Payment Method** represents the funding source that belongs to a [Customer](/docs/api/payments/customers) and is used to bind to one or several [Payment Consents](/docs/api/payments/payment_consents).", "x-displayName": "Payment Methods" }, { "name": "Payment Acceptance > Terminals", "description": "A **[Terminal](/docs/payments/integration-options/pos-payments)** represents a physical device that can process payments. This API allows you to manage terminals, including creating, retrieving, updating, activating, deactivating, terminating, and processing payment intents in terminals. \n \nA Terminal can be in one of the following states: 1. **ACTIVE**: The Terminal is activated and ready to use. 2. **INACTIVE**: The Terminal is deactivated for any reason. 3. **TERMINATED**: The Terminal is terminated and can't be used anymore.", "x-displayName": "Terminals" }, { "name": "Payment Acceptance > Refunds", "description": "The **[Refund](/docs/payments/payment-operations/manage-payments/refunds)** API allows you to refund a succeeded payment back to the payment method used by your customer. The refund amount must be equal to or less than the amount specified in the original Payment Intent/Payment Attempt. \n \nMultiple Refunds can be created until the full amount is refunded. \n \nData Retention Policy: You can query Refund resources for a maximum of 2 years since creation.", "x-displayName": "Refunds" }, { "name": "Payment Acceptance > Settlement Records", "description": "Use the Settlement Record API to receive the full settlement details of a particular settlement batch or payment intent. \n \nThe Settlement Record API provides the same information as the [Settlement Report](/docs/payments/payment-operations/reporting/settlement-report) but via JSON. The API can be queried using settlement batch ID or payment intent ID or both depending on your reconciliation use case. \n \n**How to use this API:** \n \n**Step 1:** Retrieve a settlement batch ID and/or payment intent ID. \nYou can obtain a settlement batch ID by calling the [Get list of settlements endpoint](/docs/api/finance/settlements/list). To query by a specific payment intent, retrieve the corresponding payment intent ID using the [Get list of Payment Intents endpoint](/docs/api/payments/payment_intents/list). \n \n**Step 2:** Query the Settlement Record API. \nOnce you have the required identifiers, make a request to this API to retrieve detailed settlement records. Refer to the [API Reference](/docs/api/payments/settlement_records/list) for request details and parameters. \n \nThis API supports keyset pagination using the `page_after` parameter. If the response includes additional pages, the `has_more` field will be set to `true`.", "x-displayName": "Settlement Records" }, { "name": "Payment Acceptance > Customer Balance Transactions", "description": "A **[Customer Balance Transaction](/docs/payments/payment-methods/global/bank-transfer/customer-balance-transactions)** records a change in the balance of funds that Airwallex holds and returns on behalf of your customer. It is used to notify you when bank transfer funds are received or reversed, including in exceptional scenarios such as overpayment, underpayment, or unmatched funding.\n\n[For bank transfer payments](https://www.airwallex.com/docs/payments/payment-methods/global/bank-transfer), the payment instructions are displayed to the shopper, who then manually transfers the funds through their own bank. Because the transfer is completed outside of the Airwallex checkout flow, the received funds may not always match the original PaymentIntent or PaymentAttempt. Customer Balance Transactions give you clear visibility into every received fund, its status, and any reversal.\n\nA Customer Balance Transaction has one of the following types:\n\n1. `bank_transfer` - Adds bank transfer funds to the customer balance.\n2. `bank_transfer_reversal` - Reverses a previous bank transfer transaction and deducts the corresponding amount from the customer balance.\n3. `applied_to_payment` - Applies bank transfer funds from the customer balance to a payment, reducing the available customer balance.\n\nAirwallex emits `customer_balance_transaction` webhook events as funds progress. Refer to the product documentation for the full list of events and their payloads.\n\nThis resource applies to bank transfer payments only.", "x-displayName": "Customer Balance Transactions" }, { "name": "Payouts > Batch Transfers", "description": "A [batch transfer](/docs/payouts/batch-transfers/create-a-batch-transfer) resource is created when you want to create multiple transfers with one fund deduction from your funding source. You can create a batch transfer first, and then add items into this batch. You can only input one funding source in a batch. Beneficiary information is contained in each item in the batch.", "x-displayName": "Batch Transfers" }, { "name": "Payouts > Beneficiaries", "description": "A [beneficiary](/docs/payouts/beneficiaries/create-beneficiaries) resource needs to be created before a payment can be made, the beneficiary notes the individual or organization being paid along with the bank details and payment method. A beneficiary unique identifier is generated upon the creation can be used for creating payment using a payment resource.", "x-displayName": "Beneficiaries" }, { "name": "Payouts > Payers", "description": "By default you make payments from yourself therefore this resource is optional. However if your Airwallex Account allows paying on behalf of others, you can create new [payers](/docs/payouts/payers/create-a-payer) and this resource becomes mandatory to be defined which payer you are paying from.", "x-displayName": "Payers" }, { "name": "Payouts > Transfers", "description": "A [transfer](/docs/payouts/transfers/create-a-transfer) resource is created when you send funds to a beneficiary, it details the beneficiary, bank details, the amount being paid, its status and other relevant information. You can also create the transfer by using the beneficiary unique identifier which was previously created using the Beneficiary resource.", "x-displayName": "Transfers" }, { "name": "Risk > Fraud Feedback (Issuing)", "description": "The **Fraud Feedback** API may be used to confirm whether an issuing transaction was authorized or not authorized by the cardholder. A transaction confirmed to be authorized will allow Airwallex to better understand the cardholder's transaction patterns and increase the success rate of similar transactions. A transaction confirmed not to have been authorized by the cardholder will be labelled as fraudulent and the card will be blocked. \n \nPlease note all future transactions on a blocked card will be blocked. If you require a card to be unblocked please contact support. \n \nFrozen cards may be unfrozen via the [update a Card](/docs/api/issuing/cards/update) API.", "x-displayName": "Fraud Feedback (Issuing)" }, { "name": "Risk > Watchlist", "description": "The [Watchlist](/docs/payments/payment-operations/fraud-prevention/list-management) API is an automated tool for transaction verification and fraud prevention. With this API, merchants can create and manage Watchlists of shoppers to automatically accept, verify, or block transactions.\nTo add a Watchlist item, please use the ‘create’ endpoint. To make changes to an existing Watchlist item, please use the ‘update’ endpoint. To retrieve a specific item in the Watchlist, please provide the item_id with the ‘get’ endpoint.", "x-displayName": "Watchlist" }, { "name": "Risk > Request for Information (RFI)", "description": "As part of reviewing customer profiles and activity, Airwallex may request additional information about an account by raising an [RFI](/docs/global-treasury/risk/rfi-(request-for-information)). Airwallex will initiate a request for information which may then contain one or more follow up questions if more clarification is needed.", "x-displayName": "Request for Information (RFI)" }, { "name": "Risk > Sellers", "description": "Manage sellers for your [Merchant of Record](/docs/payments/merchant-of-record) (MoR) account.", "x-displayName": "Sellers" }, { "name": "Risk > Risk Reports", "description": "The Risk Reports API lets merchants self-serve their own risk datasets. The currently supported report type is `PAYMENT_FRAUD_REPORT`, which contains payment fraud data reported through acquirer TC40 / SAFE reports for a given date range.\n\nUse [Generate a risk report](/docs/api/risk/risk_reports/generate) to submit a query and obtain a report `id`, followed by [Retrieve a risk report](/docs/api/risk/risk_reports/retrieve) to track the report status. When the report reaches `COMPLETED` status, obtain a short-lived signed download link. Reports are generated asynchronously. Subscribe to the `risk.risk_reports.completed` and `risk.risk_reports.failed` webhook events to be notified when a report is ready or generation has failed.", "x-displayName": "Risk Reports" }, { "name": "Embedded Finance > Platform Reports", "description": "Generate reports to understand the activity of your Platform account and connected accounts.\n\nUse [Create Platform report](/docs/api/scale/platform_reports/create) to obtain a report id, followed by [Get Platform report](/docs/api/scale/platform_reports/retrieve) to retrieve a download URL for the report once it is ready. Subscribe to the `Platform Report` webhook in the Airwallex webapp to be notified when the report that you have requested is ready. Only files smaller than 100MB can be generated.\n\nCreate scheduled reports by specifying future dates for `to_created_at`, or `to_updated_at`.\n\nReports will be generated at the end of the requested interval, once all data has been captured.\n\nFor example, if `2023-01-10` is the current date, [request a Platform report](/docs/api/scale/platform_reports/create) with `from_created_at` = `2023-01-01` and `to_created_at` = `2023-02-01` to obtain data for January. The scheduled report will be generated after the end of the interval.", "x-displayName": "Platform Reports" }, { "name": "Embedded Finance > Hosted Flows", "description": "Airwallex Hosted Flows enable a Platform to redirect end users into Airwallex-hosted web pages to complete a variety of activity flows. Platforms can deliver hosted flows via a secure, short-lived link unique to each connected account. After completion of a flow, the user is redirected back to the platform. Hosted flows are available for [accounts created via API](/docs/api/scale/accounts/create).\n\n**Currently supported flows:**\n\n * `onboarding` – [Submit KYC information](/docs/connected-accounts/onboarding/kyc-and-onboarding/hosted-onboarding) needed to activate the account.\n\nContact your Airwallex Account Manager to start using hosted flows.\n\nYour Account Manager will create a **flow template**, which defines the series of steps the end user will proceed through. Then, you can create a **flow instance** for a particular connected account and direct users to the provided URL.", "x-displayName": "Hosted Flows" }, { "name": "Embedded Finance > Charges", "description": "A [Scale Charge](/docs/connected-accounts/move-funds/charges) can be used to charge a Connected Account and credit the Platform account's wallet. This action may support processing fees and charges from your clients or business partners. Source Connected Account to be charged must have passed KYC and be in state `ACTIVE`.", "x-displayName": "Charges" }, { "name": "Embedded Finance > Connected Account Transfers", "description": "A [Connected Account Transfer](/docs/connected-accounts/move-funds/connected-account-(ca)-transfers) can be used to send funds directly from a Platform Account or Connected Account to another Account connected to the same platform. Destination Connected Account must have passed KYC and be in state `ACTIVE`.", "x-displayName": "Connected Account Transfers" }, { "name": "Embedded Finance > PSP Settlement Deposits", "description": "A PSP Settlement Deposit is a deposit made by a PSP into a holding account. It is associated with a PSP Settlement Intent.\n\nAirwallex provides the Platform with a **holding account**, set up by a Airwallex Solutions Engineer. Platforms pass payment details to a pay-in PSP for funds acquired by PSPs to be deposited to Airwallex.\n\nPSP Settlement Deposits form part of the [PSP-agnostic payout solution](/docs/payments-for-platforms/psp-agnostic/implement-your-psp-agnostic-solution).", "x-displayName": "PSP Settlement Deposits" }, { "name": "Embedded Finance > PSP Settlement Intents", "description": "A PSP settlement intent represents a settlement with a PSP in a particular currency. Each PSP settlement intent is associated with one or more PSP settlement deposits by `settlement_reference`. \nAfter creating your PSP settlement intent, you can start splitting it, creating one PSP settlement split for each target account. Once you complete splitting your PSP settlement intent, you can submit it and wait for it to be matched with the associated PSP settlement deposit. The sum of the amounts of the PSP settlement splits of a PSP settlement intent should match the sum of the amounts of associated deposits. \nPSP settlement intents form part of the [PSP-agnostic payout solution](/docs/payments-for-platforms/psp-agnostic/implement-your-psp-agnostic-solution).", "x-displayName": "PSP Settlement Intents" }, { "name": "Embedded Finance > PSP Settlement Splits", "description": "Platforms must share PSP Settlement Split information with Airwallex before funds settle to the holding account, by calling the [Split a PSP Settlement Intent API](/docs/api/scale/psp_settlement_splits/split_psp_settlement_intents). This data typically originates from the pay-in PSP's reporting feed.\n\nFunds in the holding account are inaccessible to all parties until the funds are released to other connected accounts. A Platform can choose to [release a PSP Settlement Split](/docs/api/scale/psp_settlement_splits/release) anytime. On release, funds are transferred to a connected account for the recipient, such as a seller.\n\nIf a Platform wants to apply a transaction fee to the seller, they can create one split for the amount due to the seller, and can create another split for the fee to the platform's own account.\nA Platform can trigger a [payout](/docs/api/payouts/transfers) from any connected account to an **external bank account** at any time (for example, at the end of a payout cycle).\nPSP Settlement Splits form part of the [PSP-agnostic payout solution](/docs/payments-for-platforms/psp-agnostic/implement-your-psp-agnostic-solution).", "x-displayName": "PSP Settlement Splits" }, { "name": "Embedded Finance > Offboardings", "description": "The Offboarding API allows platforms to programmatically submit offboarding requests\nfor connected accounts and query the status of submitted offboardings.\n\nCreate an offboarding raises an Airwallex Operations-owned offboarding case for account closure. It\ndiffers from [Suspend account](/docs/api/scale/accounts/suspend), which temporarily\nsuspends an account and can be reversed with\n[Reactivate account](/docs/api/scale/accounts/reactivate). You can create an offboarding for a connected account that is not already\nclosed or pending closure. Create Offboarding is not limited to `ACTIVE` accounts.\nWhile an offboarding is in progress (`PENDING`), the connected account `status` does\nnot change. After it completes successfully (`COMPLETED`), the account enters pending\nclosure and the connected account `status` returned by the client API is `SUSPENDED`\non all API versions. After a 30-day grace period the account is permanently closed;\nfrom API version `2026-08-21` that surfaces as `CLOSED` (earlier versions continue to\nreturn `SUSPENDED`). If multiple connected\naccounts share the same client legal entity, you cannot create an offboarding for\nanother account under that legal entity until the existing offboarding request is\ncompleted. Balance handling during offboarding is managed by Airwallex operations and\nis not available through this API.", "x-displayName": "Offboardings" }, { "name": "Embedded Finance > Platform Liquidity Programs", "description": "Manage platform liquidity programs, spending accounts, transactions, and fund deposit and withdrawal.", "x-displayName": "Platform Liquidity Programs" }, { "name": "Embedded Finance > Accounts", "description": "The Accounts resource represents an Airwallex account, which serves as the main container for a customer’s financial data—including wallet balances, financial transactions, cards, and more. This resource allows customers to retrieve and update account information. For platform customers, it also supports onboarding and managing [Connected Accounts](/docs/connected-accounts/how-connected-accounts-work).", "x-displayName": "Accounts" }, { "name": "Embedded Finance > Invitation Links", "description": "Invitation Links are used by platforms or partners to manage Scale Connect invitation links.", "x-displayName": "Invitation Links" }, { "name": "Security > Activity Log", "description": "Get activity logs of the login account.", "x-displayName": "Activity Log" }, { "name": "Simulation (Sandbox Only) > Billing", "description": "Simulate billing operations in the sandbox environment.", "x-displayName": "Billing" }, { "name": "Simulation (Sandbox Only) > Accounts", "description": "Simulate the [status transition of a connected account](/docs/developer-tools/sandbox-environment/connected-accounts/simulate-connected-account-status-transition) through its lifecycle in the sandbox environment.", "x-displayName": "Accounts" }, { "name": "Simulation (Sandbox Only) > Deposits", "description": "You can receive funds into your [Airwallex Wallet](/docs/global-treasury/understanding-global-treasury/treasury-concepts#wallet) via bank transfers to [Global Accounts](/docs/api/core_resources/global_accounts) or direct debits from [Linked Accounts](/docs/api/core_resources/linked_accounts).\n\nThe Global Accounts deposit simulation API allows you to [simulate a deposit from an external bank account](/docs/developer-tools/sandbox-environment/deposits/simulate-deposits-to-your-global-account) in the sandbox environment.\n\nThe Direct Debit deposit simulation APIs allow you to transition Direct Debit deposit statuses in the sandbox environment.\n", "x-displayName": "Deposits" }, { "name": "Simulation (Sandbox Only) > Issuing", "description": "You can simulate transactions on cards issued by Airwallex and KYC processes of cardholders. Find out more about [generating card issuing transactions](/docs/developer-tools/sandbox-environment/issuing/simulate-transactions-on-issued-cards) and [cardholder status](/docs/issuing/get-started/create-cardholders/cardholder-statuses).", "x-displayName": "Issuing" }, { "name": "Simulation (Sandbox Only) > Linked Accounts", "description": "Simulate the [Linked Account](/docs/developer-tools/sandbox-environment/linked-accounts) lifecycle scenarios in the sandbox environment.", "x-displayName": "Linked Accounts" }, { "name": "Simulation (Sandbox Only) > Payment Acceptance", "description": "Simulate [shopper actions](/docs/developer-tools/sandbox-environment/payments/simulate-shopper-action) on dispute in the sandbox environment.", "x-displayName": "Payment Acceptance" }, { "name": "Simulation (Sandbox Only) > Terminal Simulation", "description": "A Terminal represents a virtual point-of-sale (POS) device registered in the sandbox environment for testing in-person payment flows.", "x-displayName": "Terminal Simulation" }, { "name": "Simulation (Sandbox Only) > Request for Information (RFI)", "description": "Simulate the creation and closure of [RFI](/docs/developer-tools/sandbox-environment/risk/simulate-rfi-sessions) in the sandbox environment.", "x-displayName": "Request for Information (RFI)" }, { "name": "Simulation (Sandbox Only) > Transfers", "description": "Simulate the [transfer lifecycle](/docs/developer-tools/sandbox-environment/payouts/simulate-transfer-status-transition) scenarios in the sandbox environment.", "x-displayName": "Transfers" }, { "name": "Simulation (Sandbox Only) > Offboardings", "description": "Simulate status transitions for connected account offboarding in the sandbox environment.", "x-displayName": "Offboardings" }, { "name": "Spend > Vendors", "description": "Manages [vendor records](/docs/spend/accounts-payable/vendors-via-api) for accounts payable and purchase order workflows. Supports vendor creation, retrieval, listing with filters, and sync status updates for integration with external accounting systems.", "x-displayName": "Vendors" }, { "name": "Spend > Reimbursements", "description": "Manages out-of-pocket expense [reimbursements](/docs/spend/expenses/reimbursements-via-api), including individual requests and grouped reports. Supports approval workflows, receipt attachments, payment processing, and sync with external accounting systems.", "x-displayName": "Reimbursements" }, { "name": "Spend > Purchase Orders", "description": "Manages [purchase orders](/docs/spend/accounts-payable/purchase-orders-via-api) for tracking vendor commitments and spend. Supports creation, retrieval, listing with filters, and sync status updates for integration with external accounting systems.", "x-displayName": "Purchase Orders" }, { "name": "Spend > Expenses", "description": "Manages [expenses](/docs/spend/get-started/get-your-card-expenses) associated with corporate card transactions. Supports approval workflows, receipt attachments, accounting field categorization, line item breakdowns, and sync with external accounting systems.", "x-displayName": "Expenses" }, { "name": "Spend > Bills", "description": "Manages [bills](/docs/spend/accounts-payable/bills-via-api) representing accounts payable obligations. Supports retrieval, listing with filters, and sync status updates for integration with external accounting systems.", "x-displayName": "Bills" }, { "name": "Supporting Services > Connected Stores", "description": "A Connected Store object represents an e-commerce store that is owned by the account and was ever connected to Airwallex.", "x-displayName": "Connected Stores" }, { "name": "Supporting Services > File Service", "description": "Represents files uploaded to Airwallex for secure storage and retrieval via download links. Each file can be referenced in other API endpoints using its unique file identifier.", "x-displayName": "File Service" }, { "name": "Supporting Services > Reference Data", "description": "Reference data made available to support the usage of the Airwallex platform.", "x-displayName": "Reference Data" }, { "name": "Transactional FX > Conversion Amendments", "description": "The [Amendments](/docs/transactional-fx/amendments/conversion-amendments) resource provides the capability to make changes to existing conversions. Right now, the only supported amendment type is a full cancellation.", "x-displayName": "Conversion Amendments" }, { "name": "Transactional FX > Conversion", "description": "The [Conversion](/docs/transactional-fx/get-started/create-a-conversion) resources provide capability to create transactions that convert from one currency into another. The transaction will result in a debit and credit against your wallet balances. Both Quotes and Rates transactions can be created using the Conversion resources.", "x-displayName": "Conversion" }, { "name": "Transactional FX > Quotes", "description": "Create a [quote](/docs/transactional-fx/get-started/choose-your-fx-solution/quotes) that can be used in a subsequent conversion request during the requested validity period.", "x-displayName": "Quotes" }, { "name": "Transactional FX > Rates", "description": "You can retrieve the current [rates](/docs/transactional-fx/get-started/choose-your-fx-solution/rates) that a conversion request would be booked at.", "x-displayName": "Rates" }, { "name": "Webhooks > Webhooks", "description": "Subscribe to real-time events from Airwallex organizations or accounts via [webhooks](/docs/developer-tools/webhooks/webhooks-overview).\n\nThe event types available to you are limited by the [API key scopes](/docs/developer-tools/api/api-key-scopes) granted to the API key used in your authentication.", "x-displayName": "Webhooks" } ], "paths": { "/api/v1/account_capabilities/{id}/enable": { "post": { "tags": [ "Account Capability > Account Capability" ], "summary": "3|Enable an Account Capability", "description": "Submit a request to enable a specific capability for your Airwallex account.", "operationId": "enable", "parameters": [ { "name": "id", "in": "path", "description": "A unique identifier of the requested capability, `transfer_cny_local` for transfer CNY local, or one of `payments_mastercard`, `payments_klarna`, `payments_jcb`, `payments_amex`, `payments_giropay`, `payments_googlepay`, `payments_applepay`, `payments_wechat`, `payments_unionpay`, `payments_visa`, `payments_ideal`, `payments_bancontact`, `payments_sofort`, `payments_bacs_direct_debit`, `payments_airwallex_pay`, `payments_alipaycn`, `payments_alipayhk`, `payments_blik`, `payments_boost`, `payments_dana`, `payments_diners`, `payments_discover`, `payments_doku_ewallet`, `payments_dragonpay`, `payments_duit_now`, `payments_eps`, `payments_fps`, `payments_gcash`, `payments_grabpay_my`, `payments_grabpay_sg`, `payments_kakaopay`, `payments_konbini`, `payments_korean_local_card`, `payments_mybank`, `payments_naver_pay`, `payments_online_banking_kr`, `payments_online_banking_ph`, `payments_online_banking_th`, `payments_p24`, `payments_pay_now`, `payments_payco`, `payments_payeasy`, `payments_paysafecard`, `payments_paysafecash`, `payments_prompt_pay`, `payments_rabbit_line_pay`, `payments_sam_kiosk`, `payments_samsung_pay`, `payments_seven_eleven_my`, `payments_seven_eleven_tw`, `payments_shopee_pay`, `payments_skrill`, `payments_tesco_lotus`, `payments_tng`, `payments_truemoney`, `payments_trustly`, `payments_ach_direct_debit`, `payments_alfamart`, `payments_atome`, `payments_axs_kiosk`, `payments_bank_transfer_id`, `payments_bank_transfer_kr`, `payments_bitpay`, `payments_eft_direct_debit`, `payments_enets`, `payments_esun`, `payments_family_mart`, `payments_fpx`, `payments_go_pay`, `payments_hi_life`, `payments_indomaret`, `payments_jenius_pay`, `payments_linkaja`, `payments_maxima`, `payments_multibanco`, `payments_narvesen`, `payments_online_banking_ee`, `payments_online_banking_lt`, `payments_online_banking_lv`, `payments_ovo`, `payments_paybybankapp`, `payments_paypal`, `payments_paypost`, `payments_paysera`, `payments_payu`, `payments_perlas_terminals`, `payments_permata_atm`, `payments_satispay`, `payments_sepa_direct_debit`, `payments_upi`, `payments_zip`, `payments_line_pay`, `payments_paypay`, `payments_payeasy_atm`, `payments_toss_pay`, `payments_spei`, `payments_venmo`, `payments_afterpay`, `payments_payto`, `payments_birdpay`, `payments_twint`, `payments_bank_transfer`, `payments_cash_app_pay`, `payments_lumi`, `payments_pix`, `payments_seven_eleven_jp`, `payments_payme`, `payments_jkopay`, `payments_shopee_pay_id`, `payments_shopee_pay_sg`, `payments_shopee_pay_th`, `payments_shopee_pay_ph`, `payments_shopee_pay_vn`, `payments_shopee_pay_my`, `payments_spaylater_id`, `payments_spaylater_my`, `payments_spaylater_sg`, `payments_spaylater_th`, `payments_spaylater_ph`, `payments_spaylater_vn`, `payments_bc`, `payments_hana`, `payments_hyundai`, `payments_kb`, `payments_lotte`, `payments_nh`, `payments_samsung`, `payments_shinhan`, `payments_woori`, `payments_laybuy`, `payments_tabby`, `payments_octopus`, `payments_wero`, `payments_airi`, `payments_affirm`, `payments_bizum`, `payments_swish`, `payments_cartes_bancaires`, `payments_mbway`, `payments_becs_direct_debit` for payment methods.", "required": true, "schema": { "type": "string" }, "examples": { "payment_method": { "value": "account_capability_id" }, "transfer_cny_local": { "value": "account_capability_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Capabilities", "oneOf": [ { "title": "Payment Method", "type": "object", "required": [ "id" ], "properties": { "enroll_sme_program": { "type": "boolean", "description": "Whether enroll SME program." }, "id": { "type": "string", "description": "A unique identifier of the requested capability." } } }, { "title": "Transfer CNY Local", "type": "object", "required": [ "entity_type", "id" ], "properties": { "business_declarant_info": { "type": "object", "required": [ "bank_details", "contact_email" ], "description": "Declarant info as business.", "properties": { "bank_details": { "type": "object", "required": [ "account_number", "bank_name", "cnaps_code" ], "description": "Declarant's bank account details for verifying the Declarant's identity.", "properties": { "account_number": { "type": "string", "description": "Bank account number." }, "bank_name": { "type": "string", "description": "Bank name of the Declarant's bank account." }, "cnaps_code": { "type": "string", "description": "CNAPS routing code." }, "mobile_number": { "type": "string", "description": "Mobile number associated with the Declarant's bank account." } } }, "contact_email": { "type": "string", "description": "Declarant business email." }, "economic_category_code": { "type": "string", "description": "Economic category code for the Declarant business, one of `100`,`110`,`120`,`130`,`140`,`141`,`142`,`143`,`149`,`150`,`151`,`159`,`160`,`170`,`171`,`172`,`173`,`174`,`175`,`179`,`190`,`200`,`210`,`220`,`230`,`240`,`290`,`300`,`310`,`320`,`330`,`340`,`390`,`400`,`900`." }, "is_special_economic_zone": { "type": "boolean", "description": "Whether the business is registered in a special economic zone." }, "special_economic_zone_business_type": { "type": "string", "description": "Code to identify the specific special economic zone, one of `00`,`01`,`02`,`03`,`04`,`05`,`06`,`07`,`08`,`09`,`10`,`11`,`12`,`60`,`99`." } } }, "entity_type": { "type": "string", "description": "The type of entity of your declarant, one of `INDIVIDUAL`, `BUSINESS`." }, "id": { "type": "string", "description": "A unique identifier of the requested capability." }, "individual_declarant_info": { "type": "object", "required": [ "bank_details", "contact_email", "person_id" ], "description": "Declarant info as an individual.", "properties": { "bank_details": { "type": "object", "required": [ "account_number", "bank_name", "mobile_number" ], "description": "Details of Bank belong to the person assigned by `person_id`.", "properties": { "account_number": { "type": "string", "description": "Bank account number." }, "bank_name": { "type": "string", "description": "Bank name of the Declarant's bank account." }, "cnaps_code": { "type": "string", "description": "CNAPS routing code." }, "mobile_number": { "type": "string", "description": "Mobile number associated with the Declarant's bank account." } } }, "contact_email": { "type": "string", "description": "Declarant's personal email." }, "person_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the legal representative or beneficial owner." } } } } } ] }, "examples": { "payment_method": { "value": { "enroll_sme_program": true, "id": "payments_mastercard" } }, "transfer_cny_local": { "value": { "business_declarant_info": { "bank_details": { "account_number": "4682037906128888", "bank_name": "中国银行", "cnaps_code": "104100000004", "mobile_number": "13531632875" }, "contact_email": "contact@airwallex.com", "economic_category_code": "171", "is_special_economic_zone": false, "special_economic_zone_business_type": "12" }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "individual_declarant_info": { "bank_details": { "account_number": "4682037906128888", "bank_name": "中国银行", "cnaps_code": "104100000004", "mobile_number": "13531632875" }, "contact_email": "contact@airwallex.com", "person_id": "300d62e0-32e0-4cd4-8e08-ccfb8bc5a944" } } } } } }, "description": "Dynamic with specific capability id." }, "responses": { "200": { "description": "acknowledged", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" }, "examples": { "payment_method": { "value": { "comment": "string", "details": { "reason_codes": [] }, "entity_type": "BUSINESS", "id": "payments_mastercard", "status": "PENDING", "updated_at": "2023-04-01T11:25:39+0000" } }, "transfer_cny_local": { "value": { "comment": "string", "details": { "reason_codes": [ "string" ] }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } } } } } }, "400": { "description": "[`\"bad_request\"`\n,`\"field_required\"`\n`\"invalid_person\"`\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "payment_method", "name": "Payment Method", "method": "POST", "uri": "/api/v1/account_capabilities/account_capability_id/enable", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "enroll_sme_program": true, "id": "payments_mastercard" }, "response_body": { "comment": "string", "details": { "reason_codes": [] }, "entity_type": "BUSINESS", "id": "payments_mastercard", "status": "PENDING", "updated_at": "2023-04-01T11:25:39+0000" } }, { "key": "transfer_cny_local", "name": "Transfer CNY Local", "method": "POST", "uri": "/api/v1/account_capabilities/account_capability_id/enable", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "business_declarant_info": { "bank_details": { "account_number": "4682037906128888", "bank_name": "中国银行", "cnaps_code": "104100000004", "mobile_number": "13531632875" }, "contact_email": "contact@airwallex.com", "economic_category_code": "171", "is_special_economic_zone": false, "special_economic_zone_business_type": "12" }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "individual_declarant_info": { "bank_details": { "account_number": "4682037906128888", "bank_name": "中国银行", "cnaps_code": "104100000004", "mobile_number": "13531632875" }, "contact_email": "contact@airwallex.com", "person_id": "300d62e0-32e0-4cd4-8e08-ccfb8bc5a944" } }, "response_body": { "comment": "string", "details": { "reason_codes": [ "string" ] }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "account_capability:write", "group": "Account Capabilities", "resource_name": "Account Capabilities", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/account_capabilities/funding_limits": { "get": { "tags": [ "Account Capability > Account Capability" ], "summary": "4|List all Funding Limits", "description": "Before initiating a Direct Debit from a Linked Account or as a Funding Source, you may wish to query the available funding limit or Faster Direct Debit limit.", "operationId": "listFundingLimits", "parameters": [ { "name": "ccy", "in": "query", "description": "Specify the currency the limit will be displayed in. A single limit is applied for the entire customer, regardless of the display currency.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "effective_at", "in": "query", "description": "The timestamp at which the customer's funding limit becomes effective.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "mandate_type", "in": "query", "description": "The settlement method or clearing system.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "Page size.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/FundingLimitResult" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "availables": { "SAME_DAY_ACH": "25000", "NEXT_DAY_ACH": "12000" }, "currency": "USD", "effective_at": "2022-08-22T01:23:00+0000", "limit": 30000, "mandate_type": "US_ACH_DEBIT", "requested_limit": 100000, "status": "ACTIVE", "type": "DIRECT_DEBIT_DEPOSIT", "updated_at": "2022-08-22T01:23:00+0000" } ] } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/account_capabilities/funding_limits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "availables": { "SAME_DAY_ACH": "25000", "NEXT_DAY_ACH": "12000" }, "currency": "USD", "effective_at": "2022-08-22T01:23:00+0000", "limit": 30000, "mandate_type": "US_ACH_DEBIT", "requested_limit": 100000, "status": "ACTIVE", "type": "DIRECT_DEBIT_DEPOSIT", "updated_at": "2022-08-22T01:23:00+0000" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "account_capability:read", "group": "Account Capabilities", "resource_name": "Account Capabilities", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/account_capabilities/{id}": { "get": { "tags": [ "Account Capability > Account Capability" ], "summary": "1|Retrieve an Account Capability", "description": "Get the status of a capability by providing the capability unique identifier.", "operationId": "retrieveAccountCapability", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "payments_visa" }, "transfer_cny_local": { "value": "transfer_cny_local" } } } ], "responses": { "200": { "description": "success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" }, "examples": { "default": { "value": { "comment": "", "details": { "reason_codes": [], "mcc": "5812", "mcc_candidates": [ "5812", "5814" ] }, "entity_type": "BUSINESS", "id": "payments_visa", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } }, "transfer_cny_local": { "value": { "comment": "", "details": { "reason_codes": [] }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } } } } } }, "400": { "description": "[`\"capability_not_supported\"`\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "Payment Method", "method": "GET", "uri": "/api/v1/account_capabilities/payments_visa", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "comment": "", "details": { "reason_codes": [], "mcc": "5812", "mcc_candidates": [ "5812", "5814" ] }, "entity_type": "BUSINESS", "id": "payments_visa", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } }, { "key": "transfer_cny_local", "name": "Transfer CNY Local", "method": "GET", "uri": "/api/v1/account_capabilities/transfer_cny_local", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "comment": "", "details": { "reason_codes": [] }, "entity_type": "INDIVIDUAL", "id": "transfer_cny_local", "status": "ENABLED", "updated_at": "2023-04-01T11:25:39+0000" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "account_capability:read", "group": "Account Capabilities", "resource_name": "Account Capabilities", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/accounting/accounting_field_values/create": { "post": { "tags": [ "Accounting > Accounting Field Values" ], "summary": "1|Create an Accounting Field Value", "description": "Creates a new accounting field value for coding Airwallex Spend transactions.", "operationId": "createAccountingFieldValue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "accounting_field_id", "value" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. Generate a random UUID to prevent accidental duplication." }, "accounting_field_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the parent accounting field." }, "value": { "type": "string", "description": "Accounting field value name." }, "value_label": { "type": "string", "description": "Airwallex display name for the accounting field value." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this accounting field value applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] } } } } } }, "responses": { "201": { "description": "Accounting field value created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingFieldValue" }, "examples": { "default": { "value": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/accounting_field_values/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:write", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_field_values": { "get": { "tags": [ "Accounting > Accounting Field Values" ], "summary": "3|List all Accounting Field Values", "description": "Returns accounting field values used in Airwallex Spend, filtered by the specified query parameters.", "operationId": "listAccountingFieldValues", "parameters": [ { "name": "accounting_field_id", "in": "query", "description": "Filter by accounting field ID.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve the next or previous page of results.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "status", "in": "query", "description": "Filter by accounting field value status.", "required": false, "schema": { "$ref": "#/components/schemas/AccountingResourceStatus" } }, { "name": "external_id", "in": "query", "description": "Filter by external ID.", "required": false, "schema": { "type": "string" } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity ID.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingFieldValuePagination" }, "examples": { "default": { "value": { "items": [ { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/accounting_field_values", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:read", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_field_values/{id}": { "get": { "tags": [ "Accounting > Accounting Field Values" ], "summary": "2|Retrieve an Accounting Field Value", "description": "Retrieves an existing accounting field value used in Airwallex Spend.", "operationId": "retrieveAccountingFieldValue", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the accounting field value.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingFieldValue" }, "examples": { "default": { "value": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/accounting_field_values/4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:read", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_field_values/{id}/update": { "post": { "tags": [ "Accounting > Accounting Field Values" ], "summary": "4|Update an Accounting Field Value", "description": "Updates an existing accounting field value used in Airwallex Spend.", "operationId": "updateAccountingFieldValue", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the accounting field value.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "accounting_field_id", "value", "status" ], "properties": { "accounting_field_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the parent accounting field." }, "value": { "type": "string", "description": "Accounting field value name." }, "value_label": { "type": "string", "description": "Airwallex display name for the accounting field value." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this accounting field value applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" } } }, "examples": { "default": { "value": { "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" } } } } } }, "responses": { "200": { "description": "Accounting field value updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingFieldValue" }, "examples": { "default": { "value": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/accounting_field_values/4b8d83d6-70c4-429d-8a0b-bb3281f6b17f/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "accounting_field_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "RSG1", "value_label": "Singapore | RSG1", "external_id": "RSG1", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:write", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_fields/create": { "post": { "tags": [ "Accounting > Accounting Fields" ], "summary": "1|Create an Accounting Field", "description": "Creates a new custom accounting field for Airwallex Spend.", "operationId": "createAccountingField", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "name" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. Generate a random UUID to prevent accidental duplication." }, "name": { "$ref": "#/components/schemas/AccountingFieldName" }, "name_label": { "type": "string", "description": "Airwallex display name for the accounting field." } } }, "examples": { "default": { "value": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "name": "Custom field 1", "name_label": "Region" } } } } } }, "responses": { "201": { "description": "Accounting field created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingField" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/accounting_fields/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "name": "Custom field 1", "name_label": "Region" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:write", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_fields": { "get": { "tags": [ "Accounting > Accounting Fields" ], "summary": "3|List all Accounting Fields", "description": "Returns custom accounting fields used in Airwallex Spend.", "operationId": "listAccountingFields", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve the next or previous page of results.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "status", "in": "query", "description": "Filter by accounting field status.", "required": false, "schema": { "$ref": "#/components/schemas/AccountingResourceStatus" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingFieldPagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/accounting_fields", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:read", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_fields/{id}": { "get": { "tags": [ "Accounting > Accounting Fields" ], "summary": "2|Retrieve an Accounting Field", "description": "Retrieves an existing custom accounting field used in Airwallex Spend.", "operationId": "retrieveAccountingField", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the accounting field.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingField" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/accounting_fields/985461d5-016f-4e1f-a387-5f1380b42d92", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:read", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/accounting_fields/{id}/update": { "post": { "tags": [ "Accounting > Accounting Fields" ], "summary": "4|Update an Accounting Field", "description": "Updates an existing custom accounting field used in Airwallex Spend.", "operationId": "updateAccountingField", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the accounting field.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/AccountingFieldName" }, "name_label": { "type": "string", "description": "Airwallex display name for the accounting field." } } }, "examples": { "default": { "value": { "name": "Custom field 1", "name_label": "APAC Region" } } } } } }, "responses": { "200": { "description": "Accounting field updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingField" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "APAC Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/accounting_fields/985461d5-016f-4e1f-a387-5f1380b42d92/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "name": "Custom field 1", "name_label": "APAC Region" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "name": "Custom field 1", "name_label": "APAC Region", "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.field:write", "group": "Accounting", "resource_name": "Fields", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/gl_accounts/create": { "post": { "tags": [ "Accounting > General Ledger Accounts" ], "summary": "1|Create a General Ledger Account", "description": "Creates a new General Ledger (GL) account for coding Airwallex Spend transactions.", "operationId": "createGLAccount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "value" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. Generate a random UUID to prevent accidental duplication." }, "code": { "type": "string", "description": "General ledger account code." }, "value": { "type": "string", "description": "General ledger account name." }, "value_label": { "type": "string", "description": "Airwallex display name for the general ledger account." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this general ledger account applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] } } } } } }, "responses": { "201": { "description": "General ledger account created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccount" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/gl_accounts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.gl_account:write", "group": "Accounting", "resource_name": "GL Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/gl_accounts": { "get": { "tags": [ "Accounting > General Ledger Accounts" ], "summary": "3|List all General Ledger Accounts", "description": "Returns General Ledger (GL) accounts used in Airwallex Spend, filtered by the specified query parameters.", "operationId": "listGLAccounts", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve the next or previous page of results.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "status", "in": "query", "description": "Filter by general ledger account status.", "required": false, "schema": { "$ref": "#/components/schemas/AccountingResourceStatus" } }, { "name": "external_id", "in": "query", "description": "Filter by external ID.", "required": false, "schema": { "type": "string" } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity ID.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccountPagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/gl_accounts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.gl_account:read", "group": "Accounting", "resource_name": "GL Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/gl_accounts/{id}": { "get": { "tags": [ "Accounting > General Ledger Accounts" ], "summary": "2|Retrieve a General Ledger Account", "description": "Retrieves an existing General Ledger (GL) account used in Airwallex Spend.", "operationId": "retrieveGLAccount", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the general ledger account.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccount" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/gl_accounts/985461d5-016f-4e1f-a387-5f1380b42d92", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.gl_account:read", "group": "Accounting", "resource_name": "GL Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/gl_accounts/{id}/update": { "post": { "tags": [ "Accounting > General Ledger Accounts" ], "summary": "4|Update a General Ledger Account", "description": "Updates an existing General Ledger (GL) account used in Airwallex Spend.", "operationId": "updateGLAccount", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the general ledger account.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "status" ], "properties": { "code": { "type": "string", "description": "General ledger account code." }, "value": { "type": "string", "description": "General ledger account name." }, "value_label": { "type": "string", "description": "Airwallex display name for the general ledger account." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this general ledger account applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" } } }, "examples": { "default": { "value": { "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" } } } } } }, "responses": { "200": { "description": "General ledger account updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccount" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/gl_accounts/985461d5-016f-4e1f-a387-5f1380b42d92/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "code": "601022001-2", "value": "Travel Costs-Domestic-Transportation -2", "value_label": "Travel-Domestic-Flight | 601022001", "external_id": "601022001-2", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.gl_account:write", "group": "Accounting", "resource_name": "GL Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/tax_codes/create": { "post": { "tags": [ "Accounting > Tax Codes" ], "summary": "1|Create a Tax Code", "description": "Creates a new tax code for coding Airwallex Spend transactions.", "operationId": "createTaxCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "value", "rate_percent" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. Generate a random UUID to prevent accidental duplication." }, "value": { "type": "string", "description": "Tax code name as defined in the accounting system." }, "rate_percent": { "type": "string", "description": "Tax rate value as a decimal percentage." }, "value_label": { "type": "string", "description": "Airwallex display name for the tax code." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this tax code applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] } } } } } }, "responses": { "201": { "description": "Tax code created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCode" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/tax_codes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "4b8d83d6-70c4-429d-8a0b-bb3281f6b17f", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ] }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-01-01T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.tax_code:write", "group": "Accounting", "resource_name": "Tax Codes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/tax_codes": { "get": { "tags": [ "Accounting > Tax Codes" ], "summary": "3|List all Tax Codes", "description": "Returns tax codes used in Airwallex Spend, filtered by the specified query parameters.", "operationId": "listTaxCodes", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve the next or previous page of results.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "status", "in": "query", "description": "Filter by tax code status.", "required": false, "schema": { "$ref": "#/components/schemas/AccountingResourceStatus" } }, { "name": "external_id", "in": "query", "description": "Filter by external ID.", "required": false, "schema": { "type": "string" } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity ID.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCodePagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } } } } }, "400": { "description": "Invalid request." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/tax_codes", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlIjoiMiJ9" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.tax_code:read", "group": "Accounting", "resource_name": "Tax Codes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/tax_codes/{id}": { "get": { "tags": [ "Accounting > Tax Codes" ], "summary": "2|Retrieve a Tax Code", "description": "Retrieves an existing tax code used in Airwallex Spend.", "operationId": "retrieveTaxCode", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the tax code.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCode" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounting/tax_codes/985461d5-016f-4e1f-a387-5f1380b42d92", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.tax_code:read", "group": "Accounting", "resource_name": "Tax Codes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/accounting/tax_codes/{id}/update": { "post": { "tags": [ "Accounting > Tax Codes" ], "summary": "4|Update a Tax Code", "description": "Updates an existing tax code used in Airwallex Spend.", "operationId": "updateTaxCode", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the tax code.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "985461d5-016f-4e1f-a387-5f1380b42d92" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "rate_percent", "status" ], "properties": { "value": { "type": "string", "description": "Tax code name as defined in the accounting system." }, "rate_percent": { "type": "string", "description": "Tax rate value as a decimal percentage." }, "value_label": { "type": "string", "description": "Airwallex display name for the tax code." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this tax code applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" } } }, "examples": { "default": { "value": { "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" } } } } } }, "responses": { "200": { "description": "Tax code updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCode" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounting/tax_codes/985461d5-016f-4e1f-a387-5f1380b42d92/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "value": "9", "rate_percent": "9.0000", "value_label": "9%", "external_id": "9", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg" ], "status": "ACTIVE", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "accounting.tax_code:write", "group": "Accounting", "resource_name": "Tax Codes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/authentication/authorize": { "post": { "tags": [ "Authentication > Embedded Components" ], "summary": "1|Authorize an Account", "description": "Authorize the platform itself, or a connected account with header `x-on-behalf-of` to use embedded components.\n\nPlatforms can embed core Airwallex functionalities directly into their website through our pre-built components, avoiding a redirect experience. Key features include:\n * Dynamic adjustment of UI to meet local compliance requirements, based on country and business model\n * Conversion-optimized flow leveraging Airwallex’s own product improvements\n * Customized theming to reflect your company’s brand\n\nFor a list of components supported via this API, see Payouts, Onboarding, Risk and Compliance support in [Airwallex.js](/docs/js).\n\nContact your Airwallex Account Manager to start using components.", "operationId": "embeddedComponents_authorize", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "Unique ID of the connected account that this request is made on behalf of.", "required": false, "schema": { "type": "string" }, "examples": { "authorize-connected-account": { "value": "acct_JD0UmuRLNcytX7sBj0lfWA" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code_challenge", "scope" ], "properties": { "code_challenge": { "type": "string", "description": "A challenge token generated together with the `code_verifier` by your application with the S256 generation method, which references the Oauth design as described in [RFC 7636 Section 4](https://datatracker.ietf.org/doc/html/rfc7636#section-4)." }, "identity": { "type": "string", "description": "Used for embedded SCA. It's the platform’s identifier for the user, such as a user unique identifier." }, "scope": { "type": "array", "description": "The scopes indicate the resources your application is allowed to access. The value should be expressed as a list. Currently supported scopes:\n * `onboarding:write`: used by the embedded onboarding component.\n * `transfer:write`: used by the embedded payout component and the embedded beneficiary component.\n * `kyb:write`: used by the embedded KYB component.\n * `rfi:read`: used by the embedded RFI component to view open RFIs.\n * `rfi:write`: used by the embedded RFI component to edit and submit responses to RFIs.\n * `sca:read`: used by the embedded SCA component to get the context of SCA.\n * `sca:write`: used by the embedded SCA component to set up or change the authentication factors of SCA.\n * `tax_form:read`: used by the embedded tax form component to get details of tax forms.\n * `tax_form:write`: used by the embedded tax form component to create or edit tax forms.", "items": { "type": "string" } } } }, "examples": { "authorize-platform": { "value": { "code_challenge": "aNggeDw6KT4422DzzGe1RUZC2DJ-cpLi3hM8b7YRFeE", "identity": "089cc0ec-0a6f-4150-9f66-365432178035", "scope": [ "transfer:write" ] } }, "authorize-connected-account": { "value": { "code_challenge": "aNggeDw6KT4422DzzGe1RUZC2DJ-cpLi3hM8b7YRFeE", "identity": "089cc0ec-0a6f-4150-9f66-365432178035", "scope": [ "onboarding:write" ] } } } } }, "description": "Request to authorize to use embedded components.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DropInSDKAuthorizeRes" }, "examples": { "authorize-platform": { "value": { "authorization_code": "Du7J_zbDL3epWNJ2wa7Merdz9yc_iuSOTZ8LXWYagNYH" } }, "authorize-connected-account": { "value": { "authorization_code": "Du7J_zbDL3epWNJ2wa7Merdz9yc_iuSOTZ8LXWYagNYH" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "authorize-platform", "name": "Authorize the platform itself", "method": "POST", "uri": "/api/v1/authentication/authorize", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "code_challenge": "aNggeDw6KT4422DzzGe1RUZC2DJ-cpLi3hM8b7YRFeE", "identity": "089cc0ec-0a6f-4150-9f66-365432178035", "scope": [ "transfer:write" ] }, "response_body": { "authorization_code": "Du7J_zbDL3epWNJ2wa7Merdz9yc_iuSOTZ8LXWYagNYH" } }, { "key": "authorize-connected-account", "name": "Authorize a connected account", "method": "POST", "uri": "/api/v1/authentication/authorize", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json", "x-on-behalf-of": "acct_JD0UmuRLNcytX7sBj0lfWA" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "code_challenge": "aNggeDw6KT4422DzzGe1RUZC2DJ-cpLi3hM8b7YRFeE", "identity": "089cc0ec-0a6f-4150-9f66-365432178035", "scope": [ "onboarding:write" ] }, "response_body": { "authorization_code": "Du7J_zbDL3epWNJ2wa7Merdz9yc_iuSOTZ8LXWYagNYH" } } ], "security": [], "x-oauthSupported": false, "x-oboSupported": false, "x-resourceLevel": "account" } }, "/api/v1/authentication/login": { "post": { "tags": [ "Authentication > Authentication" ], "summary": "1|Obtain Access Token", "description": "Obtain an access token by specifying your `x-client-id` and `x-api-key` in the HTTP request header. Include the access token you receive in the `Authorization: Bearer [token]` header when calling other endpoints. The access token remains valid for 30 minutes and can be reused until it expires. Always refer to the `expires_at` field for the exact expiration time. \n\nIf your scoped API key includes permissions for multiple accounts, include the `x-login-as` header to specify the target account that the returned access token is authorized for. If the scoped API key also includes organization-level permissions, the access token would automatically have access to organization-level resources. For more details, see [Manage API keys](/docs/developer-tools/api/manage-api-keys).", "operationId": "authentication_login", "parameters": [ { "name": "x-api-key", "in": "header", "description": "API key provided by Airwallex.", "required": true, "schema": { "type": "string", "default": "72c0a50d840626050145ccf72b733e32f31bb21323d493f9d00290b37676a138bcdf1d6415d9f08aad117450e23a4f4f" }, "examples": { "default": { "value": "" }, "default_for_account": { "value": "" } } }, { "name": "x-client-id", "in": "header", "description": "Client unique identifier provided by Airwallex.", "required": true, "schema": { "type": "string", "default": "5f1vUssbSnq45temBX6CnB" }, "examples": { "default": { "value": "" }, "default_for_account": { "value": "" } } }, { "name": "x-login-as", "in": "header", "description": "Account unique identifier to be used for authentication.", "required": false, "schema": { "type": "string", "default": "acct_LTwYEh8EPa2yiA3dCoBEVA" }, "examples": { "default_for_account": { "value": "" } } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" }, "examples": { "default": { "value": { "token": "eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjQwMDAwMDAsImV4cCI6MTYyNDAwMTgwMH0.example", "expires_at": "2021-06-18T16:30:00+0000" } }, "default_for_account": { "value": { "token": "eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjQwMDAwMDAsImV4cCI6MTYyNDAwMTgwMH0.example", "expires_at": "2021-06-18T16:30:00+0000" } } } } } }, "400": { "description": "Bad request. Data provided is either incomplete or malformed." }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "403": { "description": "Forbidden. The request was denied due to insufficient permissions" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "Authenticate with a given API key", "method": "POST", "uri": "/api/v1/authentication/login", "request_headers": { "x-api-key": "", "x-client-id": "" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "token": "eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjQwMDAwMDAsImV4cCI6MTYyNDAwMTgwMH0.example", "expires_at": "2021-06-18T16:30:00+0000" } }, { "key": "default_for_account", "name": "Authenticate with a given API key for a given account", "method": "POST", "uri": "/api/v1/authentication/login", "request_headers": { "x-api-key": "", "x-client-id": "", "x-login-as": "" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "token": "eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MjQwMDAwMDAsImV4cCI6MTYyNDAwMTgwMH0.example", "expires_at": "2021-06-18T16:30:00+0000" } } ], "security": [], "x-oauthSupported": false, "x-oboSupported": false, "x-resourceLevel": "account" } }, "/api/v1/billing/billing_checkouts/{id}/cancel": { "post": { "description": "A Billing Checkout in ACTIVE status can be cancelled. Once cancelled, the customer will no longer be able to complete the checkout and will see an error message when attempting to load it.", "operationId": "billingCheckouts_cancel", "parameters": [ { "description": "ID of the Billing Checkout.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_checkout_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Checkout" }, "examples": { "default": { "value": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Cancel a Billing Checkout", "tags": [ "Billing > Billing Checkouts" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/billing_checkouts/billing_checkout_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.checkout:write", "group": "Billing", "resource_name": "Billing Checkouts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_checkouts/create": { "post": { "description": "Creates a Billing Checkout object.", "operationId": "createBillingCheckout", "requestBody": { "content": { "application/json": { "schema": { "required": [ "mode", "request_id" ], "type": "object", "properties": { "back_url": { "type": "string", "description": "If set, the hosted checkout page displays a back button which allows customers to cancel the flow and be directed to this URL." }, "billing_customer_id": { "type": "string", "description": "ID of the billing customer to reference the Billing Checkout. The customer's profile will be used to prefill the email, name, billing address and tax identification number during the checkout process. If provided, the customer can either choose a saved payment source for this checkout, or checkout a new payment method. \nRequired in `SETUP` mode." }, "currency": { "type": "string", "description": "The checkout currency in 3-letter ISO-4217 format. Required in `SETUP` mode." }, "customer_data": { "type": "object", "description": "The prefilled information of the customer. Only applicable when `billing_customer_id` is not provided. \nNot applicable in `SETUP` mode.", "properties": { "email": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The prefilled email of the customer.\nIf this field or a `billing_customer_id` with an email on file is provided, the email will be prefilled and will not be editable during checkout.\nIf neither is provided, Billing Checkout will prompt the customer to enter their email during the checkout process." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The prefilled name of the customer.\nIf this field or a `billing_customer_id` with a name on file is provided, the name will be prefilled and will not be editable during checkout.\nIf neither is provided, Billing Checkout will prompt the customer to enter their name during checkout." }, "type": { "type": "string", "description": "Type of the billing customer, one of `BUSINESS` or `INDIVIDUAL`.\nIf not provided, an \"I am purchasing as a business\" checkbox will be displayed during checkout for the customer to self-select." } } }, "customer_data_collection": { "type": "object", "description": "Provides configuration for the Billing Checkout to collect information from customers.", "properties": { "billing_address": { "pattern": "^(AUTO|REQUIRED)$", "type": "string", "description": "Controls whether the billing address will be collected during checkout.\n- `AUTO`: Billing address will only be collected when necessary. Specifically, when automatic tax is enabled, or tax_id is collected.\n- `REQUIRED`: Billing address will always be collected.\nDefaults to `AUTO`." }, "tax_id": { "pattern": "^(DISABLED|OPTIONAL_IF_SUPPORTED|REQUIRED_IF_SUPPORTED)$", "type": "string", "description": "Controls whether the tax ID will be collected for business customer during checkout. One of `OPTIONAL_IF_SUPPORTED`, `DISABLED`, `REQUIRED_IF_SUPPORTED`.\n- `DISABLED`: Tax id will not be collected.\n- `OPTIONAL_IF_SUPPORTED`: Tax id will be optionally collected in the supported countries, by displaying a checkbox \"I am purchasing as business\".\n- `REQUIRED_IF_SUPPORTED`: Tax id will always be collected if the country is in the supported list.\nDefaults to `OPTIONAL_IF_SUPPORTED`." } } }, "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "List of discounts to be applied to the subscription. Discounts of subscription items are applied before subscription discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this checkout. When enabled, the system attempts to calculate taxes for this checkout's invoice automatically. Defaults to `false`." }, "hosted_completion_page": { "required": [ "display" ], "type": "object", "description": "Configuration for the Airwallex-hosted completion page. Only applicable when `ui_mode` is `HOSTED`.", "properties": { "display": { "type": "boolean", "description": "Whether to display the Airwallex-hosted completion page after checkout is completed and before the customer is redirected to `success_url`." } } }, "invoice_data": { "type": "object", "description": "The settings of invoice to be passed to the invoice creation upon completion of the Billing Checkout in `PAYMENT` mode.", "properties": { "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due.", "format": "int32" }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax rate between 0 and 100(%) to be applied to invoices to be generated. The tax will be exclusive. Defaults to 0." }, "due_at": { "type": "string", "description": "Due date set by the merchant for this invoice, if any. Only one of `days_until_due` and `due_at` should be passed." }, "memo": { "maxLength": 200, "minLength": 0, "type": "string", "description": "String used for merchants to share a custom message to their customers. Referenced as memo or invoice note in Webapp." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." } } }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings. Required if you have more than 1 entity in your organisation." }, "line_items": { "type": "array", "description": "A list of items the customer is purchasing. Required when the mode is `SUBSCRIPTION` or `PAYMENT`. Not applicable when the mode is `SETUP`. \nFor `SUBSCRIPTION` mode, all the line items must have a recurring Price or Rate Card Version. \nFor `PAYMENT` mode, all the line items must have a non-recurring Price.", "items": { "type": "object", "properties": { "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "List of discounts to be applied to the line items. Discounts of line items are applied before subscription or invoice discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "price": { "required": [ "currency" ], "type": "object", "description": "One-time price definition following the same schema as the [Price](/docs/api/billing/prices) resource. Exactly one of `price_id` or `price` is required.\nOnly applicable to `PAYMENT` mode.", "properties": { "currency": { "type": "string", "description": "Currency of the price (in 3-letter ISO-4217 format)." }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Price description. Used for internal classification and identification." }, "flat_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom key-value pairs attached to the price." }, "description": "Custom key-value pairs attached to the price." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity.\nDefaults to `PER_UNIT`." }, "product": { "required": [ "name" ], "type": "object", "description": "One-time product definition following the same schema as the [Product](/docs/api/billing/products). Exactly one of `product_id` or `product` is required.", "properties": { "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Product description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Product name." }, "tax_code": { "type": "string", "description": "The tax category of the product." }, "unit": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Product unit." } } }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object. Exactly one of `product_id` or `product` is required." }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax. Defaults to `false`." }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." } } }, "price_id": { "type": "string", "description": "ID of the [Price](/docs/api/billing/prices) object. Exactly one of `price_id`, `price`, or `rate_card_id` is required." }, "quantity": { "minimum": 1, "type": "integer", "description": "The quantity of the line item being purchased. Defaults to `1`.", "format": "int32" }, "rate_card_id": { "type": "string", "description": "ID of the [Rate Card](/docs/api/billing/rate_cards) object. Exactly one of `price_id`, `price`, or `rate_card_id` is required. Only applicable to `SUBSCRIPTION` mode." }, "rate_card_version": { "type": "integer", "description": "Pinned Rate Card version number. Required when `rate_card_id` is set.", "format": "int32" }, "tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The effective tax percent of this line item." } } } }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section. Required if you have more than 1 payment account in your organisation." }, "locale": { "type": "string", "description": "A code, in IETF language format, that determines the language and formatting displayed to customers on the checkout UI, and can be one of: `AUTO`, `EN`, `ZH`. \nIf set to `AUTO` the customer's browser locale is used." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "mode": { "pattern": "^(SUBSCRIPTION|PAYMENT|SETUP)$", "type": "string", "description": "The mode of the Billing Checkout object, can be one of: \n`SUBSCRIPTION`: Set up subscriptions. \n`PAYMENT`: Accept one-off payments. \n`SETUP`: Collect payment details to charge your customers later." }, "payment_options": { "type": "object", "description": "Payment settings of this Billing Checkout.", "properties": { "pay_by_invoice_enabled": { "type": "boolean", "description": "Enables the option to \"Request an invoice\" for payment. After the customer confirms to pay with this option, the status of Billing Checkout will transit to COMPLETED, and an invoice will be generated. The invoice will inherit the payment_options of this Billing Checkout, and other configurations in invoice_data. Only applicable when mode is `PAYMENT`, and the type of the customer is `BUSINESS`." }, "payment_method_save": { "type": "object", "description": "Settings for saving this payment method for future use.", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`. \n`ENABLED`: The payment method will be saved for future use. \n`DISABLED`: The payment method will not be saved. \n`COLLECT_CONSENT`: The checkout UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`. \nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } } }, "payment_method_types": { "type": "array", "description": "Specify which payment methods to display on the hosted checkout page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the hosted checkout page. \nPossible enum values when mode is `SUBSCRIPTION`: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`. \nPossible enum values when mode is `PAYMENT`: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`. \nPossible enum values when mode is `SETUP`: `card`.", "items": { "type": "string", "description": "Specify which payment methods to display on the hosted checkout page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the hosted checkout page. \nPossible enum values when mode is `SUBSCRIPTION`: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`. \nPossible enum values when mode is `PAYMENT`: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`. \nPossible enum values when mode is `SETUP`: `card`." } } } }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "return_url": { "type": "string", "description": "URL to redirect your customer to after they authenticate or cancel their payment on the payment method's app or website. Returning to this URL does not confirm the payment status." }, "subscription_data": { "type": "object", "description": "The settings of subscription to be passed to the subscription creation upon completion of the Billing Checkout in `SUBSCRIPTION` mode.", "properties": { "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due. Defaults to `0`.", "format": "int32" }, "default_invoice_template": { "type": "object", "description": "Invoices for the Subscription will be created using the specified settings.", "properties": { "invoice_memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Memo to be used for the invoices that are generated by this Subscription." } } }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax rate between 0 and 100(%) to be applied to invoices to be generated. The tax will be exclusive. Defaults to 0." }, "duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "The total duration of the subscription.", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of period units.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing duration. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "starts_at": { "type": "string", "description": "Time when the subscription started or scheduled to start. Defaults to start immediately after creation." }, "trial_ends_at": { "type": "string", "description": "The end time of the trial if applicable." } } }, "success_url": { "type": "string", "description": "The URL the customer will be directed to after the checkout completion." }, "ui_options": { "type": "object", "description": "UI configuration for the hosted checkout page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this billing checkout, overriding the theme configured for its legal entity. You can find the theme ID in the Airwallex web app under Settings > Themes." } } }, "ui_mode": { "pattern": "^(HOSTED|EMBEDDED|ELEMENTS)$", "type": "string", "description": "The UI mode of the Billing Checkout, can be one of: \n`HOSTED`: Customers complete the checkout on an Airwallex-hosted page. \n`EMBEDDED`: Embed the checkout UI directly in your website or app. \n`ELEMENTS`: Build a custom checkout UI using Airwallex Elements. \nDefaults to `HOSTED` if not specified." } } }, "examples": { "default": { "value": { "back_url": "https://www.airwallex.com/back", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": false, "hosted_completion_page": { "display": true }, "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price": { "currency": "USD", "description": "Standard option: $10 / month.", "pricing_model": "PER_UNIT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 1 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Checkout" }, "examples": { "default": { "value": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 1 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED", "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Billing Checkout", "tags": [ "Billing > Billing Checkouts" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/billing_checkouts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "back_url": "https://www.airwallex.com/back", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": false, "hosted_completion_page": { "display": true }, "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price": { "currency": "USD", "description": "Standard option: $10 / month.", "pricing_model": "PER_UNIT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 1 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED" }, "response_body": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 1 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED", "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.checkout:write", "group": "Billing", "resource_name": "Billing Checkouts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_checkouts": { "get": { "description": "Retrieves a list of Billing Checkouts based on the query parameters.", "operationId": "listBillingCheckouts", "parameters": [ { "description": "ID of the subscription for the Billing Checkout upon completion.", "in": "query", "name": "subscription_id", "required": false, "schema": { "type": "string" } }, { "description": "The start date of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "Status of the Billing Checkout.", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Billing Checkouts per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseBillingCheckout" }, "examples": { "default": { "value": { "items": [ { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Billing Checkouts", "tags": [ "Billing > Billing Checkouts" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_checkouts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.checkout:read", "group": "Billing", "resource_name": "Billing Checkouts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_checkouts/{id}": { "get": { "description": "Retrieves a Billing Checkout.", "operationId": "retrieveBillingCheckout", "parameters": [ { "description": "ID of the Billing Checkout object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_checkout_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Checkout" }, "examples": { "default": { "value": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED", "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Billing Checkout", "tags": [ "Billing > Billing Checkouts" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_checkouts/billing_checkout_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "ui_mode": "HOSTED", "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.checkout:read", "group": "Billing", "resource_name": "Billing Checkouts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_checkouts/{id}/update": { "post": { "description": "Updates a Billing Checkout object.", "operationId": "updateBillingCheckout", "parameters": [ { "description": "ID of the Billing Checkout.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_checkout_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." } } }, "examples": { "default": { "value": { "metadata": { "foo": "bar" } } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Checkout" }, "examples": { "default": { "value": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Billing Checkout", "tags": [ "Billing > Billing Checkouts" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/billing_checkouts/billing_checkout_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "metadata": { "foo": "bar" } }, "response_body": { "automatic_tax_status": "APPLIED", "back_url": "https://www.airwallex.com/back", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2025-05-10T18:00:30+0000", "client_secret": "eyJhbGciOiJIUzI1NiJ9...", "completed_at": "2025-05-10T18:00:30+0000", "created_at": "2025-05-10T16:00:30+0000", "currency": "USD", "customer_data": { "email": "john@example.com", "name": "John Doe", "type": "INDIVIDUAL" }, "customer_data_collection": { "billing_address": "AUTO", "tax_id": "OPTIONAL_IF_SUPPORTED" }, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": true, "expires_at": "2025-05-12T16:00:30+0000", "hosted_completion_page": { "display": true }, "id": "bco_sgstcdcpnh8sv3awiwo", "invoice_data": { "days_until_due": 0, "default_tax_percent": 10, "due_at": "2026-01-01T10:15:30+0000", "memo": "Thank you for your business!", "metadata": { "foo": "bar" } }, "invoice_id": "inv_hkpd49cskgblns6iimw", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "locale": "AUTO", "metadata": { "foo": "bar" }, "mode": "SUBSCRIPTION", "payment_options": { "pay_by_invoice_enabled": false, "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "return_url": "https://www.airwallex.com/return", "status": "ACTIVE", "subscription_data": { "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "metadata": { "foo": "bar" }, "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2023-01-01T00:00:00+0000", "trial_ends_at": "2023-02-01T00:00:00+0000" }, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "success_url": "https://www.airwallex.com/success", "ui_mode": "HOSTED", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2025-05-10T16:00:30+0000", "url": "https://checkout.airwallex.com/pay?s=jwt_token" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.checkout:write", "group": "Billing", "resource_name": "Billing Checkouts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/coupons/create": { "post": { "description": "Creates a new coupon template that can be redeemed in purchases.", "operationId": "createCoupon", "requestBody": { "content": { "application/json": { "schema": { "required": [ "discount_model", "duration_type", "name", "request_id" ], "type": "object", "properties": { "amount_off": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The fixed amount to deduct when `discount_model` is `FLAT`." }, "currency": { "type": "string", "description": "The currency of `amount_off` when `discount_model` is `FLAT`." }, "description": { "type": "string", "description": "Description of the coupon providing business context." }, "discount_model": { "pattern": "^(FLAT|PERCENTAGE)$", "type": "string", "description": "Specified how to calculate the discount amount when applied, one of \n- `FLAT`: fixed amount off.\n- `PERCENTAGE`: percentage off." }, "duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "The duration of the coupon to apply, when `duration_type`is `CUSTOM`. `null` if `duration_type` is `ONCE` or `INDEFINITELY`.", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of `period_unit`.", "format": "int32" }, "period_unit": { "pattern": "^(DAY|WEEK|MONTH|YEAR)$", "type": "string", "description": "Specifies duration. One of `DAY`, `WEEK`, `MONTH`, `YEAR`." } } }, "duration_type": { "pattern": "^(ONCE|CUSTOM|INDEFINITELY)$", "type": "string", "description": "Determines how long the coupon's discount remains active after being applied. Possible values: \n- `ONCE`: Applies only to the first charge of a subscription or a one-off invoice.\n- `CUSTOM`: Applies to all charges within a specified number of billing cycles, as defined by duration.\n- `INDEFINITELY`: Applies to all future charges for the subscription until it is removed." }, "expires_at": { "type": "string", "description": "Time after which the coupon can no longer be redeemed." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Name of the coupon." }, "percentage_off": { "maximum": 100, "minimum": 0, "type": "number", "description": "The percentage between 0 to 100 to be applied to deduct when `discount_model` is `PERCENTAGE`." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" }, "examples": { "default": { "value": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Coupon", "tags": [ "Billing > Coupons" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/coupons/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.discount:write", "group": "Billing", "resource_name": "Discounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/coupons": { "get": { "description": "Get a list of coupons.", "operationId": "listCoupons", "parameters": [ { "description": "Specified how to calculate the discount amount when applied, one of \n- `FLAT`: fixed amount off.\n- `PERCENTAGE`: percentage off.", "in": "query", "name": "discount_model", "required": false, "schema": { "type": "string" } }, { "description": "`true` if the coupon is available to be applied to objects. `false` otherwise.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" } }, { "description": "Determines how long the coupon's discount remains active after being applied. Possible values: \n- `ONCE`: Applies only to the first charge of a subscription or a one-off invoice.\n- `CUSTOM`: Applies to all charges within a specified number of billing cycles, as defined by duration.\n- `INDEFINITELY`: Applies to all future charges for the subscription until it is removed.", "in": "query", "name": "duration_type", "required": false, "schema": { "type": "string" } }, { "description": "The start time of expires_at in ISO8601 format (inclusive).", "in": "query", "name": "from_expires_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end time of expires_at in ISO8601 format (exclusive).", "in": "query", "name": "to_expires_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The start time of created_at in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end time of created_at in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of results per page. Defaults to 20.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseCoupon" }, "examples": { "default": { "value": { "items": [ { "active": true, "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0 } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Coupons", "tags": [ "Billing > Coupons" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/coupons", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "active": true, "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0 } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.discount:read", "group": "Billing", "resource_name": "Discounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/coupons/{id}": { "get": { "description": "Retrieves the coupon details by the ID.", "operationId": "retrieveCoupon", "parameters": [ { "description": "ID of the Coupon object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "coupon_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" }, "examples": { "default": { "value": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Coupon", "tags": [ "Billing > Coupons" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/coupons/coupon_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.discount:read", "group": "Billing", "resource_name": "Discounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/coupons/{id}/update": { "post": { "description": "Updates a coupon. Before first redemption, all fields can be adjusted; after redemption, only non-billing fields (name, description, expires_at, metadata) can be updated to maintain contractual integrity.", "operationId": "updateCoupon", "parameters": [ { "description": "ID of the Coupon object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "coupon_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Whether the coupon is active and can be redeemed. Set to false to deactivate the coupon." }, "amount_off": { "type": "number", "description": "The fixed amount to deduct when `discount_model` is `FLAT`.\n This field cannot be updated once the coupon has been redeemed." }, "currency": { "type": "string", "description": "The currency of `amount_off` when `discount_model` is `FLAT`. \nThis field cannot be updated once the coupon has been redeemed." }, "description": { "type": "string", "description": "Description of the coupon providing business context." }, "discount_model": { "pattern": "^(FLAT|PERCENTAGE)$", "type": "string", "description": "Specified how to calculate the discount amount when applied, one of \n- `FLAT`: fixed amount off.\n- `PERCENTAGE`: percentage off.\nThis field cannot be updated once the coupon has been redeemed." }, "duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "The duration of the coupon to apply, when `duration_type`is `CUSTOM`. `null` if `duration_type` is `ONCE` or `INDEFINITELY`. \nThis field cannot be updated once the coupon has been redeemed.", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of `period_unit`.", "format": "int32" }, "period_unit": { "pattern": "^(DAY|WEEK|MONTH|YEAR)$", "type": "string", "description": "Specifies duration. One of `DAY`, `WEEK`, `MONTH`, `YEAR`." } } }, "duration_type": { "pattern": "^(ONCE|CUSTOM|INDEFINITELY)$", "type": "string", "description": "Determines how long the coupon's discount remains active after being applied. Possible values: \n- `ONCE`: Applies only to the first charge of a subscription or a one-off invoice.\n- `CUSTOM`: Applies to all charges within a specified number of billing cycles, as defined by duration.\n- `INDEFINITELY`: Applies to all future charges for the subscription until it is removed.\nThis field cannot be updated once the coupon has been redeemed." }, "expires_at": { "type": "string", "description": "Time after which the coupon can no longer be redeemed." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Name of the coupon." }, "percentage_off": { "maximum": 100, "minimum": 0, "type": "number", "description": "The percentage to deduct when discount_model is PERCENTAGE. \nThis field cannot be updated once the coupon has been redeemed." } } }, "examples": { "default": { "value": { "active": true, "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "ONCE", "expires_at": "2026-12-31T23:59:59+0000", "metadata": { "campaign": "bf-2026" }, "name": "Once Black Friday 20% Off", "percentage_off": 20 } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coupon" }, "examples": { "default": { "value": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Coupon", "tags": [ "Billing > Coupons" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/coupons/coupon_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "active": true, "amount_off": 10, "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "ONCE", "expires_at": "2026-12-31T23:59:59+0000", "metadata": { "campaign": "bf-2026" }, "name": "Once Black Friday 20% Off", "percentage_off": 20 }, "response_body": { "active": true, "amount_off": 10, "created_at": "", "currency": "USD", "description": "20% off for Black Friday.", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "expires_at": "2026-12-31T23:59:59+0000", "id": "coup_abc123", "metadata": { "campaign": "bf-2026" }, "name": "Black Friday 20% Off", "percentage_off": 20, "times_redeemed": 0, "updated_at": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.discount:write", "group": "Billing", "resource_name": "Discounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/add_line_items": { "post": { "description": "Create Line Items and add them to a Credit Note. This is only possible when the Credit Note status is `DRAFT`. You can only add 100 line items at a time. The bulk create operation is atomic, all the line items created with the request will either succeed or fail together.", "operationId": "creditNotes_addLineItems", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_items", "request_id" ], "type": "object", "properties": { "line_items": { "maxItems": 100, "minItems": 0, "type": "array", "description": "A list of credit note line items to be added, you may add 100 items at a time and add up to a maximum of 1000 items per credit note.", "items": { "type": "object", "properties": { "amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount of the credit note line item. You can specify either the `amount` directly, or the pair of `quantity` and `unit_amount`. When the `invoice_line_item_id` is null, this amount is proportionally distributed across all invoice line items based on their `remaining_creditable_amount`. " }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Description of the line item being credited." }, "invoice_line_item_id": { "type": "string", "description": "ID of the Invoice Line Item." }, "invoice_line_item_group_id": { "type": "string", "description": "A unique identifier that groups all related line items from a single tiered price. Used to credit by group instead of by individual line item. Mutually exclusive with `invoice_line_item_id`. When specified, `invoice_line_item_id`, `amount`, and `unit_amount` must be null. A single request cannot include both an `invoice_line_item_group_id` and any of its constituent `invoice_line_item_id`s. For `GRADUATED` prices, the credit amount is recalculated based on the remaining quantity. If the adjusted quantity no longer reaches a tier, associated fees (including flat fees) are automatically credited. For `VOLUME` prices, no tier adjustment is applied." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "quantity": { "minimum": 1, "type": "integer", "description": "The number of units of product being credited.", "format": "int32" }, "tax_included": { "type": "boolean", "description": "Whether the `amount` or `unit_amount` are inclusive of taxes or exclusive of taxes. Only can set the value to true for `unit_amount` when the price of the associated invoice line item is also tax inclusive. Defaults to false." }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be credited per product unit. This `unit_amount` will be multiplied by the `quantity` to get the full amount to credit for this line item. You can specify either the `amount` directly, or the pair of `quantity` and `unit_amount`. Only applicable when the `invoice_line_item_id` is not null.\n\nDefaults to the unit amount of the invoice line item when `quantity` is provided." } } } }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "line_items": [ { "amount": 20, "description": "Customer generated description of the item.", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false, "unit_amount": 2 }, { "description": "Customer generated description of the item.", "invoice_line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false } ], "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "9|Create Credit Note Line Items and Add Them to a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/add_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_items": [ { "amount": 20, "description": "Customer generated description of the item.", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false, "unit_amount": 2 }, { "description": "Customer generated description of the item.", "invoice_line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false } ], "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/create": { "post": { "description": "Create a Credit Note that is linked to an Invoice.", "operationId": "createCreditNote", "requestBody": { "content": { "application/json": { "schema": { "required": [ "invoice_id", "reason", "request_id", "type" ], "type": "object", "properties": { "custom_reason": { "maxLength": 500, "minLength": 0, "type": "string", "description": "An explanation for issuing the credit note when the reason is set to `OTHER`. This field is required if reason is `OTHER` and must be omitted or null for all other reason values." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices)." }, "memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Customer-facing text that appears on the credit note PDF." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "reason": { "pattern": "^(PRODUCT_RETURN|ORDER_CHANGE|PRODUCT_OR_SERVICE_UNSATISFACTORY|BILLING_ERROR|GOODWILL_GESTURE|OTHER)$", "type": "string", "description": "Reason for issuing this credit note, one of: `PRODUCT_RETURN`, `ORDER_CHANGE`, `PRODUCT_OR_SERVICE_UNSATISFACTORY`, `BILLING_ERROR`, `GOODWILL_GESTURE`, `OTHER`." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "type": { "pattern": "^(BEFORE_PAYMENT|AFTER_PAYMENT)$", "type": "string", "description": "The type of the credit note, one of: `BEFORE_PAYMENT`, `AFTER_PAYMENT`." } } }, "examples": { "default": { "value": { "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "type": "BEFORE_PAYMENT" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "type": "BEFORE_PAYMENT" }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/delete": { "post": { "description": "Delete a draft Credit Note.", "operationId": "deleteCreditNote", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteDeleted" }, "examples": { "default": { "value": { "deleted": true, "id": "crn_hkpda1313adfadfa" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "7|Delete a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "deleted": true, "id": "crn_hkpda1313adfadfa" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/delete_line_items": { "post": { "description": "Delete Line Items in a Credit Note. This is only possible when the Credit Note status is `DRAFT`. You can only delete 100 line items at a time. The bulk delete operation is atomic, all the removals in the request will either succeed or fail together.", "operationId": "creditNotes_deleteLineItems", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_item_ids" ], "type": "object", "properties": { "line_item_ids": { "maxItems": 100, "minItems": 0, "type": "array", "description": "List of Credit Note Line Item IDs to be deleted.", "items": { "maxLength": 100, "minLength": 0, "type": "string", "description": "List of Credit Note Line Item IDs to be deleted." } } } }, "examples": { "default": { "value": { "line_item_ids": [ "cnit_hkpd49cskgblnsnzgm1", "cnit_hkpd49cskgblnsnzgm2" ] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "13|Delete Credit Note Line Items From a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/delete_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_item_ids": [ "cnit_hkpd49cskgblnsnzgm1", "cnit_hkpd49cskgblnsnzgm2" ] }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/finalize": { "post": { "description": "Finalize a draft Credit Note. If the type is `BEFORE_PAYMENT`, the `refund_amount` and `out_of_band_amount` must be null. If the type is `AFTER_PAYMENT`, you will need to allocate the `total_amount` of the credit note to either `refund_amount` or `out_of_band_amount`.", "operationId": "creditNotes_finalize", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "out_of_band_amount": { "type": "number", "description": "Amount credited outside of Airwallex. Only applicable when the `type` is `AFTER_PAYMENT`." }, "refund_amount": { "type": "number", "description": "Amount credited with refund. Only applicable when the `type` is `AFTER_PAYMENT`." } } }, "examples": { "default": { "value": { "out_of_band_amount": 0, "refund_amount": 100.3 } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "6|Finalize a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/finalize", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "out_of_band_amount": 0, "refund_amount": 100.3 }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes": { "get": { "description": "Retrieve a list of Credit Notes based on the query parameters.", "operationId": "listCreditNotes", "parameters": [ { "description": "ID of the invoice.", "in": "query", "name": "invoice_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of the billing customer.", "in": "query", "name": "billing_customer_id", "required": false, "schema": { "type": "string" } }, { "description": "The type of the credit note, one of: `BEFORE_PAYMENT`, `AFTER_PAYMENT`.", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "Status of the credit note, one of `DRAFT`, `FINALIZED`, and `VOIDED`.", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "The start date of created_at in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of created_at in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Credit Notes to be listed per page. Defaults to 20.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseCreditNote" }, "examples": { "default": { "value": { "items": [ { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Credit Notes", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/credit_notes", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:read", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/line_items": { "get": { "description": "Retrieves a list of Credit Note Line Items based on the query parameters.", "operationId": "creditNotes_listLineItems", "parameters": [ { "description": "ID of the Credit Note object that the Credit Note Line Items belong to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Credit Note Line Items per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseCreditNoteLineItem" }, "examples": { "default": { "value": { "items": [ { "amount": 10, "created_at": "2025-01-01T00:00:00+0000", "credit_note_id": "crn_hkpda1313adfadfa", "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "cnit_hkpd49cskgblnsnzgm1", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "unit_amount": 10, "updated_at": "2025-01-01T00:00:00+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "11|List all Credit Note Line Items", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/credit_notes/credit_note_id/line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount": 10, "created_at": "2025-01-01T00:00:00+0000", "credit_note_id": "crn_hkpda1313adfadfa", "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "cnit_hkpd49cskgblnsnzgm1", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "unit_amount": 10, "updated_at": "2025-01-01T00:00:00+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:read", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/preview": { "post": { "description": "Preview a Credit Note that is linked to an Invoice.", "operationId": "creditNotes_preview", "requestBody": { "content": { "application/json": { "schema": { "required": [ "invoice_id", "line_items", "reason", "type" ], "type": "object", "properties": { "custom_reason": { "maxLength": 500, "minLength": 0, "type": "string", "description": "An explanation for issuing the credit note when the reason is set to `OTHER`. This field is required if reason is `OTHER` and must be omitted or null for all other reason values." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices)." }, "line_items": { "maxItems": 100, "minItems": 0, "type": "array", "description": "A list of credit note line items to preview.", "items": { "type": "object", "properties": { "amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount of the credit note line item. You can specify either the `amount` directly, or the pair of `quantity` and `unit_amount`. When the `invoice_line_item_id` is null, this amount is proportionally distributed across all invoice line items based on their `remaining_creditable_amount`. " }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Description of the line item being credited." }, "invoice_line_item_id": { "type": "string", "description": "ID of the Invoice Line Item." }, "invoice_line_item_group_id": { "type": "string", "description": "A unique identifier that groups all related line items from a single tiered price. Used to credit by group instead of by individual line item. Mutually exclusive with `invoice_line_item_id`. When specified, `invoice_line_item_id`, `amount`, and `unit_amount` must be null. A single request cannot include both an `invoice_line_item_group_id` and any of its constituent `invoice_line_item_id`s. For `GRADUATED` prices, the credit amount is recalculated based on the remaining quantity. If the adjusted quantity no longer reaches a tier, associated fees (including flat fees) are automatically credited. For `VOLUME` prices, no tier adjustment is applied." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "quantity": { "minimum": 1, "type": "integer", "description": "The number of units of product being credited.", "format": "int32" }, "tax_included": { "type": "boolean", "description": "Whether the `amount` or `unit_amount` are inclusive of taxes or exclusive of taxes. Only can set the value to true for `unit_amount` when the price of the associated invoice line item is also tax inclusive. Defaults to false." }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be credited per product unit. This `unit_amount` will be multiplied by the `quantity` to get the full amount to credit for this line item. You can specify either the `amount` directly, or the pair of `quantity` and `unit_amount`. Only applicable when the `invoice_line_item_id` is not null.\n\nDefaults to the unit amount of the invoice line item when `quantity` is provided." } } } }, "memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Customer-facing text that appears on the credit note PDF." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "reason": { "pattern": "^(PRODUCT_RETURN|ORDER_CHANGE|PRODUCT_OR_SERVICE_UNSATISFACTORY|BILLING_ERROR|GOODWILL_GESTURE|OTHER)$", "type": "string", "description": "Reason for issuing this credit note, one of: `PRODUCT_RETURN`, `ORDER_CHANGE`, `PRODUCT_OR_SERVICE_UNSATISFACTORY`, `BILLING_ERROR`, `GOODWILL_GESTURE`, `OTHER`." }, "type": { "pattern": "^(BEFORE_PAYMENT|AFTER_PAYMENT)$", "type": "string", "description": "The type of the credit note, one of: `BEFORE_PAYMENT`, `AFTER_PAYMENT`." } } }, "examples": { "default": { "value": { "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_items": [ { "amount": 20, "description": "Customer generated description of the item.", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false, "unit_amount": 2 }, { "description": "Customer generated description of the item.", "invoice_line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false } ], "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "type": "BEFORE_PAYMENT" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNotePreview" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "currency": "USD", "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_items": [ { "amount": 10, "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "unit_amount": 10 } ], "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "refund_amount": 25, "total_amount": 110, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 10, "type": "BEFORE_PAYMENT" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Preview a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/preview", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_items": [ { "amount": 20, "description": "Customer generated description of the item.", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false, "unit_amount": 2 }, { "description": "Customer generated description of the item.", "invoice_line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "metadata": { "foo": "bar" }, "quantity": 10, "tax_included": false } ], "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "type": "BEFORE_PAYMENT" }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "currency": "USD", "custom_reason": "Customer requested adjustment", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_items": [ { "amount": 10, "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "unit_amount": 10 } ], "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN", "refund_amount": 25, "total_amount": 110, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 10, "type": "BEFORE_PAYMENT" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:read", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true }, { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}": { "get": { "description": "Retrieves the details of a Credit Note.", "operationId": "retrieveCreditNote", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/credit_notes/credit_note_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:read", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/line_items/{line_item_id}": { "get": { "description": "Retrieves the details of a Credit Note Line Item.", "operationId": "creditNotes_retrieveLineItem", "parameters": [ { "description": "ID of the Credit Note object that this Credit Note Line Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } }, { "description": "ID of the Credit Note Line Item object.", "in": "path", "name": "line_item_id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "line_item_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteLineItem" }, "examples": { "default": { "value": { "amount": 10, "created_at": "2025-01-01T00:00:00+0000", "credit_note_id": "crn_hkpda1313adfadfa", "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "cnit_hkpd49cskgblnsnzgm1", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 0, "unit_amount": 10, "updated_at": "2025-01-01T00:00:00+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "10|Retrieve a Credit Note Line Item", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/credit_notes/credit_note_id/line_items/line_item_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 10, "created_at": "2025-01-01T00:00:00+0000", "credit_note_id": "crn_hkpda1313adfadfa", "currency": "CNY", "description": "Customer generated description of the item.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "cnit_hkpd49cskgblnsnzgm1", "invoice_line_item_id": "iit_hkpd49cskgblnsnzgm1", "metadata": {}, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "quantity": 1, "tax_amount": 10, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 0, "unit_amount": 10, "updated_at": "2025-01-01T00:00:00+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:read", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/update": { "post": { "description": "Update a draft Credit Note.", "operationId": "updateCreditNote", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "custom_reason": { "type": "string", "description": "An explanation for issuing the credit note when the reason enum is set to `OTHER`. This field is required if reason is `OTHER` and must be omitted or null for all other reason values." }, "memo": { "type": "string", "description": "Customer-facing text that appears on the credit note PDF." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "reason": { "pattern": "^(PRODUCT_RETURN|ORDER_CHANGE|PRODUCT_OR_SERVICE_UNSATISFACTORY|BILLING_ERROR|GOODWILL_GESTURE|OTHER)$", "type": "string", "description": "Reason for issuing this credit note, one of: `PRODUCT_RETURN`, `ORDER_CHANGE`, `PRODUCT_OR_SERVICE_UNSATISFACTORY`, `BILLING_ERROR`, `GOODWILL_GESTURE`, `OTHER`." } } }, "examples": { "default": { "value": { "custom_reason": "Customer requested adjustment", "memo": "Updated credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "custom_reason": "Customer requested adjustment", "memo": "Updated credit note memo.", "metadata": { "foo": "bar" }, "reason": "PRODUCT_RETURN" }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/update_line_items": { "post": { "description": "Update Line Items in a Credit Note. This is only possible when the Credit Note status is `DRAFT`. You can only update 100 line items at a time. The bulk update operation is atomic, all the updates in the request will either succeed or fail together.", "operationId": "creditNotes_updateLineItems", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_items" ], "type": "object", "properties": { "line_items": { "maxItems": 100, "minItems": 0, "type": "array", "description": "A list of credit note line items to be updated, you may update 100 items at a time.", "items": { "required": [ "id" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the credit note line item. Only applicable when both the `unit_amount` and `quantity` are null." }, "description": { "type": "string", "description": "Description of the line item being credited." }, "id": { "type": "string", "description": "ID of the credit note line item object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "quantity": { "type": "integer", "description": "The number of units of product being credited.", "format": "int32" }, "tax_included": { "type": "boolean", "description": "Whether the `amount` or `unit_amount` are inclusive of taxes or exclusive of taxes." }, "unit_amount": { "type": "number", "description": "The amount to be credited per product unit. This `unit_amount` will be multiplied by the `quantity` to get the full amount to credit for this line item." } } } } } }, "examples": { "default": { "value": { "line_items": [ { "amount": 30, "description": "Customer generated description of the item.", "id": "cnit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 2, "tax_included": false, "unit_amount": 2 } ] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "12|Update Credit Note Line Items in a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/update_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_items": [ { "amount": 30, "description": "Customer generated description of the item.", "id": "cnit_hkpd49cskgblnsnzgm1", "metadata": { "foo": "bar" }, "quantity": 2, "tax_included": false, "unit_amount": 2 } ] }, "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/credit_notes/{id}/void": { "post": { "description": "Void a finalized Credit Note. Transition from finalized to voided is allowed only when: 1) type of Credit Note is pre-payment 2) payment status of the linked Invoice is unpaid.", "operationId": "creditNotes_void", "parameters": [ { "description": "ID of the Credit Note object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "credit_note_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "default": { "value": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "8|Void a Credit Note", "tags": [ "Billing > Credit Notes" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/credit_notes/credit_note_id/void", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "adjustment_amount": 50, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "custom_reason": "Customer requested adjustment", "finalized_at": "2022-12-05T10:15:30+0000", "id": "crn_hkpda1313adfadfa", "invoice_id": "inv_hkpd49cskgblns6iimw", "memo": "Credit note memo.", "metadata": { "foo": "bar" }, "number": "CRN-591726CD-01", "out_of_band_amount": 25, "pdf_url": "https://creditnote.airwallex.com/billing/creditnotes/pdf?s=jwt_token", "reason": "PRODUCT_RETURN", "refund_amount": 25, "refund_status": "SUCCEEDED", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "type": "BEFORE_PAYMENT", "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.credit_note:write", "group": "Billing", "resource_name": "Credit Notes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_customers/create": { "post": { "description": "Creates a Billing Customer.", "operationId": "createBillingCustomer", "requestBody": { "content": { "application/json": { "schema": { "required": [ "request_id" ], "type": "object", "properties": { "address": { "required": [ "country_code" ], "type": "object", "description": "Address of the billing customer.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "PostCode of the address." }, "state": { "type": "string", "description": "State or province of the address." }, "street": { "type": "string", "description": "Street of the address." } } }, "default_billing_currency": { "type": "string", "description": "Default currency to use when billing this customer in 3-letter ISO-4217 format." }, "default_legal_entity_id": { "type": "string", "description": "ID of the default legal entity to use when billing this customer. You can get this ID from the `legal_entity_id` in the response of the [Retrieve account details API](/docs/api/scale/accounts/retrieve)." }, "description": { "type": "string", "description": "Additional description about the billing customer." }, "email": { "type": "string", "description": "Email address of the billing customer." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Name of the billing customer." }, "nickname": { "type": "string", "description": "Internal nickname for the billing customer." }, "phone_number": { "type": "string", "description": "Phone number of the billing customer." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the billing customer." }, "type": { "pattern": "^(BUSINESS|INDIVIDUAL)$", "type": "string", "description": "Type of the billing customer. Defaults to `BUSINESS` if `tax_identification_number` exists. Otherwise defaults to `INDIVIDUAL`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } }, "examples": { "default": { "value": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" }, "examples": { "default": { "value": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `resource_not_found`(invalid `default_billing_entity_id`), `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Billing Customer", "tags": [ "Billing > Billing Customers" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/billing_customers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "response_body": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.customer:write", "group": "Billing", "resource_name": "Billing Customers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_customers": { "get": { "description": "Retrieves a list of Billing Customers based on the query parameters.", "operationId": "listBillingCustomers", "parameters": [ { "description": "The start time of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end time of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "Email address of the billing customer.", "in": "query", "name": "email", "required": false, "schema": { "type": "string" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of billing customer objects per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseCustomer" }, "examples": { "default": { "value": { "items": [ { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|List all Billing Customers", "tags": [ "Billing > Billing Customers" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_customers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.customer:read", "group": "Billing", "resource_name": "Billing Customers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_customers/{id}/bank_transfer_instructions": { "get": { "description": "Retrieves the bank transfer instructions of a Billing Customer as a read-only list, with one entry per supported currency. The list is empty until bank transfer instructions have been provisioned.", "operationId": "listBillingCustomerBankTransferInstructions", "parameters": [ { "description": "ID of the Billing Customer object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_customer_id" }, "swift": { "value": "billing_customer_id" }, "empty": { "value": "billing_customer_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "description": "List of bank transfer detail value objects owned by the Billing Customer, with one entry per supported currency. Empty when no bank transfer instructions have been provisioned.", "items": { "$ref": "#/components/schemas/BankTransferInstructions" } }, "examples": { "default": { "value": [ { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150" } ] }, "swift": { "value": [ { "currency": "SGD", "account_name": "Airwallex (Singapore) Pte Ltd", "account_number": "885388629", "account_category": "CHECKING", "bank_name": "DBS Bank Ltd", "swift_code": "DBSSSGSG", "charge_type": "OUR", "merchant_address": { "country_code": "SG", "postcode": "018956", "suburb": "Downtown Core", "street_address": [ "1 Raffles Place", "#20-01 One Raffles Place Tower 1" ] } } ] }, "empty": { "value": [] } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|Retrieve Bank Transfer Instructions of a Billing Customer", "tags": [ "Billing > Billing Customers" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_customers/billing_customer_id/bank_transfer_instructions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": [ { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150" } ] }, { "key": "swift", "name": "International (SWIFT)", "method": "GET", "uri": "/api/v1/billing/billing_customers/billing_customer_id/bank_transfer_instructions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": [ { "currency": "SGD", "account_name": "Airwallex (Singapore) Pte Ltd", "account_number": "885388629", "account_category": "CHECKING", "bank_name": "DBS Bank Ltd", "swift_code": "DBSSSGSG", "charge_type": "OUR", "merchant_address": { "country_code": "SG", "postcode": "018956", "suburb": "Downtown Core", "street_address": [ "1 Raffles Place", "#20-01 One Raffles Place Tower 1" ] } } ] }, { "key": "empty", "name": "No bank transfer instructions available", "method": "GET", "uri": "/api/v1/billing/billing_customers/billing_customer_id/bank_transfer_instructions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": [] } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.customer:read", "group": "Billing", "resource_name": "Billing Customers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_customers/{id}": { "get": { "description": "Retrieves the details of a Billing Customer.", "operationId": "retrieveBillingCustomer", "parameters": [ { "description": "ID of the Billing Customer object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_customer_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" }, "examples": { "default": { "value": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Billing Customer", "tags": [ "Billing > Billing Customers" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_customers/billing_customer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.customer:read", "group": "Billing", "resource_name": "Billing Customers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_customers/{id}/update": { "post": { "description": "Updates a Billing Customer. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.", "operationId": "updateBillingCustomer", "parameters": [ { "description": "ID of the Billing Customer object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_customer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "required": [ "country_code" ], "type": "object", "description": "Address of the billing customer.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "PostCode of the address." }, "state": { "type": "string", "description": "State or province of the address." }, "street": { "type": "string", "description": "Street of the address." } } }, "default_billing_currency": { "type": "string", "description": "Default currency to use when billing this customer in 3-letter ISO-4217 format." }, "default_legal_entity_id": { "type": "string", "description": "ID of the default legal entity to use when billing this customer." }, "description": { "type": "string", "description": "Additional description about the billing customer." }, "email": { "type": "string", "description": "Email address of the billing customer." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Name of the billing customer." }, "nickname": { "type": "string", "description": "Internal nickname for the billing customer." }, "phone_number": { "type": "string", "description": "Phone number of the billing customer." }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the billing customer." }, "type": { "pattern": "^(BUSINESS|INDIVIDUAL)$", "type": "string", "description": "Type of the billing customer.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } }, "examples": { "default": { "value": { "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street": "200 Collins Street" }, "default_billing_currency": "EUR", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "Updated corporate account.", "email": "billing@acmecorp.com", "metadata": { "customer_segment": "enterprise" }, "name": "Acme Corporation", "nickname": "Acme Corp", "phone_number": "+1987654321", "tax_identification_number": "987-65-4321", "type": "BUSINESS" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" }, "examples": { "default": { "value": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Update a Billing Customer", "tags": [ "Billing > Billing Customers" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/billing_customers/billing_customer_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street": "200 Collins Street" }, "default_billing_currency": "EUR", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "Updated corporate account.", "email": "billing@acmecorp.com", "metadata": { "customer_segment": "enterprise" }, "name": "Acme Corporation", "nickname": "Acme Corp", "phone_number": "+1987654321", "tax_identification_number": "987-65-4321", "type": "BUSINESS" }, "response_body": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "automatic_tax_eligibility": "ELIGIBLE", "created_at": "2024-06-10T12:34:56+0000", "default_billing_currency": "USD", "default_legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "description": "VIP customer.", "email": "john.doe@example.com", "id": "bcus_hkpd7fedfgb004apkvs", "metadata": { "customer_segment": "premium" }, "name": "John Doe", "nickname": "JohnnyD", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL", "updated_at": "2024-06-10T12:34:56+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.customer:write", "group": "Billing", "resource_name": "Billing Customers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/add_line_items": { "post": { "description": "This is only possible when the status of an [Invoice](/docs/api/billing/invoices) is in `DRAFT`. You can add up to 100 line items at a time. This bulk operation is atomic.", "operationId": "invoices_addLineItems", "parameters": [ { "description": "ID of the Invoice object that this Invoice Line Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_items", "request_id" ], "type": "object", "properties": { "line_items": { "maxItems": 100, "minItems": 0, "type": "array", "description": "List of Invoice Line Item to be created.", "items": { "type": "object", "properties": { "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Description of the Invoice Line Item." }, "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "A list of discounts to be applied to the invoice line item. Discounts of invoice line items are applied before invoice discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "price": { "required": [ "pricing_model" ], "type": "object", "description": "One-time price definition following the same schema as the [Price](/docs/api/billing/prices) resource. Exactly one of `price_id` or `price` is required.", "properties": { "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Price description." }, "flat_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity." }, "product": { "required": [ "name" ], "type": "object", "description": "One-time product definition following the same schema as the [Product](/docs/api/billing/products). Exactly one of `product_id` or `product` is required.", "properties": { "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Product description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Product name." }, "tax_code": { "type": "string", "description": "The tax category of the product." }, "unit": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Product unit." } } }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object this price is associated with. Exactly one of `product_id` or `product` is required." }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax. Defaults to `false`." }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." } } }, "price_id": { "type": "string", "description": "ID of the price object. Exactly one of `price` or `price_id` is required." }, "quantity": { "minimum": 1, "type": "integer", "description": "The product quantity.", "format": "int32" }, "tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The effective tax percent of this subscription item." } } } }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "line_items": [ { "description": "Description of the Invoice Line Item.", "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "metadata": { "foo": "bar" }, "price": { "description": "Standard option: $10 / month.", "pricing_model": "FLAT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "11|Create Invoice Line Items and Add Them to an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/add_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_items": [ { "description": "Description of the Invoice Line Item.", "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "metadata": { "foo": "bar" }, "price": { "description": "Standard option: $10 / month.", "pricing_model": "FLAT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 1, "tax_percent": 5 } ], "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/create": { "post": { "description": "Creates a one-off Invoice.", "operationId": "createInvoice", "requestBody": { "content": { "application/json": { "schema": { "required": [ "billing_customer_id", "currency", "request_id" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who will be charged." }, "collection_method": { "pattern": "^(CHARGE_ON_CHECKOUT|OUT_OF_BAND|AUTO_CHARGE)$", "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "currency": { "type": "string", "description": "The currency of the Invoice in 3-letter ISO-4217 format." }, "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due. Only one of `days_until_due` and `due_at` should be passed.", "format": "int32" }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to each Line Item's price. The tax will be exclusive. Defaults to `0`." }, "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "List of discounts to be applied to the invoice. Invoice line item discounts are applied before invoice discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "due_at": { "type": "string", "description": "Due date set by the merchant for this invoice, if any. Only one of `days_until_due` and `due_at` should be passed." }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this invoice. When enabled, the system attempts to calculate taxes automatically. Defaults to `false`." }, "footer": { "type": "string", "description": "Additional payment instructions or supplementary information that merchants can share with their customers. Displayed in the Invoice PDF." }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings. Required if you have more than 1 entity in your organisation." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section. If `collection_method` is `CHARGE_ON_CHECKOUT` and your organisation has only one payment account, it will be automatically populated with that account by default." }, "memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "String used for merchants to share a custom message to their customers. Referenced as memo or invoice note in Webapp." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "number": { "type": "string", "description": "Unique invoice number specified by the merchant. If omitted, Airwallex generates one automatically." }, "payment_options": { "type": "object", "description": "Payment settings of this Invoice. Only applicable if collection_method is `CHARGE_ON_CHECKOUT`.", "properties": { "payment_method_save": { "type": "object", "description": "Settings for saving this payment method for future use.", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`. \n`ENABLED`: The payment method will be saved for future use. \n`DISABLED`: The payment method will not be saved. \n`COLLECT_CONSENT`: The digital invoice UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`. \nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } } }, "payment_method_types": { "type": "array", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page. \nPossible enum values: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bank_transfer`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`.", "items": { "type": "string", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page. \nPossible enum values: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bank_transfer`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`." } } } }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the invoice. Required when `collection_method` is `AUTO_CHARGE`. \nIf `collection_method` is `CHARGE_ON_CHECKOUT`, a Payment Source is automatically created during invoice payment when `payment_options.payment_method_save.next_triggered_by` is `MERCHANT` and `payment_options.payment_method_save.mode` is `ENABLED`, or when it is `COLLECT_CONSENT` and the customer has given consent." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "ui_options": { "type": "object", "description": "UI configuration for the digital invoice page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this invoice, overriding the theme configured for its legal entity. You can find the theme ID in the Airwallex web app under Settings > Themes." } } } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "due_at": "2022-01-01T10:15:30+0000", "enable_automatic_tax": true, "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "manual invoice", "metadata": { "foo": "bar" }, "number": "INV-2026-0001", "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" } } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "due_at": "2022-01-01T10:15:30+0000", "enable_automatic_tax": true, "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "manual invoice", "metadata": { "foo": "bar" }, "number": "INV-2026-0001", "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" } }, "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/delete": { "post": { "description": "Delete a draft Invoice.", "operationId": "deleteInvoice", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDeleted" }, "examples": { "default": { "value": { "deleted": true, "id": "inv_hkpd49cskgblns6iimw" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "9|Delete a Draft Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "deleted": true, "id": "inv_hkpd49cskgblns6iimw" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/delete_line_items": { "post": { "description": "This is only possible when the status of an [Invoice](/docs/api/billing/invoices) is in `DRAFT`. You can delete up to 100 line items at a time. This bulk operation is atomic.", "operationId": "invoices_deleteLineItems", "parameters": [ { "description": "ID of the Invoice object that this Invoice Line Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_item_ids" ], "type": "object", "properties": { "line_item_ids": { "maxItems": 100, "minItems": 0, "type": "array", "description": "List of Invoice Line Item IDs to be deleted.", "items": { "maxLength": 100, "minLength": 0, "type": "string", "description": "List of Invoice Line Item IDs to be deleted." } } } }, "examples": { "default": { "value": { "line_item_ids": [ "iit_hkpd49cskgblnsnzgm1", "iit_cs8e0ZgQzd2QnCxVpzu" ] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "15|Delete Invoice Line Items Within an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/delete_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_item_ids": [ "iit_hkpd49cskgblnsnzgm1", "iit_cs8e0ZgQzd2QnCxVpzu" ] }, "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/finalize": { "post": { "description": "Finalizes a draft invoice.", "operationId": "invoices_finalize", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "6|Finalize an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/finalize", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices": { "get": { "description": "Retrieves a list of Invoices based on the query parameters.", "operationId": "listInvoices", "parameters": [ { "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who the invoice is addressed to.", "in": "query", "name": "billing_customer_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of the [Subscription](/docs/api/billing/subscriptions) which generated this invoice, if any.", "in": "query", "name": "subscription_id", "required": false, "schema": { "type": "string" } }, { "description": "Status of the invoice. Once the invoice is created, it will be defaulted to `DRAFT`, and once the invoice is finalized, it will turn to `FINALIZED`. When an invoice is voided, it will become `VOIDED`.", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "Status of the payment for the invoice, one of `UNPAID` and `PAID`.", "in": "query", "name": "payment_status", "required": false, "schema": { "type": "string" } }, { "description": "The start date of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Invoices per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseInvoice" }, "examples": { "default": { "value": { "items": [ { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Invoices", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/line_item_groups": { "get": { "description": "Retrieves a list of line item groups for an [Invoice](/docs/api/billing/invoices).", "operationId": "listLineItemGroups", "parameters": [ { "description": "ID of the Invoice object that the Line Item Groups belong to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of line item groups per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseLineItemGroup" }, "examples": { "default": { "value": { "items": [ { "id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "invoice_id": "inv_hkpd49cskgblns6iimw", "label": "line_item_group_1", "period_ends_at": "2026-02-01T00:00:00+0000", "period_starts_at": "2026-01-01T00:00:00+0000", "total_amount": 20, "total_discount_amount": 0, "total_quantity": 20, "total_remaining_creditable_amount": 20, "total_remaining_creditable_quantity": 20, "total_tax_amount": 0 } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "17|List all Invoice Line Item Groups", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices/invoice_id/line_item_groups", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "invoice_id": "inv_hkpd49cskgblns6iimw", "label": "line_item_group_1", "period_ends_at": "2026-02-01T00:00:00+0000", "period_starts_at": "2026-01-01T00:00:00+0000", "total_amount": 20, "total_discount_amount": 0, "total_quantity": 20, "total_remaining_creditable_amount": 20, "total_remaining_creditable_quantity": 20, "total_tax_amount": 0 } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/line_items": { "get": { "description": "Retrieves a list of Invoice Line Items based on the query parameters.", "operationId": "invoices_listLineItems", "parameters": [ { "description": "ID of the Invoice object that the Invoice Line Items belong to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of invoiceItems per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseInvoiceItem" }, "examples": { "default": { "value": { "items": [ { "amount": 2, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "This is a description.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "iit_hkpd49cskgblnsnzgm1", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "label": "Tier 0 (First 10) - Per unit fee", "metadata": { "foo": "bar" }, "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "remaining_creditable_amount": 2, "remaining_creditable_quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 7.5, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "13|List all Invoice Line Items", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices/invoice_id/line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount": 2, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "This is a description.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "iit_hkpd49cskgblnsnzgm1", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "label": "Tier 0 (First 10) - Per unit fee", "metadata": { "foo": "bar" }, "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "remaining_creditable_amount": 2, "remaining_creditable_quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 7.5, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/mark_as_paid": { "post": { "description": "Mark a finalized Invoice that has already been paid out-of-band.", "operationId": "markAsPaid", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "7|Mark an Invoice As Paid", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/mark_as_paid", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/pay": { "post": { "description": "Pay a finalized `AUTO_CHARGE` Invoice using an existing Payment Source.", "operationId": "payInvoice", "parameters": [ { "description": "Unique identifier of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "inv_hkpd49cskgblns6iimw" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payment_source_id" ], "properties": { "payment_source_id": { "type": "string", "description": "ID of an existing Payment Source that belongs to the customer and will be used to pay the Invoice. This is a one-time payment instruction and does not change the Payment Source saved on the Subscription.\n\nThe Payment Source's `linked_payment_account_id` must match the Invoice's `linked_payment_account_id`." } } }, "examples": { "default": { "value": { "payment_source_id": "psrc_d3Ds20ae5VihKs092" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 0, "applied_discounts": [], "automatic_tax_status": "DISABLED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "enable_automatic_tax": false, "id": "inv_hkpd49cskgblns6iimw", "paid_out_of_band": false, "payment_status": "PAID", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "8|Pay an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/inv_hkpd49cskgblns6iimw/pay", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "payment_source_id": "psrc_d3Ds20ae5VihKs092" }, "response_body": { "amount_due": 0, "applied_discounts": [], "automatic_tax_status": "DISABLED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "enable_automatic_tax": false, "id": "inv_hkpd49cskgblns6iimw", "paid_out_of_band": false, "payment_status": "PAID", "status": "FINALIZED", "total_amount": 100, "total_discount_amounts": [], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/preview": { "post": { "description": "Preview the upcoming invoice of an existing [Subscription](/docs/api/billing/subscriptions), including proposed updates when update parameters are provided, or the first invoice of a new subscription when `subscription_id` is omitted. Omitted update fields remain unchanged. No changes are applied or payments collected.", "operationId": "invoices_preview", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) to invoice. Required and only applicable when `subscription_id` is not provided." }, "billing_cycle_anchor_at": { "type": "string", "description": "A future timestamp in the first billing cycle used to align subsequent billing dates. Only applicable when `subscription_id` is not provided." }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "Exclusive tax percentage applied to invoice line items, from `0` to `100`. Defaults to `0` for a new subscription." }, "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "Discounts applied to the invoice after line item discounts. Supports one discount. When `subscription_id` is provided, replaces subscription discounts; an empty list removes them.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "enable_automatic_tax": { "type": "boolean", "description": "Whether to calculate invoice taxes automatically. Defaults to `false` for a new subscription." }, "ends_at": { "type": "string", "description": "The subscription end time." }, "items": { "type": "array", "description": "List of Subscription Items used to preview the invoice. Required when `subscription_id` is not provided. When `subscription_id` is provided, previews adding, updating, or deleting items when the list is not empty.", "items": { "type": "object", "properties": { "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "Discounts applied to this item before subscription discounts. Supports one discount. An empty list removes existing item discounts.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "price_id": { "type": "string", "description": "ID of the [Price](/docs/api/billing/prices) for the item. Its recurring frequency must match the subscription. Exactly one of `price_id` or `rate_card_id` is required for a new item; both may be omitted when updating an item by `id`." }, "quantity": { "minimum": 1, "type": "integer", "description": "The product quantity. Defaults to `1` for a new item.", "format": "int32" }, "rate_card_id": { "type": "string", "description": "ID of the [Rate Card](/docs/api/billing/rate_cards) for the item. Mutually exclusive with `price_id`; exactly one is required for a new item." }, "rate_card_version": { "type": "integer", "description": "Pinned Rate Card version. Required when `rate_card_id` is provided; omit otherwise.", "format": "int32" }, "tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The effective tax percentage for this invoice line item." }, "id": { "type": "string", "description": "ID of the Subscription Item to update or delete. Only applicable when `subscription_id` is provided. If omitted, adds a new item in the preview.", "example": "sit_hkpdwesy9gazzrtqbkg" }, "deleted": { "type": "boolean", "default": false, "description": "Set to `true` to preview deleting the item identified by `id`. Only applicable when `subscription_id` is provided. Defaults to `false`." }, "proration_mode": { "type": "string", "enum": [ "NONE", "PRORATED", "ALL", "CUSTOM" ], "description": "Proration treatment for this item, overriding `default_proration_mode`. Only applicable when `subscription_id` is provided.", "x-enumDescriptions": { "NONE": "Does not issue any credit for the Subscription's unused time, only charges the new fee from the next billing cycle.", "PRORATED": "Calculates and applies the proration on both credit and fee for the Subscription's unused time.", "ALL": "Credits the full remaining creditable amount of the old items for the current billing cycle, and charges the full amount of the new items for the current billing cycle.", "CUSTOM": "Uses merchant-specified charge and credit amounts instead of calculating prorated amounts automatically." } }, "proration_value": { "type": "object", "description": "Custom charge and credit amounts in the billing currency. Required when `proration_mode` is `CUSTOM` and must be omitted otherwise. At least one of `charge_amount` or `credit_amount` must be provided.", "anyOf": [ { "required": [ "charge_amount" ] }, { "required": [ "credit_amount" ] } ], "properties": { "charge_amount": { "type": "string", "description": "Base amount to charge for this item, expressed as a decimal string in the billing currency." }, "credit_amount": { "type": "string", "description": "Base amount to credit for this item, expressed as a decimal string in the billing currency." } }, "example": { "charge_amount": "100.00", "credit_amount": "20.00" } } } } }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity used as the billing entity. Available in the response of [Retrieve account details](/docs/api/scale/accounts/retrieve)." }, "starts_at": { "type": "string", "description": "The subscription start time. Defaults to starting immediately for a new subscription. When `subscription_id` is provided, only applicable to `PENDING` subscriptions." }, "subscription_id": { "type": "string", "description": "ID of the [Subscription](/docs/api/billing/subscriptions) to preview. With update parameters, previews the update result; otherwise previews the upcoming invoice. If omitted, previews a new subscription's first invoice." }, "trial_ends_at": { "type": "string", "description": "The trial end time. Use `NOW` to end the trial immediately." }, "billing_action": { "type": "string", "default": "DEFER_CHARGE_AND_KEEP_CYCLE", "description": "Billing behavior to preview. Only applicable when `subscription_id` is provided. Defaults to `DEFER_CHARGE_AND_KEEP_CYCLE`.", "enum": [ "DEFER_CHARGE_AND_KEEP_CYCLE", "IMMEDIATE_CHARGE_AND_KEEP_CYCLE", "IMMEDIATE_CHARGE_AND_RESET_CYCLE" ], "x-enumDescriptions": { "DEFER_CHARGE_AND_KEEP_CYCLE": "Includes prorated in-advance fees in the next upcoming invoice and retains the current billing cycle anchor. In-arrears fees retain their original billing date.", "IMMEDIATE_CHARGE_AND_KEEP_CYCLE": "Previews the immediate adjustment invoice and retains the current billing cycle anchor.", "IMMEDIATE_CHARGE_AND_RESET_CYCLE": "Previews immediate billing with the billing cycle anchor reset for the update. Subsequent billing cycles align with the new anchor." } }, "default_proration_mode": { "type": "string", "description": "Default proration treatment for Subscription Item changes. Only applicable when `subscription_id` is provided. Defaults to `PRORATED`.", "enum": [ "NONE", "PRORATED", "ALL" ], "x-enumDescriptions": { "NONE": "Does not issue any credit for the Subscription's unused time, only charges the new fee from the next billing cycle.", "PRORATED": "Calculates and applies the proration on both credit and fee for the Subscription's unused time.", "ALL": "Credits the full remaining creditable amount of the old items for the current billing cycle, and charges the full amount of the new items for the current billing cycle." }, "default": "PRORATED" }, "proration_date": { "type": "string", "format": "date-time", "description": "Timestamp used to calculate prorations. Only applicable when `subscription_id` is provided. Must fall within the current billing period. Use the same value in [Update a Subscription](/docs/api/billing/subscriptions/update) for consistent proration timing.", "example": "2026-01-15T10:15:30Z" } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": false, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_sgpd7fedwse004apedr", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 3 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-01-01T10:15:30+0000" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePreview" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "default_tax_percent": 10, "enable_automatic_tax": true, "items": [ { "amount": 10, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "currency": "USD", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 5 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 10, "total_tax_amount": 1.5, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ] } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`. A cancelled subscription cannot be updated in the preview." }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`. Returned when the subscription or the selected invoice does not exist." }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Preview an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/preview", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "enable_automatic_tax": false, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "price_id": "pri_sgpd7fedwse004apedr", "quantity": 1, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 3 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-01-01T10:15:30+0000" }, "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "default_tax_percent": 10, "enable_automatic_tax": true, "items": [ { "amount": 10, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "currency": "USD", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 5 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 10, "total_tax_amount": 1.5, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true }, { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}": { "get": { "description": "Retrieves the details of an Invoice.", "operationId": "retrieveInvoice", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices/invoice_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" }, "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/line_items/{item_id}": { "get": { "description": "Retrieves the details of a line item on an [Invoice](/docs/api/billing/invoices).", "operationId": "invoices_retrieveLineItem", "parameters": [ { "description": "ID of the invoice object that this Invoice Line Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } }, { "description": "ID of the Invoice Line Item object.", "in": "path", "name": "item_id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "item_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItem" }, "examples": { "default": { "value": { "amount": 2, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "This is a description.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "iit_hkpd49cskgblnsnzgm1", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "label": "Tier 0 (First 10) - Per unit fee", "metadata": { "foo": "bar" }, "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "remaining_creditable_amount": 2, "remaining_creditable_quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 7.5, "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "12|Retrieve an Invoice Line Item", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices/invoice_id/line_items/item_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 2, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "This is a description.", "discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "id": "iit_hkpd49cskgblnsnzgm1", "invoice_id": "inv_hkpd49cskgblns6iimw", "line_item_group_id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "label": "Tier 0 (First 10) - Per unit fee", "metadata": { "foo": "bar" }, "period_ends_at": "2022-01-05T10:15:30+0000", "period_starts_at": "2022-01-01T10:15:30+0000", "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 1, "price_tier": { "level": 1, "lower_bound": 0, "unit_amount": 10, "upper_bound": 20 }, "remaining_creditable_amount": 2, "remaining_creditable_quantity": 1, "tax_amount": 1.5, "tax_breakdown": [ { "name": "GST", "tax_amount": 10, "tax_percent": 10, "taxable_amount": 100 } ], "tax_percent": 7.5, "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/line_item_groups/{group_id}": { "get": { "description": "Retrieves the details of a line item group on an [Invoice](/docs/api/billing/invoices).", "operationId": "retrieveLineItemGroups", "parameters": [ { "description": "ID of the Invoice object that this Line Item Group belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } }, { "description": "ID of the Line Item Group.", "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "group_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemGroup" }, "examples": { "default": { "value": { "id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "invoice_id": "inv_hkpd49cskgblns6iimw", "label": "line_item_group_1", "period_ends_at": "2026-02-01T00:00:00+0000", "period_starts_at": "2026-01-01T00:00:00+0000", "total_amount": 20, "total_discount_amount": 0, "total_quantity": 20, "total_remaining_creditable_amount": 20, "total_remaining_creditable_quantity": 20, "total_tax_amount": 0 } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "16|Retrieve an Invoice Line Item Group", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/invoices/invoice_id/line_item_groups/group_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "aaea4c0e-d8b4-4b19-b249-ca28d7e17d54", "invoice_id": "inv_hkpd49cskgblns6iimw", "label": "line_item_group_1", "period_ends_at": "2026-02-01T00:00:00+0000", "period_starts_at": "2026-01-01T00:00:00+0000", "total_amount": 20, "total_discount_amount": 0, "total_quantity": 20, "total_remaining_creditable_amount": 20, "total_remaining_creditable_quantity": 20, "total_tax_amount": 0 } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:read", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/update": { "post": { "description": "Updates a draft Invoice. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.", "operationId": "updateInvoice", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who this Invoice is to be issued to." }, "collection_method": { "pattern": "^(CHARGE_ON_CHECKOUT|OUT_OF_BAND|AUTO_CHARGE)$", "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "currency": { "type": "string", "description": "The currency of the Invoice in 3-letter ISO-4217 format." }, "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due. Only one of `days_until_due` and `due_at` should be passed.", "format": "int32" }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to each Line Item's price. The tax will be exclusive." }, "discounts": { "type": "array", "description": "Desired set of invoice-level discounts. If provided, replaces all existing discounts. Currently, only one element is supported.", "items": { "required": [ "coupon" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain a new discount. One of: `COUPON`." } } } }, "due_at": { "type": "string", "description": "Due date set by the merchant for this invoice, if any. Only one of `days_until_due` and `due_at` should be passed." }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this invoice. When enabled, the system attempts to calculate taxes automatically." }, "footer": { "type": "string", "description": "Additional payment instructions or supplementary information that merchants can share with their customers. Displayed in the Invoice PDF." }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section. Required if `collection_method` is `CHARGE_ON_CHECKOUT` when the invoice is finalized." }, "memo": { "type": "string", "description": "String used to describe the object. Referenced as memo or invoice note in Webapp." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to an invoice object. It can be useful for storing additional information about the invoice in a structured format." }, "description": "A set of key-value pairs that you can attach to an invoice object. It can be useful for storing additional information about the invoice in a structured format." }, "payment_options": { "type": "object", "description": "Payment settings of this Invoice. Only applicable if collection_method is `CHARGE_ON_CHECKOUT`.", "properties": { "payment_method_save": { "type": "object", "description": "Settings for saving this payment method for future use.", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`. \n`ENABLED`: The payment method will be saved for future use. \n`DISABLED`: The payment method will not be saved. \n`COLLECT_CONSENT`: The digital invoice UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`. \nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } } }, "payment_method_types": { "type": "array", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page. \nPossible enum values: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bank_transfer`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`.", "items": { "type": "string", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page. \nPossible enum values: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bank_transfer`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`." } } } }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the invoice. Required when `collection_method` is `AUTO_CHARGE`. \nIf `collection_method` is `CHARGE_ON_CHECKOUT`, a Payment Source is automatically created during invoice payment when `payment_options.payment_method_save.next_triggered_by` is `MERCHANT` and `payment_options.payment_method_save.mode` is `ENABLED`, or when it is `COLLECT_CONSENT` and the customer has given consent." }, "ui_options": { "type": "object", "description": "UI configuration for the digital invoice page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this invoice, overriding the theme configured for its legal entity. You can find the theme ID in the Airwallex web app under Settings > Themes." } } } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "due_at": "2025-01-27T12:00:00+0000", "enable_automatic_tax": true, "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "memo example", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" } } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" } } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "due_at": "2025-01-27T12:00:00+0000", "enable_automatic_tax": true, "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "memo example", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" } }, "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "footer": "Please include the reference number in your payment reference.\nFor remittance advice, contact accounts@example.com.", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000", "bank_transfer_instructions": { "currency": "USD", "account_name": "Tromp, Littel and Luettgen", "account_number": "8453687204", "bank_name": "Community Federal Savings Bank", "routing_number": "026073150", "reference": "QCNLQC" } } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/update_line_items": { "post": { "description": "This is only possible when the status of an [Invoice](/docs/api/billing/invoices) is in `DRAFT`. You can update up to 100 line items at a time. This bulk operation is atomic.", "operationId": "invoices_updateLineItems", "parameters": [ { "description": "ID of the Invoice object that this Invoice Line Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "line_items" ], "type": "object", "properties": { "line_items": { "maxItems": 100, "minItems": 0, "type": "array", "description": "List of Invoice Line Item to be updated.", "items": { "required": [ "id" ], "type": "object", "properties": { "description": { "type": "string", "description": "Description of the Invoice Line Item." }, "discounts": { "type": "array", "description": "Desired set of invoice line item level discounts. If provided, replaces all existing discounts. Currently, only one element is supported.", "items": { "required": [ "coupon" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain a new discount. One of: `COUPON`." } } } }, "id": { "type": "string", "description": "ID of the Invoice Line Item." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "quantity": { "minimum": 1, "type": "integer", "description": "The product quantity.", "format": "int32" }, "tax_percent": { "type": "number", "description": "The effective tax percent of this subscription item." } } } } } }, "examples": { "default": { "value": { "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "id": "iit_sgstjv2p9h24g7trp1e", "metadata": { "foo": "bar" }, "quantity": 1, "tax_percent": 5 } ] } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "14|Update Invoice Line Items in an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/update_line_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "line_items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "id": "iit_sgstjv2p9h24g7trp1e", "metadata": { "foo": "bar" }, "quantity": 1, "tax_percent": 5 } ] }, "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/invoices/{id}/void": { "post": { "description": "Void a finalized Invoice.", "operationId": "invoices_void", "parameters": [ { "description": "ID of the Invoice object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invoice_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "default": { "value": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "10|Void an Invoice", "tags": [ "Billing > Invoices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/invoices/invoice_id/void", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_due": 100, "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer": { "address": { "city": "Shanghai", "country_code": "CN", "postcode": "100000", "state": "Shanghai", "street": "Pudong District" }, "email": "john.doe@example.com", "name": "John Doe", "phone_number": "+1234567890", "tax_identification_number": "123-45-6789", "type": "INDIVIDUAL" }, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "credit_note_amount_after_payment": 10, "credit_note_amount_before_payment": 10, "currency": "USD", "days_until_due": 1, "default_tax_percent": 10, "due_at": "2022-12-05T10:15:30+0000", "enable_automatic_tax": true, "finalized_at": "2022-12-05T10:15:30+0000", "hosted_url": "https://invoice.airwallex.com/billing/invoices/payment?s=jwt_token", "id": "inv_hkpd49cskgblns6iimw", "last_payment_attempt_at": "2022-12-05T10:15:30+0000", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "memo": "Invoice memo.", "metadata": { "foo": "bar" }, "next_payment_attempt_at": "2022-12-05T10:15:30+0000", "number": "INV-YOLI0II9-0685", "paid_at": "2022-12-05T10:15:30+0000", "paid_out_of_band": false, "past_payment_attempt_count": 1, "payment_options": { "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" }, "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_d3Ds20ae5VihKs092", "payment_status": "UNPAID", "pdf_url": "https://invoice.airwallex.com/billing/invoices/pdf?s=jwt_token", "remaining_payment_attempt_count": 1, "status": "FINALIZED", "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "total_amount": 100, "total_discount_amounts": [ { "amount": 10, "applied_discount_id": "disc_hkpdkcmxdgazzq53jbk" } ], "total_tax_amount": 0, "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2022-01-01T10:15:30+0000", "voided_at": "2022-12-05T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.invoice:write", "group": "Billing", "resource_name": "Invoices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/{id}/archive": { "post": { "description": "Archive a Meter. The meter will no longer be available to be linked to new Prices. It can be archived only when there is no linked active price.", "operationId": "archive", "parameters": [ { "description": "ID of the Meter object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "meter_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meter" }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "6|Archive a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/meters/meter_id/archive", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/create": { "post": { "description": "Create a new Meter object.", "operationId": "createMeter", "requestBody": { "content": { "application/json": { "schema": { "required": [ "aggregation_method", "event_name", "name", "request_id" ], "type": "object", "properties": { "aggregation_method": { "pattern": "^(SUM|MAX|LAST|COUNT|UNIQUE)$", "type": "string", "description": "Type of aggregation to perform, based on each event's `properties` value.", "enum": [ "SUM", "MAX", "LAST", "COUNT", "UNIQUE" ], "x-enumDescriptions": { "SUM": "Sum up the value of each event.", "MAX": "Maximum of all event values.", "LAST": "The value of the last event.", "COUNT": "Count the number of events.", "UNIQUE": "Count the number of unique events." } }, "aggregation_property": { "type": "string", "description": "The name of the property within the event to aggregate. Events will be ignored during aggregation if they are missing this property or if its value is invalid." }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Meter description. Used for internal classification and identification." }, "dimension_keys": { "type": "array", "description": "Append-only list of event property keys. New keys can be appended; existing keys cannot be modified, removed, or renamed. Used for event grouping and filtering. A usage event may include any subset of these (or none).", "items": { "type": "string" } }, "event_name": { "maxLength": 200, "minLength": 0, "pattern": "^\\S*$", "type": "string", "description": "The name of the Usage Event to record for. Corresponds with the `event_name` field on [Usage Events](/docs/api/billing/usage_events)." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Meter name." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "description": "Tracks API requests made by customers.", "event_name": "api_call", "metadata": { "foo": "bar" }, "name": "API Requests", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meter" }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/meters/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "description": "Tracks API requests made by customers.", "event_name": "api_call", "metadata": { "foo": "bar" }, "name": "API Requests", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters": { "get": { "description": "Retrieves a list of Meters based on the query parameters.", "operationId": "listMeters", "parameters": [ { "description": "The meter's archived status, either `true` or `false`.", "in": "query", "name": "archived", "required": false, "schema": { "type": "boolean" } }, { "description": "The name of the Usage Event to record for. Corresponds with the `event_name` field on Usage Events.", "in": "query", "name": "event_name", "required": false, "schema": { "pattern": "^\\S*$", "type": "string" } }, { "description": "Type of aggregation to perform.", "in": "query", "name": "aggregation_method", "required": false, "schema": { "pattern": "^(SUM|MAX|LAST|COUNT|UNIQUE)$", "type": "string" } }, { "description": "Property within the event to aggregate.", "in": "query", "name": "aggregation_property", "required": false, "schema": { "pattern": "^\\S*$", "type": "string" } }, { "description": "The start time of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end time of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of results per page. Defaults to 20.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseMeter" }, "examples": { "default": { "value": { "items": [ { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Meters", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/meters", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:read", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/{id}/summaries": { "get": { "description": "Calculates the result of a Meter for a customer for a given time period.", "operationId": "listSummaries", "parameters": [ { "description": "ID of the Meter object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "meter_id" } } }, { "description": "ID of the Billing Customer object.", "in": "query", "name": "billing_customer_id", "required": true, "schema": { "type": "string" } }, { "description": "The start date of Usage Events' `happened_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_happened_at", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of Usage Events' `happened_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_happened_at", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "description": "The time window to group the usage summary by. If not specified, a single summary for the entire time range is returned. When specified, the response will contain a list of summaries, one for each time window in the range. Possible values are `HOUR` or `DAY`. For `HOUR` grouping, `from_happened_at` and `to_happened_at` must align with hour boundaries (e.g., 2025-03-15T14:00:00+0000). For `DAY` grouping, `from_happened_at` and `to_happened_at` must align with UTC day boundaries (e.g., 2025-03-15T00:00:00+0000). If not specified, `from_happened_at` and `to_happened_at` must align with minute boundaries e.g., 2025-03-15T14:01:00+0000). The duration must not exceed one year.", "in": "query", "name": "grouped_by", "required": false, "schema": { "type": "string" } }, { "description": "The event property keys to break the usage summary down by. Each key must be one of the Meter's `dimension_keys`. If not specified, usage is not broken down by event property keys. Can be combined with `grouped_by` to break down each time window further — the response then contains one summary per (time window × dimension key combination).", "in": "query", "name": "grouped_by_dimensions", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Filters the usage events included in the summary calculation by event property keys. Each key must be one of the Meter's `dimension_keys`.", "in": "query", "name": "dimension_filters", "required": false, "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": { "type": "string" } } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of summaries per page. Defaults to 20.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseMeterSummary" }, "examples": { "default": { "value": { "items": [ { "billing_customer_id": "bcus_1234567890abcdef", "dimension_values": { "model": "gpt-5.4", "token_type": "input" }, "event_count": 100, "from_happened_at": "2022-01-01T00:00:00+0000", "meter_id": "mtr_1234567890abcdef", "to_happened_at": "2022-01-02T00:00:00+0000", "value": 150.75 } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "7|Retrieve Summaries of a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/meters/meter_id/summaries", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "billing_customer_id": "bcus_1234567890abcdef", "dimension_values": { "model": "gpt-5.4", "token_type": "input" }, "event_count": 100, "from_happened_at": "2022-01-01T00:00:00+0000", "meter_id": "mtr_1234567890abcdef", "to_happened_at": "2022-01-02T00:00:00+0000", "value": 150.75 } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:read", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/{id}/restore": { "post": { "description": "Restore a Meter. The meter will be available to be linked to new Prices.", "operationId": "restore", "parameters": [ { "description": "ID of the Meter object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "meter_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meter" }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Restore a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/meters/meter_id/restore", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/{id}": { "get": { "description": "Retrieves the details of a Meter.", "operationId": "retrieveMeter", "parameters": [ { "description": "ID of the Meter object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "meter_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meter" }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/meters/meter_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:read", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/meters/{id}/update": { "post": { "description": "Update a meter.", "operationId": "updateMeter", "parameters": [ { "description": "ID of the Meter object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "meter_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Meter description. Used for internal classification and identification." }, "dimension_keys": { "type": "array", "description": "Complete list of dimension keys. Existing keys must remain unchanged and in the same order. New keys may only be appended.", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Meter name." } } }, "examples": { "default": { "value": { "description": "Updated description for tracking API requests made by customers.", "metadata": { "foo": "bar" }, "name": "Updated API Requests" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meter" }, "examples": { "default": { "value": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Meter", "tags": [ "Billing > Meters" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/meters/meter_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "description": "Updated description for tracking API requests made by customers.", "metadata": { "foo": "bar" }, "name": "Updated API Requests" }, "response_body": { "aggregation_method": "SUM", "aggregation_property": "quantity", "archived": false, "created_at": "2022-01-01T10:15:30+0000", "description": "Tracks API requests made by customers.", "event_name": "api_call", "id": "mtr_1234567890abcdef", "metadata": { "foo": "bar" }, "name": "API Requests", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/payment_sources/create": { "post": { "description": "Creates a **PaymentSource** using a linked payment method from a supported **Payment Service Provider (PSP)**.\nWhen **Airwallex Payments** is used as the PSP, you can create a **PaymentSource** with a **PaymentMethod** authorized for **merchant-initiated payments**. This authorization can be obtained in two ways:\n- **Indirectly**, by creating a **PaymentIntent** with `payment_consent.next_triggered_by=merchant`, and `payment_consent.merchant_trigger_reason=unscheduled`.\n- **Directly**, by creating a **PaymentConsent** with `next_triggered_by=merchant`, and `merchant_trigger_reason=unscheduled`.\n\nFor more details, refer to the [PaymentIntents API](/docs/api/payments/payment_intents) and [PaymentConsents API](/docs/api/payments/payment_consents) documentation.", "operationId": "createPaymentSource", "requestBody": { "content": { "application/json": { "schema": { "required": [ "billing_customer_id", "external_id", "request_id" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) that this Payment Source belongs to." }, "external_id": { "maxLength": 200, "minLength": 0, "type": "string", "description": "ID of the [Payment Method](/docs/api/payments/payment_methods) associated with the Payment Source." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section. Required if you have more than 1 payment account in your organisation." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "external_id": "mtd_hkpd1dsjklad5sa", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing_PaymentSource" }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Payment Source", "tags": [ "Billing > Payment Sources" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/payment_sources/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "external_id": "mtd_hkpd1dsjklad5sa", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.payment_source:write", "group": "Billing", "resource_name": "Payment Sources", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/payment_sources": { "get": { "description": "Retrieves a list of Payment Sources based on the query parameters.", "operationId": "listPaymentSources", "parameters": [ { "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) that the Payment Source belongs to.", "in": "query", "name": "billing_customer_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of the linked payment account that this Payment Source is created with. You can find this in the \"Account ID\" section under Account Details in the Settings on the Airwallex Webapp.", "in": "query", "name": "linked_payment_account_id", "required": false, "schema": { "type": "string" } }, { "description": "The corresponding Payment Source ID on the payment provider's side. For Airwallex, this is the Payment Method ID.", "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "description": "The start time of created_at in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end time of created_at in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Payment Sources to be listed per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponsePaymentSource" }, "examples": { "default": { "value": { "items": [ { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Payment Sources", "tags": [ "Billing > Payment Sources" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/payment_sources", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.payment_source:read", "group": "Billing", "resource_name": "Payment Sources", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/payment_sources/{id}": { "get": { "description": "Retrieves the details of a Payment Source.", "operationId": "retrievePaymentSource", "parameters": [ { "description": "ID of the Payment Source object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "payment_source_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Billing_PaymentSource" }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Payment Source", "tags": [ "Billing > Payment Sources" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/payment_sources/payment_source_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "mtd_hkpd1dsjklad5sa", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.payment_source:read", "group": "Billing", "resource_name": "Payment Sources", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/prices/create": { "post": { "description": "Create a new Price object.", "operationId": "createPrice", "requestBody": { "content": { "application/json": { "schema": { "required": [ "currency", "product_id", "request_id" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the price is available for new purchases, `false` otherwise. Defaults to `true`." }, "billing_type": { "type": "string", "description": "Indicates when should the price be billed, one of \n- `IN_ADVANCE`: billed at the beginning of the billing cycle.\n- `IN_ARREARS`: billed at the end of the billing cycle.\n\nDefaults to `IN_ADVANCE`." }, "currency": { "type": "string", "description": "Currency of the price (in 3-letter ISO-4217 format)." }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Price description. Used for internal classification and identification." }, "flat_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "lot": { "required": [ "rounding_mode", "size" ], "type": "object", "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT` price.", "properties": { "rounding_mode": { "pattern": "^UP$", "type": "string", "description": "Specifies how to round the calculated lots when the total quantity is not an exact multiple of the size. One of `UP`." }, "size": { "minimum": 2, "type": "integer", "description": "The amount of quantity that constitutes a single billable lot.", "format": "int32" } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "meter_id": { "type": "string", "description": "ID of the Meter object specifying how to calculate the usage for this price." }, "metered": { "type": "boolean", "description": "Specify how to determine the quantity of the product used in each billing cycle for subscription payments. `true` if the quantity is dynamically determined during the billing cycle. The merchant should call the Ingest Usage Events API to submit usage data when the product is used. `false` if the quantity is determined when creating a subscription." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity.\n- `VOLUME`: the unit price is based on which tier the total quantity falls in.\n- `GRADUATED`: the unit price changes as the quantity increases.\n\nDefaults to `PER_UNIT`." }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object this price is associated with." }, "recurring": { "required": [ "period_unit" ], "type": "object", "description": "The frequency at which the price is charged. null for one-time charge.", "properties": { "period": { "type": "integer", "description": "The number of period units between subscription billing cycles. For example, the billing cycle is bi-monthly if `period=2` and `period_unit=MONTH`. Defaults to `1`.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } } }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax. Defaults to `false`." }, "tiers": { "type": "array", "description": "List of quantity-based pricing tiers for this price. Required when the pricing model is `VOLUME` or `GRADUATED`.", "items": { "type": "object", "properties": { "flat_amount": { "minimum": 0, "type": "number", "description": "The flat amount to be charged for this tier when pricing model is `GRADUATED`, or the overall flat amount to be charged when pricing model is `VOLUME`." }, "lot": { "required": [ "rounding_mode", "size" ], "type": "object", "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `VOLUME` and `GRADUATED` prices.", "properties": { "rounding_mode": { "pattern": "^UP$", "type": "string", "description": "Specifies how to round the calculated lots when the total quantity is not an exact multiple of the size. One of `UP`." }, "size": { "minimum": 2, "type": "integer", "description": "The amount of quantity that constitutes a single billable lot.", "format": "int32" } } }, "unit_amount": { "minimum": 0, "type": "number", "description": "The per-unit amount to be charged for this tier when pricing model is `GRADUATED`, or the overall per-unit amount to be charged when pricing model is `VOLUME`." }, "unit_description": { "type": "string", "description": "Description of the billable unit for the tier." }, "upper_bound": { "minimum": 0, "type": "number", "description": "The upper quantity limit of this tier. This tier is applicable when the quantity does not exceed the upper bound of this tier, and is greater than the upper bound of the tier below it(or `0` if this is the first tier). For the last tier, the upper bound must be left empty." } } } }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." }, "unit_description": { "type": "string", "description": "Description of the billable unit for the price." } } }, "examples": { "default": { "value": { "active": true, "billing_type": "IN_ADVANCE", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "unit_amount": 0, "unit_description": "" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Price" }, "examples": { "default": { "value": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `resource_not_found`(invalid `product_id`), `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Price", "tags": [ "Billing > Prices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/prices/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "active": true, "billing_type": "IN_ADVANCE", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "unit_amount": 0, "unit_description": "" }, "response_body": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.price:write", "group": "Billing", "resource_name": "Prices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/prices": { "get": { "description": "Retrieves a list of Prices based on the query parameters.", "operationId": "listPrices", "parameters": [ { "description": "ID of the [Product](/docs/api/billing/products) object this price is associated with.", "in": "query", "name": "product_id", "required": false, "schema": { "type": "string" } }, { "description": "`true` if the price is available for new purchases, `false` otherwise.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" } }, { "description": "The currency of the Price in 3-letter ISO-4217 format.", "in": "query", "name": "currency", "required": false, "schema": { "type": "string" } }, { "description": "The number of period units between subscription billing cycles. For example, the billing cycle is bi-monthly if `recurring_period=2` and `recurring_period_unit=MONTH`.", "in": "query", "name": "recurring_period", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "Specifies billing frequency.", "in": "query", "name": "recurring_period_unit", "required": false, "schema": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Prices to be listed per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponsePrice" }, "examples": { "default": { "value": { "items": [ { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Prices", "tags": [ "Billing > Prices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/prices", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.price:read", "group": "Billing", "resource_name": "Prices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/prices/{id}": { "get": { "description": "Retrieves the details of a Price object by the ID.", "operationId": "retrievePrice", "parameters": [ { "description": "ID of the Price object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "price_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Price" }, "examples": { "default": { "value": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Price", "tags": [ "Billing > Prices" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/prices/price_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.price:read", "group": "Billing", "resource_name": "Prices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/prices/{id}/update": { "post": { "description": "Updates a Price by setting the values of the request parameters. Any parameters not provided will be left unchanged. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.", "operationId": "updatePrice", "parameters": [ { "description": "ID of the Price object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "price_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the price is available for new purchases, `false` otherwise." }, "description": { "type": "string", "description": "Price description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "active": true, "description": "Standard option: $10 / month.", "metadata": { "foo": "bar" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Price" }, "examples": { "default": { "value": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Price", "tags": [ "Billing > Prices" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/prices/price_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "active": true, "description": "Standard option: $10 / month.", "metadata": { "foo": "bar" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "level": 1, "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20, "level": 2 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.price:write", "group": "Billing", "resource_name": "Prices", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/products/create": { "post": { "description": "Creates a new Product object.", "operationId": "createProduct", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "request_id" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the product is available for new purchases, `false` otherwise. Defaults to `true`." }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Product description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Product name." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "tax_code": { "type": "string", "description": "The tax category of the product. Select the category that best describes this product to ensure accurate tax calculation. [Learn more about tax categories](/docs/billing/airwallex-tax/tax-categories)." }, "unit": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Product unit." } } }, "examples": { "default": { "value": { "active": true, "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_code": "pct_0504010000", "unit": "month" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" }, "examples": { "default": { "value": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Product", "tags": [ "Billing > Products" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/products/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "active": true, "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_code": "pct_0504010000", "unit": "month" }, "response_body": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.product:write", "group": "Billing", "resource_name": "Products", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/products": { "get": { "description": "Retrieves a list of Products based on the query parameters.", "operationId": "listProducts", "parameters": [ { "description": "`true` if the product is available for new purchases, `false` otherwise.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Products per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseProduct" }, "examples": { "default": { "value": { "items": [ { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Products", "tags": [ "Billing > Products" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/products", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.product:read", "group": "Billing", "resource_name": "Products", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/products/{id}": { "get": { "description": "Retrieves the product details by the ID.", "operationId": "retrieveProduct", "parameters": [ { "description": "ID of the Product object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "product_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" }, "examples": { "default": { "value": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Product", "tags": [ "Billing > Products" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/products/product_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.product:read", "group": "Billing", "resource_name": "Products", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/products/{id}/update": { "post": { "description": "Updates a Product. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.", "operationId": "updateProduct", "parameters": [ { "description": "ID of the Product object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "product_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the product is available for new purchases, `false` otherwise." }, "description": { "type": "string", "description": "Product description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Product name." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "tax_code": { "type": "string", "description": "The tax category of the product." }, "unit": { "type": "string", "description": "Product unit." } } }, "examples": { "default": { "value": { "active": true, "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_code": "pct_0504010000", "unit": "month" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" }, "examples": { "default": { "value": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Product", "tags": [ "Billing > Products" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/products/product_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "active": true, "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "tax_code": "pct_0504010000", "unit": "month" }, "response_body": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.product:write", "group": "Billing", "resource_name": "Products", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/{id}/cancel": { "post": { "description": "Cancels a Subscription immediately and refunds based on specified proration behavior.", "operationId": "subscriptions_cancel", "parameters": [ { "description": "ID of the Subscription object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "subscription_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "proration_behavior", "request_id" ], "type": "object", "properties": { "proration_behavior": { "type": "string", "description": "Determines how to handle prorations when canceling the Subscription. One of `ALL`, `PRORATED`, `NONE`.\n- `ALL`: refund the charge of the current period.\n- `PRORATED`: refund the proration.\n- `NONE`: won't refund for the Subscription's unused time." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." } } }, "examples": { "default": { "value": { "proration_behavior": "NONE", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "5|Cancel a Subscription", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/subscriptions/subscription_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "proration_behavior": "NONE", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:write", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/create": { "post": { "description": "Create a new Subscription for an existing Billing Customer to charge the customer on a recurring basis.", "operationId": "createSubscription", "requestBody": { "content": { "application/json": { "schema": { "required": [ "billing_customer_id", "collection_method", "items", "request_id" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who subscribes to this subscription." }, "billing_cycle_anchor_at": { "type": "string", "description": "A future timestamp in the first billing cycle as the reference point to align the future billing date." }, "collection_method": { "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "currency": { "type": "string", "description": "The currency of the subscription in 3-letter ISO-4217 format." }, "days_until_due": { "minimum": 0, "type": "integer", "description": "Number of days from invoice finalization until payment is due. Defaults to `0`.", "format": "int32" }, "default_invoice_template": { "type": "object", "description": "Invoices for this subscription will be created using the specified settings.", "properties": { "invoice_memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Memo to be used for the invoices that are generated by this Subscription." } } }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to invoices to be generated. The tax will be exclusive. Defaults to `0`." }, "discounts": { "type": "array", "description": "List of discounts to be applied to the subscription. Discounts of subscription items are applied before subscription discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "The total billing duration of the subscription. The subscription will continue indefinitely if both of `duration` and `ends_at` are null.\nIt is only applicable when `ends_at` is empty. \n", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of period units.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing duration. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } } }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this subscription. When enabled, the system attempts to calculate taxes for this subscription's invoice automatically. Defaults to `false`." }, "ends_at": { "type": "string", "description": "Time when the subscription is scheduled to end. The subscription will continue indefinitely if both of `duration` and `ends_at` are null.\nIt is only applicable when `duration` is empty. \n" }, "items": { "type": "array", "description": "List of Subscription Items.", "items": { "type": "object", "properties": { "discounts": { "type": "array", "description": "List of discounts to be applied to the Subscription Item. Discounts of subscription items are applied before subscription discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "price": { "required": [ "currency" ], "type": "object", "description": "One-time price definition following the same schema as the [Price](/docs/api/billing/prices) resource. Exactly one of `price_id`, `price`, or `rate_card_id` is required.", "properties": { "currency": { "type": "string", "description": "Currency of the price (in 3-letter ISO-4217 format)." }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Price description. Used for internal classification and identification." }, "flat_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "Custom key-value pairs attached to the price." }, "description": "Custom key-value pairs attached to the price." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity.\nDefaults to `PER_UNIT`." }, "product": { "required": [ "name" ], "type": "object", "description": "One-time product definition following the same schema as the [Product](/docs/api/billing/products). Exactly one of `product_id` or `product` is required.", "properties": { "description": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Product description. Used for internal classification and identification." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Product name." }, "tax_code": { "type": "string", "description": "The tax category of the product." }, "unit": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Product unit." } } }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object. Exactly one of `product_id` or `product` is required." }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax. Defaults to `false`." }, "unit_amount": { "maximum": 9999999999, "minimum": 0, "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." } } }, "price_id": { "type": "string", "description": "ID of the [Price](/docs/api/billing/prices) subscribed by the customer. All Prices in the subscription must have recurring frequencies that are compatible - meaning they must be exact multiples or divisors of one another (e.g., `1 MONTH` and `1 YEAR` are compatible; `1 WEEK` and `1 MONTH` are not). Exactly one of `price_id`, `price`, or `rate_card_id` is required." }, "quantity": { "minimum": 1, "type": "integer", "description": "The quantity of the product. Defaults to `1`.", "format": "int32" }, "rate_card_id": { "type": "string", "description": "ID of a [Rate Card](/docs/api/billing/rate_cards) object. Exactly one of `price_id`, `price`, or `rate_card_id` is required." }, "rate_card_version": { "type": "integer", "description": "Pinned Rate Card version number. Required when `rate_card_id` is set.", "format": "int32" }, "tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The effective tax percent of this subscription item." } } } }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings. Required if you have more than 1 entity in your organisation." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section. Required if `collection_method` is `CHARGE_ON_CHECKOUT` and if you have more than 1 payment account in your organisation." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "payment_options": { "type": "object", "description": "Payment settings applied to invoices generated by this Subscription. Only applicable when `collection_method` is `CHARGE_ON_CHECKOUT` or `AUTO_CHARGE`.", "properties": { "payment_method_types": { "type": "array", "description": "Specify the payment methods and their order for display on the digital invoice pages of this Subscription. Note: Only payment methods supported for the specified currency and the customer's country code will be shown. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`.", "items": { "type": "string", "description": "Specify the payment methods and their order for display on the digital invoice pages of this Subscription. Note: Only payment methods supported for the specified currency and the customer's country code will be shown. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`." } }, "payment_method_save": { "type": "object", "description": "Settings that control whether and how a payment method provided by a customer while paying a subscription invoice is saved for future use.\nOnly applicable when the Subscription uses the `AUTO_CHARGE` collection method.\nWhen not provided, defaults to `mode=ENABLED` and `next_triggered_by=MERCHANT`.", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`.\n- `ENABLED`: The payment method will be saved for future use.\n- `DISABLED`: The payment method will not be saved.\n- `COLLECT_CONSENT`: The invoice UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`.\nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } } } } }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the subscription at each billing period. Required if `collection_method` is `AUTO_CHARGE`." }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "starts_at": { "type": "string", "description": "Time when the subscription started or scheduled to start. Defaults to start immediately after creation." }, "trial_ends_at": { "type": "string", "description": "The end time of the trial if applicable." } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": false, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "metadata": { "foo": "bar" }, "price": { "currency": "USD", "description": "Standard option: $10 / month.", "pricing_model": "PER_UNIT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 2, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 2 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-01-05T10:15:30+0000" } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request_id`, `suspended_from_online_payments`, `currency_not_supported`, `provider_unavailable`, `resource_not_found`(invalid `billing_customer_id` or `payment_source_id`), `frequency_above_limit`, `configuration_error`, `authentication_declined`, `risk_declined`, `provider_declined`, `quote_expired`, `issuer_declined`, `no_3ds_liability_shift`, `rejected_by_routing_rules`. \n \nFor payment-related error codes (`authentication_declined`, `risk_declined`, `provider_declined`, `quote_expired`, `issuer_declined`, `no_3ds_liability_shift`, `rejected_by_routing_rules`), ID of the [Payment Intent](/docs/api/payments/payment_intents) will be returned in the error `details`. Retrieve the Payment Intent to get detailed error information for the failed payment." }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Create a Subscription", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/subscriptions/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "collection_method": "AUTO_CHARGE", "currency": "USD", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": false, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "metadata": { "foo": "bar" }, "price": { "currency": "USD", "description": "Standard option: $10 / month.", "pricing_model": "PER_UNIT", "product": { "description": "The license to use software in one month.", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "tax_included": false }, "price_id": "pri_hkpd7fedfgb004apkvs", "quantity": 2, "tax_percent": 5 }, { "rate_card_id": "rtc_hkpd8gfdghc115bqlwt", "rate_card_version": 2 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-01-05T10:15:30+0000" }, "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:write", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions": { "get": { "description": "Retrieves a list of Subscriptions based on the query parameters.", "operationId": "listSubscriptions", "parameters": [ { "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who subscribes to this subscription.", "in": "query", "name": "billing_customer_id", "required": false, "schema": { "type": "string" } }, { "description": "Status of the subscription, one of `PENDING`, `IN_TRIAL`, `ACTIVE`, `UNPAID` or `CANCELLED`.", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "The start date of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The number of period units between subscription billing cycles.", "in": "query", "name": "recurring_period", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH` or `YEAR`.", "in": "query", "name": "recurring_period_unit", "required": false, "schema": { "type": "string" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Subscriptions per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseSubscription" }, "examples": { "default": { "value": { "items": [ { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|List all Subscriptions", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/subscriptions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:read", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/{id}/items": { "get": { "description": "Retrieves a list of Subscription Items based on the query parameters.", "operationId": "subscriptions_listItems", "parameters": [ { "description": "ID of the Subscription object that the Subscription Items belong to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "subscription_id" } } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Subscription Items per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseSubscriptionItem" }, "examples": { "default": { "value": { "items": [ { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "current_period_ends_at": "2022-02-01T10:15:30+0000", "current_period_starts_at": "2022-01-01T10:15:30+0000", "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 2, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "tax_percent": 5, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "7|List all Subscription Items", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/subscriptions/subscription_id/items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "current_period_ends_at": "2022-02-01T10:15:30+0000", "current_period_starts_at": "2022-01-01T10:15:30+0000", "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 2, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "tax_percent": 5, "updated_at": "2022-01-01T10:15:30+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:read", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/{id}": { "get": { "description": "Retrieves the details of a Subscription using the given Subscription ID.", "operationId": "retrieveSubscription", "parameters": [ { "description": "ID of the Subscription object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "subscription_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Retrieve a Subscription", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/subscriptions/subscription_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ] }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:read", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/{id}/items/{item_id}": { "get": { "description": "Retrieves the details of a Subscription Item.", "operationId": "retrieveItem", "parameters": [ { "description": "ID of the Subscription object that this Subscription Item belongs to.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "subscription_id" } } }, { "description": "ID of the Subscription Item object.", "in": "path", "name": "item_id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "item_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionItem" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "current_period_ends_at": "2022-02-01T10:15:30+0000", "current_period_starts_at": "2022-01-01T10:15:30+0000", "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 2, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "tax_percent": 5, "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "6|Retrieve a Subscription Item", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/subscriptions/subscription_id/items/item_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "created_at": "2022-01-01T10:15:30+0000", "current_period_ends_at": "2022-02-01T10:15:30+0000", "current_period_starts_at": "2022-01-01T10:15:30+0000", "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price": { "active": true, "billing_type": "IN_ADVANCE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "description": "Standard option: $10 / month.", "flat_amount": 0, "id": "pri_hkpd7fedfgb004apkvs", "lot": { "rounding_mode": "UP", "size": 10 }, "metadata": { "foo": "bar" }, "meter_id": "", "metered": false, "pricing_model": "GRADUATED", "product": { "active": true, "created_at": "2022-01-01T10:15:30+0000", "description": "The license to use software in one month.", "id": "prd_hkpd1x2gbgazzvcd42w", "metadata": { "foo": "bar" }, "name": "Software License", "tax_code": "pct_0504010000", "unit": "month", "updated_at": "2022-01-01T10:15:30+0000" }, "product_id": "prd_hkpd1x2gbgazzvcd42w", "recurring": { "period": 1, "period_unit": "MONTH" }, "tax_included": false, "tiers": [ { "unit_amount": 10, "upper_bound": 20 }, { "flat_amount": 20 } ], "type": "RECURRING", "unit_amount": 0, "unit_description": "", "updated_at": "2022-01-01T10:15:30+0000" }, "quantity": 2, "subscription_id": "sub_hkpdkcmxdgazzq53jbk", "tax_percent": 5, "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:read", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/subscriptions/{id}/update": { "post": { "description": "Updates a Subscription. Only fields provided in the request are updated, while omitted fields remain unchanged. Array fields are fully replaced if included. Set a field to null or an empty string (for strings) to clear its value.", "operationId": "updateSubscription", "parameters": [ { "description": "ID of the Subscription object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "subscription_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "request_id" ], "type": "object", "properties": { "billing_action": { "type": "string", "description": "Specifies how to handle billing when updating the subscription.\nDefaults to `DEFER_CHARGE_AND_KEEP_CYCLE`.", "enum": [ "DEFER_CHARGE_AND_KEEP_CYCLE", "IMMEDIATE_CHARGE_AND_KEEP_CYCLE", "IMMEDIATE_CHARGE_AND_RESET_CYCLE" ], "x-enumDescriptions": { "DEFER_CHARGE_AND_KEEP_CYCLE": "Prorated in-advance fees are applied to the next upcoming invoice. In-arrears fees are still billed on its original billing date. Keep the current billing cycle anchor unchanged.", "IMMEDIATE_CHARGE_AND_KEEP_CYCLE": "A one-time adjustment invoice is generated and attempted for payment upon the subscription update. Keep the current billing cycle anchor unchanged.", "IMMEDIATE_CHARGE_AND_RESET_CYCLE": "Resets the subscription's `billing_cycle_anchor_at` to the time of update request. After you reset the billing cycle anchor, the subscription immediately sends an invoice for prorations. The upcoming billing cycles will be aligned on the new billing cycle anchor." } }, "cancel_at_period_end": { "type": "boolean", "description": "`true` if the subscription is scheduled to be cancelled at the end of the current period, `false` otherwise." }, "collection_method": { "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "days_until_due": { "minimum": 0, "type": "integer", "description": "Number of days from invoice finalization until payment is due.", "format": "int32" }, "default_invoice_template": { "type": "object", "description": "Invoices for this subscription will be created using the specified settings.", "properties": { "invoice_memo": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Memo to be used for the invoices that are generated by this Subscription." } } }, "default_proration_mode": { "type": "string", "description": "By default, how to handle credit and fee prorations for all Subscription Item changes.\nDefaults to `PRORATED`.", "enum": [ "NONE", "PRORATED", "ALL" ], "x-enumDescriptions": { "NONE": "Does not issue any credit for the Subscription's unused time, only charges the new fee from the next billing cycle.", "PRORATED": "Calculates and applies the proration on both credit and fee for the Subscription's unused time.", "ALL": "Credits the full remaining creditable amount of the old items for the current billing cycle, and charges the full amount of the new items for the current billing cycle." } }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to invoices to be generated. The tax will be exclusive." }, "discounts": { "maxItems": 1, "minItems": 0, "type": "array", "description": "Desired set of subscription-level discounts. If provided, replaces all existing subscription-level discounts. Currently, only one element is supported.", "items": { "required": [ "coupon" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain a new discount. One of: `COUPON`." } } } }, "duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "The total billing duration of the subscription.\n\n The subscription will continue indefinitely if `duration`, `remaining_duration` and `ends_at` are all null in the update request.", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of period units.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing duration. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } } }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this subscription. When enabled, the system attempts to calculate taxes for this subscription's invoice automatically." }, "ends_at": { "type": "string", "description": "Time when the subscription is scheduled to end.\n\n The subscription will continue indefinitely if `duration`, `remaining_duration` and `ends_at` are all null in the update request." }, "items": { "type": "array", "description": "List of Subscription Items to be added, updated, or deleted. It may trigger credit and proration when the subscription status is `ACTIVE`. If an existing item is not included in the list, it remains unchanged. You may add 100 items at a time.", "items": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "If set to true, will delete the specified subscription item." }, "discounts": { "type": "array", "description": "List of discounts to be applied to the Subscription Item. Discounts of subscription items are applied before subscription discounts. Currently, only one element is supported.", "items": { "required": [ "coupon", "type" ], "type": "object", "properties": { "coupon": { "required": [ "id" ], "type": "object", "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`.", "properties": { "id": { "type": "string", "description": "Id of the Coupon object." } } }, "type": { "pattern": "^(COUPON)$", "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } } }, "id": { "type": "string", "description": "ID of the Subscription Item to be updated or be deleted. If not provided, a new Subscription Item will be added." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "price_id": { "type": "string", "description": "ID of the Price. Required when adding a new item. You can't update the `price_id` of the existing item." }, "proration_mode": { "type": "string", "description": "Specifies how to handle credit and fee prorations for the Subscription Item. This field overrides the `default_proration_mode` provided in the update request.\nDefaults to `PRORATED`.", "enum": [ "NONE", "PRORATED", "ALL", "CUSTOM" ], "x-enumDescriptions": { "NONE": "Does not issue any credit for the Subscription's unused time, only charges the new fee from the next billing cycle.", "PRORATED": "Calculates and applies the proration on both credit and fee for the Subscription's unused time.", "ALL": "Credits the full remaining creditable amount of the old items for the current billing cycle, and charges the full amount of the new items for the current billing cycle.", "CUSTOM": "Uses merchant-specified charge and credit amounts instead of calculating prorated amounts automatically." } }, "quantity": { "minimum": 1, "type": "integer", "description": "The quantity of the product.", "format": "int32" }, "rate_card_id": { "type": "string", "description": "ID of the [Rate Card](/docs/api/billing/rate_cards) object. Required when adding a new item. You can't update the `rate_card_id` of the existing item." }, "rate_card_version": { "type": "integer", "description": "Pinned Rate Card version number. Required when adding a new item with `rate_card_id`.", "format": "int32" }, "tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The effective tax percent of this subscription item." }, "proration_value": { "type": "object", "description": "Custom charge and credit amounts in the billing currency. Required when `proration_mode` is `CUSTOM` and must be omitted otherwise. At least one of `charge_amount` or `credit_amount` must be provided.", "anyOf": [ { "required": [ "charge_amount" ] }, { "required": [ "credit_amount" ] } ], "properties": { "charge_amount": { "type": "string", "description": "Base amount to charge for this item, expressed as a decimal string in the billing currency." }, "credit_amount": { "type": "string", "description": "Base amount to credit for this item, expressed as a decimal string in the billing currency." } }, "example": { "charge_amount": "100.00", "credit_amount": "20.00" } } } } }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "payment_options": { "type": "object", "description": "Payment settings applied to invoices generated by this Subscription. Only applicable when `collection_method` is `CHARGE_ON_CHECKOUT` or `AUTO_CHARGE`.", "properties": { "payment_method_types": { "type": "array", "description": "Specify the payment methods and their order for display on the digital invoice pages of this Subscription. Note: Only payment methods supported for the specified currency and the customer's country code will be shown. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`.", "items": { "type": "string", "description": "Specify the payment methods and their order for display on the digital invoice pages of this Subscription. Note: Only payment methods supported for the specified currency and the customer's country code will be shown. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`." } }, "payment_method_save": { "type": "object", "description": "Settings that control whether and how a payment method provided by a customer while paying a subscription invoice is saved for future use.\nOnly applicable when the Subscription uses the `AUTO_CHARGE` collection method.\nWhen not provided, defaults to `mode=ENABLED` and `next_triggered_by=MERCHANT`.", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`.\n- `ENABLED`: The payment method will be saved for future use.\n- `DISABLED`: The payment method will not be saved.\n- `COLLECT_CONSENT`: The invoice UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`.\nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } } } } }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the subscription at each billing period. Required if `collection_method` is `AUTO_CHARGE`. If the payment_source_id is updated, the last failed invoice payment associated with this subscription will be retried immediately." }, "remaining_duration": { "required": [ "period", "period_unit" ], "type": "object", "description": "Update the remaining billing duration of the subscription after the time of request.\n\n The subscription will continue indefinitely if `duration`, `remaining_duration` and `ends_at` are all null in the update request.", "properties": { "period": { "minimum": 1, "type": "integer", "description": "The number of period units.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing duration. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } } }, "request_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique request ID specified by the merchant." }, "starts_at": { "type": "string", "description": "Time when the subscription started or is scheduled to start. Use `NOW` to start the subscription immediately. Only applicable when `status` is `PENDING`." }, "trial_ends_at": { "type": "string", "description": "The end time of the trial if applicable. Use `NOW` to end the trial immediately." }, "proration_date": { "type": "string", "format": "date-time", "description": "Timestamp used to calculate prorations for the subscription update. Must fall within the current billing period. If omitted, no proration timestamp override is applied. To use the same proration calculation time as [Preview an Invoice](/docs/api/billing/invoices/preview), pass the same `proration_date` used in the preview.", "example": "2026-01-15T10:15:30Z" } } }, "examples": { "default": { "value": { "billing_action": "DEFER_CHARGE_AND_KEEP_CYCLE", "cancel_at_period_end": false, "collection_method": "AUTO_CHARGE", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_proration_mode": "PRORATED", "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "deleted": false, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price_id": "pri_hkpd7fedfgb004apkvs", "proration_mode": "PRORATED", "quantity": 2, "tax_percent": 10 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "remaining_duration": { "period": 12, "period_unit": "MONTH" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-05-20T13:14:00+0000" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" }, "examples": { "default": { "value": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `resource_not_found`(invalid `payment_consent_id`), `duplicate_request_id`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "4|Update a Subscription", "tags": [ "Billing > Subscriptions" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/subscriptions/subscription_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "billing_action": "DEFER_CHARGE_AND_KEEP_CYCLE", "cancel_at_period_end": false, "collection_method": "AUTO_CHARGE", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_proration_mode": "PRORATED", "default_tax_percent": 10, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "2023-01-01T10:15:30+0000", "items": [ { "deleted": false, "discounts": [ { "coupon": { "id": "coup_abc123" }, "type": "COUPON" } ], "id": "sit_hkpdwesy9gazzrtqbkg", "metadata": { "foo": "bar" }, "price_id": "pri_hkpd7fedfgb004apkvs", "proration_mode": "PRORATED", "quantity": 2, "tax_percent": 10 } ], "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "remaining_duration": { "period": 12, "period_unit": "MONTH" }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "starts_at": "2022-01-01T10:15:30+0000", "trial_ends_at": "2022-05-20T13:14:00+0000" }, "response_body": { "applied_discounts": [ { "amount_off": 10, "applied_to": "SUBSCRIPTION", "applied_to_id": "sub_hkpdkcmxdgazzq53jbk", "billing_customer_id": "bcus_7fz9qm2n4k", "checkout_id": "bco_sgstcdcpnh8sv3awiwo", "currency": "USD", "discount_model": "PERCENTAGE", "duration": { "period": 3, "period_unit": "MONTH" }, "duration_type": "CUSTOM", "ends_at": "2027-01-01T00:00:00+0000", "id": "disc_hkpdkcmxdgazzq53jbk", "name": "Black Friday 20% Off", "percentage_off": 20, "source": "COUPON", "source_id": "coup_hkpdkcmxdgazzq53jbk", "starts_at": "2026-01-01T00:00:00+0000" } ], "automatic_tax_status": "APPLIED", "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "billing_cycle_anchor_at": "2022-01-15T10:15:30+0000", "cancel_at_period_end": false, "cancel_requested_at": "null", "collection_method": "AUTO_CHARGE", "created_at": "2022-01-01T10:15:30+0000", "currency": "USD", "current_period_ends_at": "2022-02-05T10:15:30+0000", "current_period_starts_at": "2022-01-05T10:15:30+0000", "days_until_due": 0, "default_invoice_template": { "invoice_memo": "Thanks for your purchase." }, "default_tax_percent": 10, "duration": { "period": 12, "period_unit": "MONTH" }, "enable_automatic_tax": true, "ends_at": "null", "id": "sub_hkpdkcmxdgazzq53jbk", "latest_invoice_id": "inv_hkpdmiq8hgb00f8cpdl", "legal_entity_id": "le_ib2DZgZJN72T7bObvNuMYQ", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "next_billing_at": "2022-02-05T10:15:30+0000", "payment_options": { "payment_method_types": [ "card", "googlepay", "applepay" ], "payment_method_save": { "mode": "ENABLED", "next_triggered_by": "MERCHANT" } }, "payment_source_id": "psrc_sgpdkxpn2h6anetrb5s", "recurring": { "period": 1, "period_unit": "MONTH" }, "starts_at": "2022-01-01T10:15:30+0000", "status": "ACTIVE", "trial_ends_at": "2022-01-05T10:15:30+0000", "trial_starts_at": "2022-01-01T10:15:30+0000", "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.subscription:write", "group": "Billing", "resource_name": "Subscriptions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_transactions": { "get": { "description": "Retrieves a list of Billing Transactions based on the query parameters.", "operationId": "listBillingTransactions", "parameters": [ { "description": "ID of the [Invoice](/docs/api/billing/invoices) this Billing Transaction is associated with. Exactly one of `invoice_id` or `credit_note_id` is required.", "in": "query", "name": "invoice_id", "required": false, "schema": { "type": "string" } }, { "description": "ID of the [Credit Note](/docs/api/billing/credit_notes) this Billing Transaction is associated with. Exactly one of `invoice_id` or `credit_note_id` is required.", "in": "query", "name": "credit_note_id", "required": false, "schema": { "type": "string", "example": "crn_hkpda1313adfadfa" } }, { "description": "The start date of `created_at` in ISO8601 format (inclusive).", "in": "query", "name": "from_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "The end date of `created_at` in ISO8601 format (exclusive).", "in": "query", "name": "to_created_at", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not `null`) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not `null`) from the response to a subsequent call.", "in": "query", "name": "page", "required": false, "schema": { "type": "string" } }, { "description": "Number of Billing Transactions per page. Defaults to `20`.", "in": "query", "name": "page_size", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginationClientApiResponseTransaction" }, "examples": { "default": { "value": { "items": [ { "amount": 19.99, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2023-06-15T12:30:00+0000", "created_at": "2023-06-15T12:30:00+0000", "currency": "USD", "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "id": "btxn_hkst2n8dxh3h6vaiq9i", "invoice_id": "inv_hkpd49cskgblns6iimw", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "order_id": "ORD-12345" }, "out_of_band": false, "payment_source_id": "psrc_sgstvjkjjh7lzraf39f", "status": "SUCCEEDED", "succeeded_at": "2023-06-15T12:35:01+0000", "type": "PAYMENT", "updated_at": "2023-06-15T12:30:00+0000" } ], "page_after": "", "page_before": "" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|List all Billing Transactions", "tags": [ "Billing > Billing Transactions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount": 19.99, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2023-06-15T12:30:00+0000", "created_at": "2023-06-15T12:30:00+0000", "currency": "USD", "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "id": "btxn_hkst2n8dxh3h6vaiq9i", "invoice_id": "inv_hkpd49cskgblns6iimw", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "order_id": "ORD-12345" }, "out_of_band": false, "payment_source_id": "psrc_sgstvjkjjh7lzraf39f", "status": "SUCCEEDED", "succeeded_at": "2023-06-15T12:35:01+0000", "type": "PAYMENT", "updated_at": "2023-06-15T12:30:00+0000" } ], "page_after": "", "page_before": "" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.transaction:read", "group": "Billing", "resource_name": "Billing Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/billing_transactions/{id}": { "get": { "description": "Retrieves the details of a Billing Transaction.", "operationId": "retrieveBillingTransaction", "parameters": [ { "description": "ID of the Billing Transaction object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_transaction_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" }, "examples": { "default": { "value": { "amount": 19.99, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2023-06-15T12:30:00+0000", "created_at": "2023-06-15T12:30:00+0000", "currency": "USD", "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "id": "btxn_hkst2n8dxh3h6vaiq9i", "invoice_id": "inv_hkpd49cskgblns6iimw", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "order_id": "ORD-12345" }, "out_of_band": false, "payment_source_id": "psrc_sgstvjkjjh7lzraf39f", "status": "SUCCEEDED", "succeeded_at": "2023-06-15T12:35:01+0000", "type": "PAYMENT", "updated_at": "2023-06-15T12:30:00+0000" } } } } }, "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Retrieve a Billing Transaction", "tags": [ "Billing > Billing Transactions" ], "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/billing/billing_transactions/billing_transaction_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 19.99, "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "cancelled_at": "2023-06-15T12:30:00+0000", "created_at": "2023-06-15T12:30:00+0000", "currency": "USD", "external_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "id": "btxn_hkst2n8dxh3h6vaiq9i", "invoice_id": "inv_hkpd49cskgblns6iimw", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "order_id": "ORD-12345" }, "out_of_band": false, "payment_source_id": "psrc_sgstvjkjjh7lzraf39f", "status": "SUCCEEDED", "succeeded_at": "2023-06-15T12:35:01+0000", "type": "PAYMENT", "updated_at": "2023-06-15T12:30:00+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.transaction:read", "group": "Billing", "resource_name": "Billing Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/usage_events/batch_ingest": { "post": { "description": "Ingest new usage events in a batch. The events are validated and processed asynchronously. If errors occur, webhook events will be published. Maximum 10 events per request.", "operationId": "batchIngest", "requestBody": { "content": { "application/json": { "schema": { "required": [ "events" ], "type": "object", "properties": { "events": { "type": "array", "description": "List of usage events to ingest. Maximum 10 events per request.", "items": { "required": [ "billing_customer_id", "event_name", "merchant_event_id", "properties" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) related to this usage event." }, "event_name": { "maxLength": 200, "minLength": 0, "pattern": "^\\S*$", "type": "string", "description": "The name of the event. Corresponds with the `event_name` field on a meter." }, "happened_at": { "type": "string", "description": "Time when this event happened. Must be within the past 35 days or up to 5 minutes in the future. Defaults to now.", "format": "date-time" }, "merchant_event_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "A unique identifier for the event. This value must be unique within a rolling 35-day period and is limited to a maximum of 64 characters." }, "properties": { "type": "object", "additionalProperties": { "type": "string", "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." }, "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." } } } } } }, "examples": { "default": { "value": { "events": [ { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" } } ] } } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Accepted" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "2|Batch Ingest Usage Events", "tags": [ "Billing > Usage Events" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/usage_events/batch_ingest", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "events": [ { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" } } ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/usage_events/ingest": { "post": { "description": "Ingest a single usage event. The event is validated synchronously, but is processed asynchronously. For higher rate limits, please use the [Batch Ingest Usage Events API](/docs/api/billing/usage_events/batch_ingest) instead.", "operationId": "ingest", "requestBody": { "content": { "application/json": { "schema": { "required": [ "billing_customer_id", "event_name", "merchant_event_id", "properties" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) related to this usage event." }, "event_name": { "maxLength": 200, "minLength": 0, "pattern": "^\\S*$", "type": "string", "description": "The name of the event. Corresponds with the `event_name` field on a meter." }, "happened_at": { "type": "string", "description": "Time when this event happened. Must be within the past 35 days or up to 5 minutes in the future. Defaults to now.", "format": "date-time" }, "merchant_event_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "A unique identifier for the event. This value must be unique within a rolling 35-day period and is limited to a maximum of 64 characters." }, "properties": { "type": "object", "additionalProperties": { "type": "string", "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." }, "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." } } }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "happened_at": "", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" } } } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageEvent" }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "happened_at": "", "ingested_at": "", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" }, "voided": false, "voided_at": "2025-08-03T00:00:00+0000" } } } } }, "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "1|Ingest a Usage Event", "tags": [ "Billing > Usage Events" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/usage_events/ingest", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "happened_at": "", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" } }, "response_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "event_name": "api_call", "happened_at": "", "ingested_at": "", "merchant_event_id": "merchant_event_12345", "properties": { "quantity": "1", "region": "us-east-1", "userId": "userA" }, "voided": false, "voided_at": "2025-08-03T00:00:00+0000" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/billing/usage_events/void": { "post": { "description": "Void a previous usage event ingested within 35 days.", "operationId": "usageEvents_void", "requestBody": { "content": { "application/json": { "schema": { "required": [ "merchant_event_id" ], "type": "object", "properties": { "merchant_event_id": { "maxLength": 64, "minLength": 0, "type": "string", "description": "Unique identifier of a previous event." } } }, "examples": { "default": { "value": { "merchant_event_id": "merchant_event_12345" } } } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": {} } }, "description": "Accepted" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "summary": "3|Void a Usage Event", "tags": [ "Billing > Usage Events" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/billing/usage_events/void", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "merchant_event_id": "merchant_event_12345" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "billing.usage_metering:write", "group": "Billing", "resource_name": "Usage Metering", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true } }, "/api/v1/confirmation_letters/create": { "post": { "tags": [ "Confirmation Letter > Confirmation Letter" ], "summary": "1|Create a Confirmation Letter", "description": "Given a transaction id , to generate confirmation letter , return as file stream, currently support deposit and payment.", "operationId": "confirmationLettersCreate", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "transaction_id" ], "properties": { "format": { "type": "string", "description": "The format of confirmation letter : \n * `STANDARD` - this format includes fee info.\n * `NO_FEE_DISPLAY` - this format won't display fee info." }, "transaction_id": { "type": "string", "description": "Unique identifier of the deposit or transfer to get confirmation letter." } } }, "examples": { "default": { "value": { "format": "NO_FEE_DISPLAY", "transaction_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" } } } } }, "description": "dto", "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "details": { "type": "object" }, "message": { "type": "string" }, "source": { "type": "string" } }, "title": "ErrorResponse" } }, "application/pdf": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "details": { "type": "object" }, "message": { "type": "string" }, "source": { "type": "string" } }, "title": "ErrorResponse" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/confirmation_letters/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "format": "NO_FEE_DISPLAY", "transaction_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "payouts.transfer:read", "group": "Payouts", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true }, { "scope": "payouts.transfer:write", "group": "Payouts", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true }, { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/balances/current": { "get": { "tags": [ "Core Resources > Balances" ], "summary": "1|List all Current Balances", "description": "Get *available* and *pending* balances for every currency.", "operationId": "listCurrent", "parameters": [ { "name": "account_type", "in": "query", "description": "The type of account to query. Supported values: `cash`, `yield`, `credit`.", "required": false, "schema": { "type": "string", "default": "cash" } }, { "name": "x-on-behalf-of", "in": "header", "description": "Unique identifier of the connected sub account.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CoreBankingWalletBalance" } }, "examples": { "default": { "value": [ { "account_type": "cash", "available_amount": 100000, "currency": "AUD", "pending_amount": 50000, "prepayment_amount": 0, "reserved_amount": 0, "total_amount": 150000 } ] } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/balances/current", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": [ { "account_type": "cash", "available_amount": 100000, "currency": "AUD", "pending_amount": 50000, "prepayment_amount": 0, "reserved_amount": 0, "total_amount": 150000 } ] } ], "x-scope": [ { "scope": "balance:read", "group": "Core Resources", "resource_name": "Balances", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/balances/history": { "get": { "tags": [ "Core Resources > Balances" ], "summary": "2|Retrieve the Balance History", "description": "Get balance history for an account based on the transaction currency. The response contains records where each record represents a change to the balance. You can filter results using the date range parameters, `from_post_at` and `to_post_at`, representing the time the balance change occurred in your Wallet. The date range should be within 7 days when using `page_num` to paginate through history. Alternatively, you can paginate using the `page` parameter to retrieve either the previous page or the next page of results.", "operationId": "listHistory", "parameters": [ { "name": "account_type", "in": "query", "description": "The type of account to query. Supported values: `cash`, `yield`, `credit`.", "required": false, "schema": { "type": "string", "default": "cash" } }, { "name": "currency", "in": "query", "description": "The transaction currency in 3-letter ISO-4217 format.", "required": false, "schema": { "type": "string" } }, { "name": "from_post_at", "in": "query", "description": "The start date (inclusive) of the date range during which balance activity occurred in your Wallet. Specify the date in ISO8601 format. If not specified, `from_post_at` defaults to 7 days before `to_post_at`.", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.\nTo retrieve the next page of results, pass the value of `page_after` (if not null) from the response to a subsequent call.\nTo retrieve the previous page of results, pass the value of `page_before` (if not null) from the response to a subsequent call.\nPassing `page=0` will override the 7 day default for null date ranges, enabling a complete search of the Wallet balance records.", "required": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "The page number of the page to be retrieved. Page numbers range from 0 to a maximum value of 10000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "A limit on the number of records to be returned on a page, between 10 and 2000. The default is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "request_id", "in": "query", "description": "request_id from clients for the transaction.", "required": false, "schema": { "type": "string" } }, { "name": "to_post_at", "in": "query", "description": "The end date (exclusive) of the date range during which the balance activity occurred in your Wallet. Specify the date in ISO8601 format. Defaults to today if neither this field nor from_post_at are specified. If from_post_at is specified, then to_post_at defaults to 7 days after the from_post_at date.", "required": false, "schema": { "type": "string" } }, { "name": "x-on-behalf-of", "in": "header", "description": "Unique identifier of the connected sub account.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results in forward direction." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/CoreBankingBalanceHistory" } }, "page_after": { "type": "string", "description": "A bookmark for use in pagination to retrieve the next page of results. Provide this identifier in the `page` request parameter in a subsequent call to retrieve the next page of results. The value will be null for the last page." }, "page_before": { "type": "string", "description": "A bookmark for use in pagination to retrieve the previous page of results. Provide this identifier in the `page` request parameter in a subsequent call to retrieve the previous page of results. The value will be null for the first page." } } }, "examples": { "default": { "value": { "has_more": true, "items": [ { "account_type": "cash", "amount": 50, "balance": 1050, "currency": "AUD", "description": "Pay AUD 50.00.", "fee": 25, "id": "0197f322-6667-7d76-b848-bfccedb2a97e", "posted_at": "2017-04-01T03:52:34+0000", "source": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "source_type": "CONVERSION", "transaction_type": "CONVERSION_BUY" } ], "page_after": "Nzc5OTlmN2MtZjVhYi0zMWI2LTlmMGMtYzA1NWRkNzY5Mzk0OkFGVEVS", "page_before": "NzY5NmZjMmYtOWExMS0zN2Y0LWJkMWUtYWM1YzdjODQ5ZDg1OkJFRk9SRQ==" } } } } } }, "400": { "description": "[\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/balances/history", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": true, "items": [ { "account_type": "cash", "amount": 50, "balance": 1050, "currency": "AUD", "description": "Pay AUD 50.00.", "fee": 25, "id": "0197f322-6667-7d76-b848-bfccedb2a97e", "posted_at": "2017-04-01T03:52:34+0000", "source": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "source_type": "CONVERSION", "transaction_type": "CONVERSION_BUY" } ], "page_after": "Nzc5OTlmN2MtZjVhYi0zMWI2LTlmMGMtYzA1NWRkNzY5Mzk0OkFGVEVS", "page_before": "NzY5NmZjMmYtOWExMS0zN2Y0LWJkMWUtYWM1YzdjODQ5ZDg1OkJFRk9SRQ==" } } ], "x-scope": [ { "scope": "balance:read", "group": "Core Resources", "resource_name": "Balances", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/deposits/create": { "post": { "tags": [ "Core Resources > Deposits" ], "summary": "1|Create a Deposit Via Direct Debit", "description": "Deposits funds into your Airwallex account via Direct Debit from a [Linked Account](/docs/api/core_resources/linked_accounts).", "operationId": "createDeposit", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "funding_source_id", "request_id" ], "properties": { "amount": { "type": "number", "description": "The amount of this deposit." }, "currency": { "type": "string", "description": "The `currency` (3-letter ISO-4217 code) of this deposit." }, "deposit_type": { "type": "string", "description": "The type of deposit you would like to create. If not specified, it will default to DIRECT_DEBIT.", "enum": [ "DIRECT_DEBIT", "FASTER_DIRECT_DEBIT" ] }, "funding_source_id": { "type": "string", "description": "The unique identifier of your Linked Account or Funding Source." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the bank account owner on the bank statement. 1-10 characters long for USD, 1-18 characters long for AUD." }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request. Should be valid UUID." } } }, "examples": { "default": { "value": { "amount": 12794.27, "currency": "USD", "deposit_type": "DIRECT_DEBIT", "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "reference": "test ref", "request_id": "c559d7fe-d911-4f3d-a937-7c24ba4b732a" } } } } }, "description": "Required information to initiate a deposit.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositDtoV2" }, "examples": { "default": { "value": { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/deposits/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "amount": 12794.27, "currency": "USD", "deposit_type": "DIRECT_DEBIT", "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "reference": "test ref", "request_id": "c559d7fe-d911-4f3d-a937-7c24ba4b732a" }, "response_body": { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } } ], "x-scope": [ { "scope": "deposit:write", "group": "Core Resources", "resource_name": "Deposits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/deposits": { "get": { "tags": [ "Core Resources > Deposits" ], "summary": "3|List all Deposits", "description": "Returns a list of deposits made into your Airwallex wallet. You can filter the list by specifying a time period. If left unspecified or only the end date is specified, then deposits 30 days in arrears of today or the end date will be returned.", "operationId": "listDeposits", "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/DepositDtoV2" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } ] } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/deposits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } ] } } ], "x-scope": [ { "scope": "deposit:read", "group": "Core Resources", "resource_name": "Deposits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/deposits/{id}": { "get": { "tags": [ "Core Resources > Deposits" ], "summary": "2|Retrieve a Deposit", "description": "Retrieves details of a deposit using the given deposit unique identifier.", "operationId": "retrieveDeposit", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Deposit to retrieve.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "deposit_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositDtoV2" }, "examples": { "default": { "value": { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/deposits/deposit_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 12794.27, "created_at": "2017-03-20T14:00:01+1100", "currency": "USD", "estimated_settled_at": "2017-03-22T14:00:00+0000", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "fee": { "amount": 1.28, "currency": "USD" }, "funding_source_id": "67f687fe-dcf4-4462-92fa-20335321d9d8", "global_account_id": "fcfc369c-ce9d-4ab7-b9af-80df61848f8f", "id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "payer": { "bank_account": { "au_bsb": { "account_number": "89098199202", "bsb": "063001" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "account_number": "89098199202", "bsb": "063001", "payid": "tester@airwallex.com" }, "br_bank_code": { "account_number": "89098199202", "bank_code": "712", "branch_code": "0001", "ispb": "78632767" }, "ca_institution_number": { "account_number": "89098199202", "institution_number": "010", "transit_number": "12345" }, "cn_cnaps_code": { "account_number": "89098199202", "cnaps_code": "1234" }, "dk_bank_code": { "account_number": "89098199202", "bank_code": "003" }, "gb_sort_code": { "account_number": "89098199202", "sort_code": "608382" }, "hk_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "iban": { "iban": "GB81LHVB04032900176471" }, "institution": { "country_code": "US", "name": "tester bank", "swift_code": "DBSSSGSG" }, "jp_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "1234" }, "kr_bank_code": { "account_number": "89098199202", "bank_code": "003", "branch_code": "003123" }, "mx_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_office_code": "1234", "control_digit": "1" }, "name": "tester", "nz_bank_code": { "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "suffix": "12" }, "partial": { "account_number": "89098199202", "account_routing_type1": "sort_code", "account_routing_type2": "sort_code", "account_routing_value1": "040329", "account_routing_value2": "040329" }, "ph_bank_code": { "account_number": "7052902318500429", "bank_code": "011070016" }, "swift_code": { "account_number": "89098199202", "swift_code": "DBSSSGSG" }, "type": "AU_BSB", "us_ach": { "account_number": "89098199202", "ach": "084106768" }, "us_wire": { "account_number": "89098199202", "wire": "084106768" } }, "country_code": "US", "digital_wallet": { "account_name": "John Walker Corporation", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "name": "tester" }, "provider_transaction_id": "5487287788", "reference": "5487287788", "settled_at": "2017-03-22T14:00:00+0000", "status": "SETTLED", "type": "BANK_TRANSFER" } } ], "x-scope": [ { "scope": "deposit:read", "group": "Core Resources", "resource_name": "Deposits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/direct_debits/{transaction_id}/cancel": { "post": { "tags": [ "Core Resources > Direct Debits" ], "summary": "3|Cancel a Direct Debit", "description": "Cancel a direct debit by transaction id.", "operationId": "directDebits_cancel", "parameters": [ { "name": "transaction_id", "in": "path", "description": "The unique identifier for direct debit transaction.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2" }, "examples": { "default": { "value": "transaction_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "307": { "description": "Temporary Redirect" }, "400": { "description": "[\"resource_not_found\", \"invalid_operation\", \"invalid_state_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\", \"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/direct_debits/transaction_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "direct_debit:write", "group": "Core Resources", "resource_name": "Direct Debits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/direct_debits": { "get": { "tags": [ "Core Resources > Direct Debits" ], "summary": "2|List all Direct Debits", "description": "Get list of direct debits by specifying the start and end date/time of creation. If neither from_created_date nor to_created_date are provided, direct debits within 30 days of today will be returned. If only to_created_date is provided, direct debits within 30 days of to_created_date will be returned.", "operationId": "listDirectDebits", "parameters": [ { "name": "from_created_date", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string", "default": "2021-05-01" } }, { "name": "to_created_date", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string", "default": "2021-05-31" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, defaultValue 100.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "has_more", "items" ], "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/DirectDebit" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": 12794.27, "currency": "USD", "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2", "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c", "status": "SETTLED", "debtor_name": "ABC", "statement_ref": "5487287788", "mandate_id": "11987bad-bb6d-4e30-ba49-d19826c3e803" } ] } } } } } }, "307": { "description": "Temporary Redirect" }, "400": { "description": "[\"field_required\", \"bad_request\", \"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\", \"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/direct_debits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": 12794.27, "currency": "USD", "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2", "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c", "status": "SETTLED", "debtor_name": "ABC", "statement_ref": "5487287788", "mandate_id": "11987bad-bb6d-4e30-ba49-d19826c3e803" } ] } } ], "x-scope": [ { "scope": "direct_debit:read", "group": "Core Resources", "resource_name": "Direct Debits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/direct_debits/{transaction_id}": { "get": { "tags": [ "Core Resources > Direct Debits" ], "summary": "1|Retrieve a Direct Debit", "description": "Get direct debit by transaction id.", "operationId": "retrieveDirectDebit", "parameters": [ { "name": "transaction_id", "in": "path", "description": "Unique Identifier for direct debit transaction.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2" }, "examples": { "default": { "value": "transaction_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectDebit" }, "examples": { "default": { "value": { "amount": 12794.27, "created_at": "", "currency": "USD", "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2", "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c", "status": "SETTLED", "debtor_name": "ABC", "statement_ref": "5487287788", "mandate_id": "11987bad-bb6d-4e30-ba49-d19826c3e803" } } } } } }, "307": { "description": "Temporary Redirect" }, "400": { "description": "[\"field_required\", \"bad_request\", \"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\", \"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/direct_debits/transaction_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 12794.27, "created_at": "", "currency": "USD", "transaction_id": "da46a141-85d3-4ed7-8155-5ab8f7cc34f2", "global_account_id": "e412ea03-b6fa-4198-90ef-aaee64c4139c", "status": "SETTLED", "debtor_name": "ABC", "statement_ref": "5487287788", "mandate_id": "11987bad-bb6d-4e30-ba49-d19826c3e803" } } ], "x-scope": [ { "scope": "direct_debit:read", "group": "Core Resources", "resource_name": "Direct Debits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "9|List all Aliases", "description": "Retrieves a list of aliases registered to a given Global Account.", "operationId": "listAliases", "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO 8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "1970-01-01T00:00:00+00:00" } }, { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, maximum value is 2000.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "Status of the alias.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO 8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2099-12-31T23:59:59+00:00" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedGlobalAccountAliasClient" }, "examples": { "default": { "value": { "items": [ { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id/aliases", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/{id}/cancel": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "13|Cancel an Alias for a Global Account", "description": "Cancels an alias for a Global Account. Once cancelled, the alias can no longer be used for any transactions, such as receiving funds.", "operationId": "aliasesCancel", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the Alias.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "alias_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/aliases/alias_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{id}/close": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "6|Close a Global Account", "description": "Close a global account created under your Airwallex account.", "operationId": "close", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the global account to close.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "global_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountClient" }, "examples": { "default": { "value": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/close", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/create": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "1|Create a Global Account", "description": "Submit a request to create a new global account in your chosen currency. This global account can be used for the purpose of receiving funds from your payers via the local clearing system or swift system.", "operationId": "createGlobalAccount", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "country_code", "request_id", "required_features" ], "properties": { "alternate_account_identifiers": { "type": "object", "description": "For a specific local clearing system, this serves as the unique alternate identifier for a global account.", "properties": { "email": { "type": "string", "description": "Applicable only for CA Global Accounts. [Supported Formats](/docs/global-treasury/get-started/global-accounts/manage-global-accounts#supported-email-format-under-alternate_account_identifiers)." } } }, "country_code": { "type": "string", "description": "Country of the global account (2-letter ISO 3166-2 country code)." }, "deposit_conversion_currency": { "type": "string", "description": "Target currency that incoming funds will be converted to. Applicable only when Global Account country is ID. [Supported currencies](/docs/transactional-fx/supported-regions-and-currencies) (3-letter ISO-4217 code)." }, "nick_name": { "type": "string", "description": "Nickname of the global account. Default: current account's business name." }, "request_id": { "type": "string", "description": "Unique request identifier." }, "required_features": { "type": "array", "description": "Required features of the global account.", "items": { "type": "object", "required": [ "currency" ], "properties": { "currency": { "type": "string", "description": "Currency of the global account (3-letter ISO-4217 code)." }, "transfer_method": { "type": "string", "description": "Transfer method in which a deposit can be received for the specified currency. Possible transfer methods are: `LOCAL`, `SWIFT`. Not applicable for stablecoin global accounts — field is absent from JSON for stablecoin entries." } } } } } }, "examples": { "default": { "value": { "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "country_code": "GP", "deposit_conversion_currency": "USD", "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ] } } } } }, "description": "Required information to create a global account.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveGlobalAccount" }, "examples": { "default": { "value": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "country_code": "GP", "deposit_conversion_currency": "USD", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "ACTIVE", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "country_code": "GP", "deposit_conversion_currency": "USD", "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ] }, "response_body": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "country_code": "GP", "deposit_conversion_currency": "USD", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "ACTIVE", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/create": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "7|Create an Alias for a Global Account", "description": "Creates an alias for a Global Account to receive funds. Supported alias types include: `EMAIL`, `PHONE_NUMBER`, and `AUSTRALIAN_BUSINESS_NUMBER`. For alias types `EMAIL` or `PHONE_NUMBER`, a verification code will be sent via email or SMS respectively. You must submit this code for verification using the [Submit Alias verification code](/docs/api/core_resources/global_accounts/submit_verification_code_aliases) endpoint to complete the alias creation process.", "operationId": "aliasesCreate", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "local_clearing_system", "request_id", "type", "value" ], "properties": { "local_clearing_system": { "type": "string", "description": "Local clearing system to be registered with." }, "request_id": { "type": "string", "description": "Unique request ID." }, "type": { "type": "string", "description": "Alias type." }, "value": { "type": "string", "description": "Alias value." } } }, "examples": { "default": { "value": { "local_clearing_system": "NPP", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "type": "EMAIL", "value": "john.doe@example.com" } } } } }, "description": "Required information to create a global account alias.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"already_exists\",\"duplicate_request_id\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/aliases/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "local_clearing_system": "NPP", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "type": "EMAIL", "value": "john.doe@example.com" }, "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{id}/generate_statement_letter": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "5|Generate Global Account Statement", "description": "Generate global account statement letter, return as file stream.", "operationId": "generateStatementLetter", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the global account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "global_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_statement_type" ], "properties": { "account_statement_type": { "type": "string", "description": "Type of account statement. One of `AMAZON`, `EBAY`, `COUPANG`, `GENERAL`." }, "registration_info": { "type": "object", "description": "If account statement type is one of `AMAZON`, `EBAY`, `COUPANG`, the registration info field is required.", "properties": { "agreement": { "type": "boolean", "description": "I confirm that the details are correct and match the details I provided to and appear on the platform. I agree and acknowledge that Airwallex will be relying on this information and my confirmation in the future, including for issuing account statements for platform. \n \nThis flag must be `true`." }, "registered_address": { "type": "object", "description": "Registered address info.", "properties": { "address": { "type": "string", "description": "Address line." }, "city": { "type": "string", "description": "City/Town." }, "country": { "type": "string", "description": "Country." }, "postcode": { "type": "string", "description": "Postcode." }, "state": { "type": "string", "description": "State/Province." } } }, "registered_email": { "type": "string", "description": "Registered email." }, "registered_name": { "type": "string", "description": "Registered owner/company name." } } } } }, "examples": { "default": { "value": { "account_statement_type": "AMAZON", "registration_info": { "agreement": true, "registered_address": { "address": "15 William Street", "city": "Melbourne", "country": "Australia", "postcode": "3000", "state": "VIC" }, "registered_email": "john.walker@gmail.com", "registered_name": "John Walker" } } } } } }, "description": "globalAccountStatementLetterDto", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" }, "examples": { "default": { "value": "" } } }, "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/generate_statement_letter", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "account_statement_type": "AMAZON", "registration_info": { "agreement": true, "registered_address": { "address": "15 William Street", "city": "Melbourne", "country": "Australia", "postcode": "3000", "state": "VIC" }, "registered_email": "john.walker@gmail.com", "registered_name": "John Walker" } }, "response_body": "" } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/{id}/initiate_port": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "10|Initiate an Alias Port for a Global Account", "description": "Initiates an alias port to transfer the alias details to a different Airwallex Global Account or to another external bank account. After you submit the request, the alias status changes to PORT_INITIATED and then requires further action to complete the port once the alias becomes portable. To complete the port, register the alias details to another Airwallex Global Account using [Create an Alias for a Global Account](/docs/api/core_resources/global_accounts/create_aliases) or with another external bank account provider.", "operationId": "aliasesInitiatePort", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the Alias.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "alias_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/aliases/alias_id/initiate_port", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "3|List all Global Accounts", "description": "Get list of global accounts created by your Airwallex account.", "operationId": "listGlobalAccount", "parameters": [ { "name": "country_code", "in": "query", "description": "Country of the global account (2-letter ISO 3166-2 country code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "US" } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "nick_name", "in": "query", "description": "Nickname of the global account.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "Tom" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "required_features.currency", "in": "query", "description": "Currency that was specified during Global Account creation.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } }, { "name": "status", "in": "query", "description": "Status of the account.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "ACTIVE" } }, { "name": "supported_features.currency", "in": "query", "description": "Currency that is supported by the Global Account.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedGlobalAccount" }, "examples": { "default": { "value": { "items": [ { "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/mandates": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "15|List all Direct Debit Payout Mandates", "description": "Get a list of Direct Debit Payout Mandates by an Airwallex global account id.", "operationId": "listMandates", "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "1970-01-01" } }, { "name": "global_account_id", "in": "path", "description": "The unique identifier of the Global Account with the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "page_num", "in": "query", "description": "Page number starts from 0, default value is 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default value is 50.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "status", "in": "query", "description": "Status of the mandate, possible value should be `ACTIVE`, `CANCELLED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/DirectDebitOutMandate" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "created_at": "2022-09-19T08:40:48Z", "creditor_name": "creditor", "currency": "GBP", "debtor_name": "debtor", "global_account_id": "035253e2-1b14-43d0-b98f-a62fd91bb985", "id": "11987bad-bb6d-4e30-ba49-d19826c3e803", "payment_scheme": "Bacs", "setup_time": "2022-09-19T00:00:00Z", "status": "ACTIVE" } ] } } } } } }, "400": { "description": "[\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id/mandates", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "created_at": "2022-09-19T08:40:48Z", "creditor_name": "creditor", "currency": "GBP", "debtor_name": "debtor", "global_account_id": "035253e2-1b14-43d0-b98f-a62fd91bb985", "id": "11987bad-bb6d-4e30-ba49-d19826c3e803", "payment_scheme": "Bacs", "setup_time": "2022-09-19T00:00:00Z", "status": "ACTIVE" } ] } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{id}/transactions": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "17|List all Global Account Transactions", "description": "Obtain transaction details of funds received into your specified global account.", "operationId": "globalAccount_listTransactions", "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "id", "in": "path", "description": "Unique identifier of the global account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/GlobalAccountTransaction" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": 10000, "create_time": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee_amount": 10, "fee_currency": "AUD", "id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "payer_country": "US", "payer_name": "AMZNnt70paD1", "status": "PENDING", "type": "CREDIT" } ] } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id/transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": 10000, "create_time": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee_amount": 10, "fee_currency": "AUD", "id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "payer_country": "US", "payer_name": "AMZNnt70paD1", "status": "PENDING", "type": "CREDIT" } ] } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/mandates/{id}/cancel": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "16|Cancel a Direct Debit Payout Mandate", "description": "Cancel a Direct Debit Payout Mandate by an Airwallex global account id and mandate id.", "operationId": "mandatesCancel", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique identifier of the Global Account with the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique identifier of the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"resource_not_found\", \"invalid_state_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/mandates/global_account_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/{id}/request_new_verification_code": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "12|Request New Alias Verification Code", "description": "Requests new verification code for an alias to complete the alias creation process.", "operationId": "aliasesRequestNewVerificationCode", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the Alias.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "alias_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/aliases/alias_id/request_new_verification_code", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{id}": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "2|Retrieve a Global Account", "description": "Get global account by an Airwallex global account id.", "operationId": "retrieveGlobalAccount", "parameters": [ { "name": "id", "in": "path", "description": "Query the Airwallex's global account using the global account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountClient" }, "examples": { "default": { "value": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/{id}": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "8|Retrieve an Alias", "description": "Retrieves details of an alias using the given alias ID.", "operationId": "retrieveAliases", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the Alias.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "alias_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id/aliases/alias_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/mandates/{id}": { "get": { "tags": [ "Core Resources > Global Accounts" ], "summary": "14|Retrieve a Direct Debit Payout Mandate", "description": "Get a Direct Debit Payout Mandate by an Airwallex global account id and mandate id.", "operationId": "globalAccount_retrieveMandate", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique identifier of the Global Account with the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique identifier of the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectDebitOutMandate" }, "examples": { "default": { "value": { "created_at": "2022-09-19T08:40:48Z", "creditor_name": "creditor", "currency": "GBP", "debtor_name": "debtor", "global_account_id": "035253e2-1b14-43d0-b98f-a62fd91bb985", "id": "11987bad-bb6d-4e30-ba49-d19826c3e803", "payment_scheme": "Bacs", "setup_time": "2022-09-19T00:00:00Z", "status": "ACTIVE" } } } } } }, "400": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/global_accounts/global_account_id/mandates/global_account_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "created_at": "2022-09-19T08:40:48Z", "creditor_name": "creditor", "currency": "GBP", "debtor_name": "debtor", "global_account_id": "035253e2-1b14-43d0-b98f-a62fd91bb985", "id": "11987bad-bb6d-4e30-ba49-d19826c3e803", "payment_scheme": "Bacs", "setup_time": "2022-09-19T00:00:00Z", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "global_account:read", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{global_account_id}/aliases/{id}/submit_verification_code": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "11|Submit Alias Verification Code", "description": "Submits the verification code (received via email or SMS) to complete the alias creation process. If the code has expired or the verification attempt limit is reached, request a new verification code using the [Request new Alias verification code](/docs/api/core_resources/global_accounts/request_new_verification_code_aliases) endpoint.", "operationId": "aliasesSubmitVerificationCode", "parameters": [ { "name": "global_account_id", "in": "path", "description": "The unique ID of the Global Account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "global_account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the Alias.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "alias_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "The verification code sent by Airwallex to complete the alias creation." } } }, "examples": { "default": { "value": { "code": "123456" } } } } }, "description": "The verification code sent by Airwallex to confirm the alias creation.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountAliasClient" }, "examples": { "default": { "value": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"invalid_verification_code\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/aliases/alias_id/submit_verification_code", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "code": "123456" }, "response_body": { "global_account_id": "global_account_id", "id": "alias_id", "local_clearing_system": "NPP", "next_action": { "expires_at": "2026-01-31T06:57:10+0000", "remaining_attempts": 3, "type": "submit_verification_code" }, "reason": "", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "status": "ACTIVE", "type": "EMAIL", "value": "john.doe@example.com" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/global_accounts/{id}/update": { "post": { "tags": [ "Core Resources > Global Accounts" ], "summary": "4|Update an Existing Global Account", "description": "Edit an existing global account nick_name, deposit_conversion_currency or alternate_account_identifiers stored on the Airwallex platform.", "operationId": "updateGlobalAccount", "parameters": [ { "name": "id", "in": "path", "description": "Id of the global account to update.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "global_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "nick_name" ], "properties": { "alternate_account_identifiers": { "type": "object", "description": "For a specific local clearing system, this serves as the unique alternate identifier for a global account.\nFor CAD Global Accounts: Re-submitting the same email address (alternate_account_identifiers.value from GET /api/v1/global_accounts/{id}) will resend the Autodeposit confirmation email.", "properties": { "email": { "type": "string", "description": "Applicable only for CA Global Accounts. [Supported Formats](/docs/global-treasury/get-started/global-accounts/manage-global-accounts#supported-email-format-under-alternate_account_identifiers)." } } }, "deposit_conversion_currency": { "type": "string", "description": "Target currency that incoming funds will be converted to. Applicable only when Global Account country is ID. [Supported currencies](/docs/transactional-fx/supported-regions-and-currencies) (3-letter ISO-4217 code)." }, "nick_name": { "type": "string", "description": "Nickname of the global account." } } }, "examples": { "default": { "value": { "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "deposit_conversion_currency": "USD", "nick_name": "GBP in UK for Subsidiary Company ABC" } } } } }, "description": "globalAccountUpdateDto", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalAccountClient" }, "examples": { "default": { "value": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/global_accounts/global_account_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "deposit_conversion_currency": "USD", "nick_name": "GBP in UK for Subsidiary Company ABC" }, "response_body": { "account_name": "", "account_number": "88888888", "account_type": "Checking", "alternate_account_identifiers": { "email": "example@yourdomain.com" }, "close_reason": "Closed upon customer request.", "country_code": "GP", "deposit_conversion_currency": "USD", "failure_reason": "Your Airwallex account has been disabled. Please contact our support team.", "iban": "GB81LHVB04032900176471", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "institution": { "address": "Old Street Yard", "branch_name": "Wakatake ワカタケ", "city": "London", "name": "Saxo Payments A/S", "zip_code": "018982" }, "nick_name": "GBP in UK for Subsidiary Company ABC", "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1", "required_features": [ { "currency": "GBP", "transfer_method": "LOCAL" } ], "status": "CLOSED", "supported_features": [ { "alias_types": [], "currency": "GBP", "local_clearing_system": "ACH", "routing_codes": [ { "type": "sort_code", "value": "040329" } ], "transfer_method": "LOCAL", "type": "DEPOSIT" } ], "swift_code": "SXPYDEHH" } } ], "x-scope": [ { "scope": "global_account:write", "group": "Core Resources", "resource_name": "Global Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/auth": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "4|Generate a Linked Account Authentication", "description": "Generates a Linked Account authentication. You will retrieve an authentication token with the specified Open Banking provider to verify the ownership of the external bank account, so that the external bank account owner may verify their access to the account.", "operationId": "auth", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "egiro": { "type": "object", "required": [ "entity_type", "redirect_url", "reference", "swift_code" ], "description": "Required information to generate a EGIRO authentication.", "properties": { "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "redirect_url": { "type": "string", "description": "URL to receive authentication result and display the status." }, "reference": { "type": "string", "description": "Customer reference displayed in bank authorization item, with up to 25 characters." }, "swift_code": { "type": "string", "description": "SWIFT code." } } }, "plaid": { "type": "object", "required": [ "client_name", "country_code" ], "description": "Required information to generate a Plaid authentication.", "properties": { "client_name": { "type": "string", "description": "The name of your business to be displayed in Plaid Modal. The maximum length of 30 characters. If a value longer than 30 characters is provided, Plaid Modal will display `This Application` instead." }, "country_code": { "type": "string", "description": "Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code." }, "language": { "type": "string", "description": "The language that Plaid Modal should be displayed in. Two-letter [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code. Default is `en`." }, "link_customization_name": { "type": "string", "description": "The name of the Link customization configured on the Plaid Dashboard. If not specified, the `default` customization will be applied." }, "redirect_url": { "type": "string", "description": "URL to handle the Oauth verification flow." } } }, "truelayer": { "type": "object", "required": [ "country_code", "provider_id", "redirect_url" ], "description": "Required information to generate a Truelayer authentication.", "properties": { "country_code": { "type": "string", "description": "Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code." }, "provider_id": { "type": "string", "description": "Unique identifier of the financial institution as provided by Truelayer [here](https://auth.truelayer.com/api/providers)." }, "redirect_url": { "type": "string", "description": "URL to handle the Oauth verification flow." } } }, "type": { "type": "string", "description": "Specify a verification type for your external bank account.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } } }, "examples": { "default": { "value": { "egiro": { "entity_type": "BUSINESS", "redirect_url": "https://www.airwallex.com", "reference": "https://www.airwallex.com", "swift_code": "DBSSSGSG" }, "plaid": { "client_name": "Airwallex", "country_code": "US", "language": "en", "link_customization_name": "customized", "redirect_url": "https://www.airwallex.com" }, "truelayer": { "country_code": "GB", "provider_id": "ob-monzo", "redirect_url": "https://www.airwallex.com" }, "type": "PLAID" } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountAuth" }, "examples": { "default": { "value": { "egiro": { "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule" }, "plaid": { "expires_at": "2022-06-29T11:25:39+0000", "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89" }, "truelayer": { "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access" }, "type": "PLAID" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/auth", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "egiro": { "entity_type": "BUSINESS", "redirect_url": "https://www.airwallex.com", "reference": "https://www.airwallex.com", "swift_code": "DBSSSGSG" }, "plaid": { "client_name": "Airwallex", "country_code": "US", "language": "en", "link_customization_name": "customized", "redirect_url": "https://www.airwallex.com" }, "truelayer": { "country_code": "GB", "provider_id": "ob-monzo", "redirect_url": "https://www.airwallex.com" }, "type": "PLAID" }, "response_body": { "egiro": { "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule" }, "plaid": { "expires_at": "2022-06-29T11:25:39+0000", "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89" }, "truelayer": { "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access" }, "type": "PLAID" } } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/complete_auth": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "10|Complete the Authentication Refresh", "description": "Completes the authentication refresh. After the refresh authentication process is confirmed, the corresponding Linked Account status will become `SUCCEEDED`.", "operationId": "completeAuth", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to complete the auth refresh.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "auth_id": { "type": "string", "description": "The path parameter `auth_id` retrieved from EGIRO's callback url (redirect_url_host?**auth_id=value1**&auth_reference=value2)." }, "auth_reference": { "type": "string", "description": "The path parameter `auth_reference` retrieved from EGIRO's callback url (redirect_url_host?auth_id=value1&**auth_reference=value2**)." }, "code": { "type": "string", "description": "The path parameter `code` retrieved from TrueLayer's callback url (redirect_url_host?**code=code_value**&state=state_value)." }, "state": { "type": "integer", "format": "int64", "description": "The path parameter `state` retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&**state=state_value**)." }, "type": { "type": "string", "description": "The verification type that was used for your Linked Account.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } } }, "examples": { "default": { "value": { "auth_id": "7829116420292722", "auth_reference": "BOAIR6561Z01AIR20240603071713069163", "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797", "state": 6781472155828238, "type": "PLAID" } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/complete_auth", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "auth_id": "7829116420292722", "auth_reference": "BOAIR6561Z01AIR20240603071713069163", "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797", "state": 6781472155828238, "type": "PLAID" }, "response_body": false } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/confirm": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "9|Confirm a Linked Account Among Candidate Accounts", "description": "Confirm your Linked Account among a list of candidate accounts that have already been verified.", "operationId": "linkedAccounts_confirm", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to confirm the account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_identity" ], "properties": { "account_identity": { "type": "string", "description": "Account identity come from candidate_accounts." } } }, "examples": { "default": { "value": { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface" } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/confirm", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface" } } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/create": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "1|Create a Linked Account", "description": "Links an external bank account to your Airwallex account. If you would like to use Open Banking as your verification method, please first call on the `linked_accounts/auth` endpoint to generate an authentication token.", "operationId": "createLinkedAccount", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "type" ], "properties": { "account_owner_identifier": { "type": "string", "description": "Specify an owner unique identifier if verification of the external bank account had already been completed on another Airwallex product. This value should be null unless explicitly agreed upon with your Account Manager." }, "au_bank": { "type": "object", "required": [ "account_name", "account_number", "bsb", "currency", "entity_type" ], "description": "Australia bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "bsb": { "type": "string", "description": "BSB code." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } }, "au_payid": { "type": "object", "required": [ "account_identifier_type", "currency", "entity_type", "payid" ], "description": "Australia NPP PayID information.", "properties": { "account_identifier_type": { "type": "string", "description": "Identifier of PayID.", "enum": [ "EMAIL_ADDRESS", "PHONE_NUMBER", "ABN", "ACN", "ARBN", "ARSN", "ORGANISATION_IDENTIFIER" ] }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "payid": { "type": "string", "description": "Australia NPP PayID." } } }, "ca_bank": { "type": "object", "required": [ "currency", "entity_type" ], "description": "Canada bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "institution_number": { "type": "string", "description": "Institution number." }, "transit_number": { "type": "string", "description": "Branch transit number." } } }, "egiro": { "type": "object", "required": [ "auth_id", "auth_reference" ], "description": "Required information to verify a Linked Account with EGIRO authentication, which could be parsed from the EGIRO redirect url.", "properties": { "auth_id": { "type": "integer", "format": "int64", "description": "The value is returned in the redirect url." }, "auth_reference": { "type": "string", "description": "The value is returned in the redirect url." } } }, "eu_bank": { "type": "object", "required": [ "account_name", "currency", "entity_type", "iban" ], "description": "Europe bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "iban": { "type": "string", "description": "International Bank Account Number." } } }, "gb_bank": { "type": "object", "required": [ "account_name", "currency", "entity_type" ], "description": "Great Britain bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "sort_code": { "type": "string", "description": "Sort code." } } }, "hk_bank": { "type": "object", "required": [ "account_name", "account_number", "bank_code", "currency", "entity_type" ], "description": "Hong Kong bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } }, "mandate": { "type": "object", "required": [ "type" ], "description": "Details about the mandate for authorizing direct debits. Enter null if no mandate is signed.", "properties": { "controls": { "type": "object", "description": "Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.", "properties": { "amount_type": { "type": "string", "enum": [ "VARIABLE", "FIXED" ], "x-enumDescriptions": { "VARIABLE": "Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.", "FIXED": "Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required." } }, "end_date": { "type": "string", "description": "End date to expect to be paid from the Linked Account." }, "fixed_amount_per_transaction": { "type": "number", "description": "The fixed amount that may be paid from the Linked Account, per transaction." }, "max_amount_per_transaction": { "type": "number", "description": "Maximum amount that may be paid from the Linked Account, per transaction." }, "schedule": { "type": "object", "required": [ "period", "period_unit" ], "description": "The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.", "properties": { "period": { "type": "integer", "format": "int32", "description": "The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH." }, "period_unit": { "type": "string", "description": "Specifies transaction frequency.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } } } } }, "email": { "type": "string", "description": "Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate." }, "identification_document": { "type": "object", "required": [ "type", "value" ], "description": "Identification document. Required if mandate type is HK_FPS_DEBIT.", "properties": { "type": { "type": "string", "description": "Id Type.", "enum": [ "HK_ID", "PASSPORT", "BUSINESS_REGISTRATION_NUMBER", "CERTIFICATE_OF_INCORPORATION_NUMBER", "OTHERS", "NRIC", "FIN", "UEN" ] }, "value": { "type": "string", "description": "Id Value." } } }, "preferred_reference": { "type": "string", "description": "Preferred reference for mandate. We use this value to generate a unique reference (that may be different from the initial value), then register in payment system." }, "reuse_mandate_reference": { "type": "string", "description": "Reference to the existing mandate in reuse mandate scenario. This value should be null unless explicitly agreed upon with your Account Manager." }, "signatory": { "type": "string", "description": "Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate." }, "type": { "type": "string", "description": "Type of the source of your funds.", "enum": [ "AU_BECS_DEBIT", "US_ACH_DEBIT", "US_FEDWIRE_DEBIT", "GB_BACS_DEBIT", "EU_SEPA_DEBIT", "CA_EFT_DEBIT", "HK_FPS_DEBIT", "SG_EGIRO_DEBIT", "AU_PAYTO_DEBIT", "NZ_BECS_DEBIT" ] }, "version": { "type": "string", "description": "Version of the mandate signed. Required if you are not reusing mandate." } } }, "nz_bank": { "type": "object", "required": [ "account_name", "account_number", "currency", "entity_type" ], "description": "New Zealand bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } }, "plaid": { "type": "object", "required": [ "account", "institution", "public_token" ], "description": "Required information to verify a Linked Account with Plaid authentication, which could be parsed from the Plaid Modal onSuccess callback.", "properties": { "account": { "type": "object", "required": [ "id", "mask", "name" ], "description": "The bank account that was selected in the Plaid Modal.", "properties": { "id": { "type": "string", "description": "Plaid’s unique identifier for the account." }, "mask": { "type": "string", "description": "The last 2-4 alphanumeric characters of an account's official account number." }, "name": { "type": "string", "description": "The name of the account, either assigned by the user or by the financial institution itself." } } }, "institution": { "type": "object", "required": [ "id", "name" ], "description": "The financial institution that was selected in the Plaid Modal.", "properties": { "id": { "type": "string", "description": "The institution identifier assigned by Plaid." }, "name": { "type": "string", "description": "The full financial institution name." } } }, "public_token": { "type": "string", "description": "The Plaid Public Token." } } }, "preferred_verification_type": { "type": "string", "description": "Type of verification used to link your external account.", "enum": [ "MICRO_DEPOSIT", "PLATFORM_ENDORSEMENT", "PLAID", "TRUELAYER", "EGIRO", "MANDATE", "BASIQ" ] }, "request_id": { "type": "string", "description": "Unique request identifier." }, "sg_bank": { "type": "object", "required": [ "account_name", "account_number", "currency", "entity_type", "swift_code" ], "description": "Singapore bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "swift_code": { "type": "string", "description": "SWIFT code." } } }, "truelayer": { "type": "object", "required": [ "code", "state" ], "description": "Required information to verify a Linked Account with Truelayer authentication, which could be parsed from the Truelayer onSuccess callback url.", "properties": { "code": { "type": "string", "description": "The path parameter `code` retrieved from TrueLayer's callback url (redirect_url_host?**code=code_value**&state=state_value)." }, "state": { "type": "integer", "format": "int64", "description": "The path parameter `state` retrieved from TrueLayer's callback url (redirect_url_host?code=code_value&**state=state_value**)." } } }, "type": { "type": "string", "description": "Type of Linked Account.", "enum": [ "AU_BANK", "NZ_BANK", "US_BANK", "GB_BANK", "EU_BANK", "HK_BANK", "SG_BANK", "CA_BANK", "AU_PAYID" ] }, "us_bank": { "type": "object", "required": [ "currency", "entity_type" ], "description": "United States bank information.", "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "account_type": { "type": "string", "description": "External bank account type.", "enum": [ "CHECKING", "SAVINGS" ] }, "ach": { "type": "string", "description": "ACH routing number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "fedwire": { "type": "string", "description": "FEDWIRE routing number." } } } } }, "examples": { "default": { "value": { "account_owner_identifier": "test_account_owner_id_1", "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "egiro": { "auth_id": 7829116420292722, "auth_reference": "BOAIR6561Z01AIR20240603071713069163" }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401" }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "mandate": { "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "identification_document": { "type": "HK_ID", "value": "A123456" }, "preferred_reference": "AWX", "reuse_mandate_reference": "AWX013", "signatory": "Tester Smith", "type": "AU_BECS_DEBIT", "version": "1.1" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS" }, "plaid": { "account": { "id": "p4aN1gq5MwuAeVv47pkjh63l5K8gV6fJqKepE", "mask": "0000", "name": "Business Savings" }, "institution": { "id": "ins_3", "name": "Chase" }, "public_token": "public-sandbox-2a6878ca-0e6b-42cf-ba9b-490401bb5a93" }, "preferred_verification_type": "MICRO_DEPOSIT", "request_id": "test_unique_id", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "truelayer": { "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797", "state": 6781472155828238 }, "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } } } }, "description": "Required information to link an external account.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" }, "examples": { "default": { "value": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "account_owner_identifier": "test_account_owner_id_1", "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "egiro": { "auth_id": 7829116420292722, "auth_reference": "BOAIR6561Z01AIR20240603071713069163" }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401" }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "mandate": { "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "identification_document": { "type": "HK_ID", "value": "A123456" }, "preferred_reference": "AWX", "reuse_mandate_reference": "AWX013", "signatory": "Tester Smith", "type": "AU_BECS_DEBIT", "version": "1.1" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS" }, "plaid": { "account": { "id": "p4aN1gq5MwuAeVv47pkjh63l5K8gV6fJqKepE", "mask": "0000", "name": "Business Savings" }, "institution": { "id": "ins_3", "name": "Chase" }, "public_token": "public-sandbox-2a6878ca-0e6b-42cf-ba9b-490401bb5a93" }, "preferred_verification_type": "MICRO_DEPOSIT", "request_id": "test_unique_id", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "truelayer": { "code": "B2D8A5F9896AAA08E34DF3099649A1C249D562996D1416BCE76F66C372E56797", "state": 6781472155828238 }, "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } }, "response_body": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts": { "get": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "3|List all Linked Accounts", "description": "Returns a list of Linked Accounts associated with a specific Airwallex account.", "operationId": "listLinkedAccounts", "parameters": [ { "name": "country_code", "in": "query", "description": "The country where your Linked Account is located.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive). If null, response will provide Linked Accounts created in the past 31 days.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "The status of the Linked Account. One of `REQUIRES_ACTION`, `PROCESSING`, `SUCCEEDED`, `FAILED`, `SUSPENDED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive). If null, response will provide Linked Accounts created in the past 31 days.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/LinkedAccount" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } ] } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/linked_accounts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } ] } } ], "x-scope": [ { "scope": "linked_account:read", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/balances": { "get": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "7|Check Available Balances", "description": "Retrieves the balance of a Linked Account using the given Linked Account unique identifier. This API is only available to Linked Accounts where `capabilities.balance_check` is true. The request will be routed to the respective financial institutions, so you may experience a slight delay in the response.", "operationId": "listBalances", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to retrieve available balances.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/LinkedAccountBalance" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "available_amount": 100.1, "currency": "USD" } ] } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/linked_accounts/linked_account_id/balances", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "available_amount": 100.1, "currency": "USD" } ] } } ], "x-scope": [ { "scope": "linked_account:read", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/auth": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "5|Refresh a Linked Account Authentication", "description": "Refreshes a Linked Account authentication after it has expired. You can call `/complete_auth` in onSuccess callback from the Open Banking provider to inform Airwallex it has been completed. Otherwise, the Linked Account status will remain as `REQUIRES_ACTION`.", "operationId": "linkedAccounts_refresh", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to refresh authentication.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "egiro": { "type": "object", "required": [ "entity_type", "redirect_url", "reference", "swift_code" ], "description": "Required information to generate a EGIRO authentication.", "properties": { "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "redirect_url": { "type": "string", "description": "URL to receive authentication result and display the status." }, "reference": { "type": "string", "description": "Customer reference displayed in bank authorization item, with up to 25 characters." }, "swift_code": { "type": "string", "description": "SWIFT code." } } }, "plaid": { "type": "object", "required": [ "client_name", "country_code" ], "description": "Required information to generate a Plaid authentication.", "properties": { "client_name": { "type": "string", "description": "The name of your business to be displayed in Plaid Modal. The maximum length of 30 characters. If a value longer than 30 characters is provided, Plaid Modal will display `This Application` instead." }, "country_code": { "type": "string", "description": "Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code." }, "language": { "type": "string", "description": "The language that Plaid Modal should be displayed in. Two-letter [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code. Default is `en`." }, "link_customization_name": { "type": "string", "description": "The name of the Link customization configured on the Plaid Dashboard. If not specified, the `default` customization will be applied." }, "redirect_url": { "type": "string", "description": "URL to handle the Oauth verification flow." } } }, "truelayer": { "type": "object", "required": [ "country_code", "provider_id", "redirect_url" ], "description": "Required information to generate a Truelayer authentication.", "properties": { "country_code": { "type": "string", "description": "Two-letter [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code." }, "provider_id": { "type": "string", "description": "Unique identifier of the financial institution as provided by Truelayer [here](https://auth.truelayer.com/api/providers)." }, "redirect_url": { "type": "string", "description": "URL to handle the Oauth verification flow." } } }, "type": { "type": "string", "description": "Specify a verification type for your external bank account.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } } }, "examples": { "default": { "value": { "egiro": { "entity_type": "BUSINESS", "redirect_url": "https://www.airwallex.com", "reference": "https://www.airwallex.com", "swift_code": "DBSSSGSG" }, "plaid": { "client_name": "Airwallex", "country_code": "US", "language": "en", "link_customization_name": "customized", "redirect_url": "https://www.airwallex.com" }, "truelayer": { "country_code": "GB", "provider_id": "ob-monzo", "redirect_url": "https://www.airwallex.com" }, "type": "PLAID" } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountAuth" }, "examples": { "default": { "value": { "egiro": { "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule" }, "plaid": { "expires_at": "2022-06-29T11:25:39+0000", "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89" }, "truelayer": { "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access" }, "type": "PLAID" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/auth", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "egiro": { "entity_type": "BUSINESS", "redirect_url": "https://www.airwallex.com", "reference": "https://www.airwallex.com", "swift_code": "DBSSSGSG" }, "plaid": { "client_name": "Airwallex", "country_code": "US", "language": "en", "link_customization_name": "customized", "redirect_url": "https://www.airwallex.com" }, "truelayer": { "country_code": "GB", "provider_id": "ob-monzo", "redirect_url": "https://www.airwallex.com" }, "type": "PLAID" }, "response_body": { "egiro": { "auth_url": "https://edda.dbs.com/api/v1/edda/authorize/creation?parameterKey=valule" }, "plaid": { "expires_at": "2022-06-29T11:25:39+0000", "link_token": "link-sandbox-463f3464-287c-4a75-adf2-85bc07c2dd89" }, "truelayer": { "auth_url": "https://auth.truelayer-sandbox.com?client_id=sandbox-airwallex-5c4af6&redirect_uri=https://www.airwallex.com&provider_id=ob-monzo&state=6781472155828238&response_type=code&scope=info%20accounts%20balance%20offline_access" }, "type": "PLAID" } } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}": { "get": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "2|Retrieve a Linked Account", "description": "Retrieves details of a Linked Account using the given Linked Account unique identifier.", "operationId": "retrieveLinkedAccount", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to retrieve.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" }, "examples": { "default": { "value": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/linked_accounts/linked_account_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } ], "x-scope": [ { "scope": "linked_account:read", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/mandate": { "get": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "11|Retrieve a Direct Debit Deposit Mandate", "description": "Retrieves the mandate of a Linked Account using the given Linked Account unique identifier.", "operationId": "linkedAccounts_retrieveMandate", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to get mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_Resources_Mandate" }, "examples": { "default": { "value": { "accepted_at": "1648387704", "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "reference": "AWX-001", "signatory": "Tester Smith", "status": "ACTIVE", "type": "AU_BECS_DEBIT", "version": "1.1" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/linked_accounts/linked_account_id/mandate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "accepted_at": "1648387704", "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "reference": "AWX-001", "signatory": "Tester Smith", "status": "ACTIVE", "type": "AU_BECS_DEBIT", "version": "1.1" } } ], "x-scope": [ { "scope": "linked_account:read", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" }, "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "12|Update a Direct Debit Deposit Mandate", "description": "Adds a mandate to the Linked Account, if it was not provided at the time of creation, or renews an existing mandate. The external bank account owner must sign and agree to the mandate to enable Direct Debits.", "operationId": "updateMandate", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to sign the mandate.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "controls": { "type": "object", "description": "Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT.", "properties": { "amount_type": { "type": "string", "enum": [ "VARIABLE", "FIXED" ], "x-enumDescriptions": { "VARIABLE": "Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.", "FIXED": "Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required." } }, "end_date": { "type": "string", "description": "End date to expect to be paid from the Linked Account." }, "fixed_amount_per_transaction": { "type": "number", "description": "The fixed amount that may be paid from the Linked Account, per transaction." }, "max_amount_per_transaction": { "type": "number", "description": "Maximum amount that may be paid from the Linked Account, per transaction." }, "schedule": { "type": "object", "required": [ "period", "period_unit" ], "description": "The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited.", "properties": { "period": { "type": "integer", "format": "int32", "description": "The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH." }, "period_unit": { "type": "string", "description": "Specifies transaction frequency.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } } } } }, "email": { "type": "string", "description": "Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate." }, "identification_document": { "type": "object", "required": [ "type", "value" ], "description": "Identification document. Required if mandate type is HK_FPS_DEBIT.", "properties": { "type": { "type": "string", "description": "Id Type.", "enum": [ "HK_ID", "PASSPORT", "BUSINESS_REGISTRATION_NUMBER", "CERTIFICATE_OF_INCORPORATION_NUMBER", "OTHERS", "NRIC", "FIN", "UEN" ] }, "value": { "type": "string", "description": "Id Value." } } }, "preferred_reference": { "type": "string", "description": "Preferred reference for mandate. We use this value to generate a unique reference (that may be different from the initial value), then register in payment system." }, "reuse_mandate_reference": { "type": "string", "description": "Reference to the existing mandate in reuse mandate scenario. This value should be null unless explicitly agreed upon with your Account Manager." }, "signatory": { "type": "string", "description": "Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate." }, "type": { "type": "string", "description": "Type of the source of your funds.", "enum": [ "AU_BECS_DEBIT", "US_ACH_DEBIT", "US_FEDWIRE_DEBIT", "GB_BACS_DEBIT", "EU_SEPA_DEBIT", "CA_EFT_DEBIT", "HK_FPS_DEBIT", "SG_EGIRO_DEBIT", "AU_PAYTO_DEBIT", "NZ_BECS_DEBIT" ] }, "version": { "type": "string", "description": "Version of the mandate signed. Required if you are not reusing mandate." } }, "description": "Details about the mandate for authorizing direct debits. Enter null if no mandate is signed." }, "examples": { "default": { "value": { "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "identification_document": { "type": "HK_ID", "value": "A123456" }, "preferred_reference": "AWX", "reuse_mandate_reference": "AWX013", "signatory": "Tester Smith", "type": "AU_BECS_DEBIT", "version": "1.1" } } } } }, "description": "The mandate to authorize Airwallex direct debit from the Linked Account.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core_Resources_Mandate" }, "examples": { "default": { "value": { "accepted_at": "1648387704", "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "reference": "AWX-001", "signatory": "Tester Smith", "status": "ACTIVE", "type": "AU_BECS_DEBIT", "version": "1.1" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/mandate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "identification_document": { "type": "HK_ID", "value": "A123456" }, "preferred_reference": "AWX", "reuse_mandate_reference": "AWX013", "signatory": "Tester Smith", "type": "AU_BECS_DEBIT", "version": "1.1" }, "response_body": { "accepted_at": "1648387704", "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "controls": { "amount_type": "VARIABLE", "end_date": "2025-12-31", "fixed_amount_per_transaction": 1000, "max_amount_per_transaction": 1000, "schedule": { "period": 3, "period_unit": "MONTH" } }, "email": "tester@test.com", "reference": "AWX-001", "signatory": "Tester Smith", "status": "ACTIVE", "type": "AU_BECS_DEBIT", "version": "1.1" } } ], "x-scope": [ { "scope": "linked_account:read", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true }, { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/suspend": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "8|Suspend a Linked Account", "description": "Suspend the link between your external bank account and your Airwallex account. This will also revoke any mandate objects attached to your Linked Account. To reverse this action, you will have to create a new Linked Account and go through verification.", "operationId": "linkedAccounts_suspend", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to suspend.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/suspend", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/linked_accounts/{id}/verify_microdeposits": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "summary": "6|Verify Linked Account with Micro-deposits", "description": "Verifies your Linked Account using the micro-deposit amounts received in the Linked Account.", "operationId": "verifyMicrodeposits", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the Linked Account to examine microdeposit.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "linked_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amounts" ], "properties": { "amounts": { "type": "array", "description": "Amounts of the two microdeposits received in the Linked Account (order agnostic).", "items": { "type": "number" } } } }, "examples": { "default": { "value": { "amounts": [ 0.08, 0.09 ] } } } } }, "description": "The amounts of microdeposit.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccount" }, "examples": { "default": { "value": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/linked_accounts/linked_account_id/verify_microdeposits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amounts": [ 0.08, 0.09 ] }, "response_body": { "au_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bsb": "063001", "currency": "AUD", "entity_type": "BUSINESS" }, "au_payid": { "account_identifier_type": "EMAIL_ADDRESS", "currency": "AUD", "entity_type": "BUSINESS", "payid": "tester_smith@airwallex.com" }, "ca_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "institution_number": "010", "transit_number": "12345" }, "capabilities": { "balance_check": true, "direct_debit_deposit": true }, "eu_bank": { "account_name": "Tester Smith", "currency": "AUD", "entity_type": "BUSINESS", "iban": "DE372022080000903344401", "swift_code": "DBSSSGSG" }, "failure_details": { "code": "other", "iso_code": "NARR", "provider_failure_details": { "code": "NARR", "local_clearing_system": "GB_FPS", "message": "Other reason" } }, "gb_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "sort_code": "608382" }, "hk_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "003", "currency": "AUD", "entity_type": "BUSINESS" }, "id": "114907b3-a708-483e-b97a-be3742905f6f", "next_action": { "candidate_accounts": [ { "account_identity": "56c7b029e0f8ec5a2334fb0ffc2fface", "bank_country_code": "GB", "currency": "GBP", "entity_type": "BUSINESS", "financial_institution_name": "Bank of Scotland", "iban": "GB08CLRB04066800003435", "name": "Transaction account", "number": "82319424", "sort_code": "608382", "type": "TRUELAYER" } ], "micro_deposit_count": 2, "remaining_attempts": 3, "type": "verify_micro_deposits", "verification_type": "PLAID" }, "nz_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "bank_code": "03", "branch_code": "1234", "currency": "AUD", "entity_type": "BUSINESS" }, "reason": "VERIFICATION_FAILED", "sg_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "currency": "AUD", "entity_type": "BUSINESS", "swift_code": "DBSSSGSG" }, "status": "SUCCEEDED", "supported_currencies": [ "AUD" ], "type": "AU_BANK", "us_bank": { "account_name": "Tester Smith", "account_number": "89098199202", "account_type": "CHECKING", "ach": "084106768", "currency": "AUD", "entity_type": "BUSINESS", "fedwire": "084106768" } } } ], "x-scope": [ { "scope": "linked_account:write", "group": "Core Resources", "resource_name": "Linked Accounts", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/finance/financial_reports/create": { "post": { "tags": [ "Finance > Financial Reports" ], "summary": "1|Create a Financial Report", "description": "Create a balance activity, transaction reconciliation, or settlement report.", "operationId": "createFinancialReport", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "file_format", "from_date", "to_date", "type" ], "properties": { "additional_fields": { "type": "array", "description": "List of additional fields to include as extra columns in the report, identified by field code. Additional fields add business-context columns to each report row to support reconciliation, as in the web app. Supported only for `TRANSACTION_RECON_REPORT` and `BALANCE_ACTIVITY_REPORT`; available field codes depend on the report type. Any field code that is invalid for the requested report type is rejected with an `invalid_argument` error, including codes supplied for a report type that does not support additional fields. See [Additional fields in financial reports](/docs/banking-as-a-service/reporting/financial-reports/additional-fields-in-financial-reports) for the list of supported field codes.", "items": { "type": "string" } }, "currencies": { "type": "array", "description": "Currencies to be included in the report. Required for `ACCOUNT_STATEMENT_REPORT` and supported as an optional filter for `BALANCE_ACTIVITY_REPORT` and `SETTLEMENT_REPORT`. Other report types do not support this filter.", "items": { "type": "string" } }, "file_format": { "type": "string", "description": "File format of financial report to create.", "enum": [ "CSV", "EXCEL", "PDF" ], "x-enumDescriptions": { "CSV": "Supported formats for Balance Activity Reports, Settlement and Transaction Reconciliation Reports", "EXCEL": "Supported formats for Balance Activity Reports, Settlement and Transaction Reconciliation Reports, Online Payment Transaction Reports", "PDF": "Supported formats for Balance Activity Reports, Account Statement Reports" } }, "file_name": { "type": "string", "description": "File name of the report. If left empty, a file name will be automatic generated following `{REPORT_TYPE}_{DATE}`." }, "from_date": { "type": "string", "description": "Start date of the report (inclusive)." }, "report_options": { "type": "object", "description": "Additional options for configuring report generation behavior.", "properties": { "include_reservations": { "type": "boolean", "description": "Whether to include reservation transactions in the report. Defaults to true if not specified. This parameter is only applicable to `BALANCE_ACTIVITY_REPORT` for versions v1.2 and onwards." } } }, "report_version": { "type": "string", "description": "Version of the report (Not applicable to `SETTLEMENT_REPORT`). If left empty, defaults to 1.1.0 for the `BALANCE_ACTIVITY_REPORT` and `TRANSACTION_RECON_REPORT`, and to 1.0.0 for other report types. See the [Financial Report Product Docs](/docs/global-treasury/reporting/financial-reports) for details on available report versions and the contents of each version." }, "settlement_currencies": { "type": "array", "description": "Settlement currencies to be included in the report. The report will include all settlement currencies if left empty. This filter is only supported by `TRANSACTION_RECON_REPORT`.", "items": { "type": "string" } }, "statuses": { "type": "array", "description": "Transaction statuses to be included in the report. The report will include all statuses if left empty. This filter is only supported by `TRANSACTION_RECON_REPORT`.", "items": { "type": "string" } }, "time_zone": { "type": "string", "description": "Timezone of the user requesting the report (Not applicable to `SETTLEMENT_REPORT`)." }, "to_date": { "type": "string", "description": "End date of the report (inclusive)." }, "transaction_currencies": { "type": "array", "description": "Transaction currencies to be included in the report. The report will include all transaction currencies if left empty. This filter is only supported by `TRANSACTION_RECON_REPORT`.", "items": { "type": "string" } }, "transaction_types": { "type": "array", "description": "Transaction types to be included in the report. Will include all transaction types if left empty. Supported Balance Activity Transaction Types: `ADJUSTMENT`, `CARD`, `CHARGE`, `CONVERSION`, `DEPOSIT`, `DIRECT_DEBIT`, `FEE`, `PAYIN`, `PAYOUT`, `TRANSFER`, `YIELD`. Supported Transaction Reconciliation Report Transaction Types: `ADJUSTMENT`, `CARD`, `CONVERSION`, `DEPOSIT`, `FEE`, `PAYMENT`, `PAYOUT`. Please leave blank when `type` is `ONLINE_PAYMENTS_TRANSACTION_REPORT` or `SETTLEMENT_REPORT`.", "items": { "type": "string" } }, "type": { "type": "string", "description": "Type of financial report to create.", "enum": [ "ACCOUNT_STATEMENT_REPORT", "BALANCE_ACTIVITY_REPORT", "ONLINE_PAYMENTS_TRANSACTION_REPORT", "SETTLEMENT_REPORT", "TRANSACTION_RECON_REPORT" ] } } }, "examples": { "default": { "value": { "additional_fields": [ "issuing_card_nickname", "lending_credit_type" ], "currencies": [ "AUD", "USD", "EUR" ], "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2026_02_23.csv", "from_date": "2026-02-22", "to_date": "2026-02-25", "report_options": { "include_reservations": true }, "report_version": "1.2.0", "time_zone": "UTC", "transaction_types": [ "CONVERSION" ], "type": "BALANCE_ACTIVITY_REPORT" } }, "transaction_recon_report_with_additional_fields": { "value": { "additional_fields": [ "issuing_card_nickname", "funding_type" ], "file_format": "EXCEL", "file_name": "TRANSACTION_RECON_REPORT_2026_02_23.xlsx", "from_date": "2026-02-22", "to_date": "2026-02-23", "report_version": "1.1.0", "settlement_currencies": [ "AUD", "USD", "EUR" ], "statuses": [ "SETTLED" ], "time_zone": "UTC", "transaction_currencies": [ "AUD", "USD", "EUR" ], "type": "TRANSACTION_RECON_REPORT" } } } } }, "description": "Request body.", "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreBankingFinancialReportRes" }, "examples": { "default": { "value": { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2026_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2026-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2026-02-22", "time_zone": "UTC", "to_date": "2026-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.2.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } }, "transaction_recon_report_with_additional_fields": { "value": { "file_format": "EXCEL", "file_name": "TRANSACTION_RECON_REPORT_2026_02_23.xlsx", "id": "8b2e4f1a-3c7d-4e9a-9f21-0a1b2c3d4e5f", "report_expires_at": "2026-03-23T23:59:59+1100", "report_parameters": { "from_date": "2026-02-22", "time_zone": "UTC", "to_date": "2026-02-23" }, "report_version": "1.1.0", "status": "COMPLETED", "type": "TRANSACTION_RECON_REPORT" } } } } } }, "400": { "description": "`invalid_argument`. For any report type, this is returned if invalid arguments are provided. When type: `SETTLEMENT_REPORT`, this can be returned if the request ask for a report that is too large to be generated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "Balance activity report", "method": "POST", "uri": "/api/v1/finance/financial_reports/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "additional_fields": [ "issuing_card_nickname", "lending_credit_type" ], "currencies": [ "AUD", "USD", "EUR" ], "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2026_02_23.csv", "from_date": "2026-02-22", "to_date": "2026-02-25", "report_options": { "include_reservations": true }, "report_version": "1.2.0", "time_zone": "UTC", "transaction_types": [ "CONVERSION" ], "type": "BALANCE_ACTIVITY_REPORT" }, "response_body": { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2026_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2026-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2026-02-22", "time_zone": "UTC", "to_date": "2026-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.2.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } }, { "key": "transaction_recon_report_with_additional_fields", "name": "Transaction reconciliation report", "method": "POST", "uri": "/api/v1/finance/financial_reports/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "additional_fields": [ "issuing_card_nickname", "funding_type" ], "file_format": "EXCEL", "file_name": "TRANSACTION_RECON_REPORT_2026_02_23.xlsx", "from_date": "2026-02-22", "to_date": "2026-02-23", "report_version": "1.1.0", "settlement_currencies": [ "AUD", "USD", "EUR" ], "statuses": [ "SETTLED" ], "time_zone": "UTC", "transaction_currencies": [ "AUD", "USD", "EUR" ], "type": "TRANSACTION_RECON_REPORT" }, "response_body": { "file_format": "EXCEL", "file_name": "TRANSACTION_RECON_REPORT_2026_02_23.xlsx", "id": "8b2e4f1a-3c7d-4e9a-9f21-0a1b2c3d4e5f", "report_expires_at": "2026-03-23T23:59:59+1100", "report_parameters": { "from_date": "2026-02-22", "time_zone": "UTC", "to_date": "2026-02-23" }, "report_version": "1.1.0", "status": "COMPLETED", "type": "TRANSACTION_RECON_REPORT" } } ], "x-scope": [ { "scope": "financial_report:write", "group": "Finance", "resource_name": "Financial Reports", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/finance/financial_reports": { "get": { "tags": [ "Finance > Financial Reports" ], "summary": "3|List all Financial Reports", "description": "Get list of previously generated balance activity, transaction reconciliation, settlement, account statement, and aggregated settlement reports.", "operationId": "listFinancialReports", "parameters": [ { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default is 100, max is 1000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/CoreBankingFinancialReportRes" } } } }, "examples": { "default": { "value": { "has_more": true, "items": [ { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2022_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2022-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2022-02-22", "time_zone": "UTC", "to_date": "2022-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.0.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } ] } } } } } }, "400": { "description": "`invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/finance/financial_reports", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": true, "items": [ { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2022_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2022-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2022-02-22", "time_zone": "UTC", "to_date": "2022-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.0.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } ] } } ], "x-scope": [ { "scope": "financial_report:read", "group": "Finance", "resource_name": "Financial Reports", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/finance/financial_reports/{id}/content": { "get": { "tags": [ "Finance > Financial Reports" ], "summary": "4|Retrieve a Contents of a Financial Report", "description": "Download a previously generated balance activity, transaction reconciliation, settlement or aggregated settlement reports.", "operationId": "listContent", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of financial report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "financial_report_id" } } } ], "responses": { "200": { "description": "A file of content type matching the `file_format` of the financial report. The response `Content-Type` may be one of:\n\n- `application/pdf`: PDF (.pdf)\n- `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`: Microsoft Excel (.xlsx)\n- `text/plain`: CSV (.csv)\n- `application/octet-stream`: Generic binary file\n", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "examples": { "default": { "value": "" } } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "`invalid_argument`", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/pdf": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/Error" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/finance/financial_reports/financial_report_id/content", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": "" } ], "x-scope": [ { "scope": "financial_report:read", "group": "Finance", "resource_name": "Financial Reports", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/finance/financial_reports/{id}": { "get": { "tags": [ "Finance > Financial Reports" ], "summary": "2|Retrieve a Financial Report", "description": "Get a single generated balance activity, transaction reconciliation, settlement or aggregated settlement report.", "operationId": "retrieveFinancialReport", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of financial report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "financial_report_id" } } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreBankingFinancialReportRes" }, "examples": { "default": { "value": { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2022_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2022-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2022-02-22", "time_zone": "UTC", "to_date": "2022-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.0.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } } } } } }, "400": { "description": "`invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/finance/financial_reports/financial_report_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "file_format": "CSV", "file_name": "BALANCE_ACTIVITY_REPORT_2022_02_23.csv", "id": "ff13f14b-1624-4c24-b601-b4c018d2ea092", "report_expires_at": "2022-03-23T23:59:59+1100", "report_parameters": { "currencies": [ "AUD", "USD", "EUR" ], "from_date": "2022-02-22", "time_zone": "UTC", "to_date": "2022-02-25", "transaction_types": [ "conversion" ] }, "report_version": "1.0.0", "status": "COMPLETED", "type": "BALANCE_ACTIVITY_REPORT" } } ], "x-scope": [ { "scope": "financial_report:read", "group": "Finance", "resource_name": "Financial Reports", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/financial_transactions": { "get": { "tags": [ "Finance > Financial Transactions" ], "summary": "2|List all Financial Transactions", "description": "Get a list of financial transactions that contributed to the Airwallex account balance from a specified creation date/time, with optional filters on end creation date/time, batch_id and status.", "operationId": "listFinancialTransactions", "parameters": [ { "name": "batch_id", "in": "query", "description": "Batch unique identifier of the financial transaction.", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "The currency (3-letter ISO-4217 code) of the financial transaction.", "required": false, "schema": { "type": "string" } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, default is 0, max is 2000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default is 100, max is 1000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "source_id", "in": "query", "description": "The source unique identifier of the transaction.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of the financial transaction, one of: `PENDING`, `SETTLED`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "x-on-behalf-of", "in": "header", "description": "Unique identifier of the connected sub account.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/CoreBankingFinancialTransaction" } } } }, "examples": { "default": { "value": { "has_more": true, "items": [ { "amount": 200.21, "batch_id": "bat_20201202_SGD_2", "client_rate": 6.93, "created_at": "2021-03-22T16:08:02", "currency": "CNY", "currency_pair": "AUDUSD", "description": "deposit to.", "estimated_settled_at": "2021-03-22T16:08:02", "fee": 0, "funding_source_id": "99d23411-234-22dd-23po-13sd7c267b9e", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "net": 100.21, "settled_at": "2021-03-22T16:08:02", "source_id": "9f687fe6-dcf4-4462-92fa-80335301d9d2", "source_type": "PAYMENT_ATTEMPT", "status": "PENDING", "transaction_type": "PAYMENT" } ] } } } } } }, "400": { "description": "`invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/financial_transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": true, "items": [ { "amount": 200.21, "batch_id": "bat_20201202_SGD_2", "client_rate": 6.93, "created_at": "2021-03-22T16:08:02", "currency": "CNY", "currency_pair": "AUDUSD", "description": "deposit to.", "estimated_settled_at": "2021-03-22T16:08:02", "fee": 0, "funding_source_id": "99d23411-234-22dd-23po-13sd7c267b9e", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "net": 100.21, "settled_at": "2021-03-22T16:08:02", "source_id": "9f687fe6-dcf4-4462-92fa-80335301d9d2", "source_type": "PAYMENT_ATTEMPT", "status": "PENDING", "transaction_type": "PAYMENT" } ] } } ], "x-scope": [ { "scope": "financial_transaction:read", "group": "Finance", "resource_name": "Financial Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/financial_transactions/{id}": { "get": { "tags": [ "Finance > Financial Transactions" ], "summary": "1|Retrieve a Financial Transaction", "description": "Get a specific financial transaction by an Airwallex financial transaction unique identifier.", "operationId": "retrieveFinancialTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of financial transaction.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "financial_transaction_id" } } }, { "name": "x-on-behalf-of", "in": "header", "description": "Unique identifier of the connected sub account.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreBankingFinancialTransaction" }, "examples": { "default": { "value": { "amount": 200.21, "batch_id": "bat_20201202_SGD_2", "client_rate": 6.93, "created_at": "2021-03-22T16:08:02", "currency": "CNY", "currency_pair": "AUDUSD", "description": "deposit to.", "estimated_settled_at": "2021-03-22T16:08:02", "fee": 0, "funding_source_id": "99d23411-234-22dd-23po-13sd7c267b9e", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "net": 100.21, "settled_at": "2021-03-22T16:08:02", "source_id": "9f687fe6-dcf4-4462-92fa-80335301d9d2", "source_type": "PAYMENT_ATTEMPT", "status": "PENDING", "transaction_type": "PAYMENT" } } } } } }, "401": { "description": "`credentials_invalid`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/financial_transactions/financial_transaction_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 200.21, "batch_id": "bat_20201202_SGD_2", "client_rate": 6.93, "created_at": "2021-03-22T16:08:02", "currency": "CNY", "currency_pair": "AUDUSD", "description": "deposit to.", "estimated_settled_at": "2021-03-22T16:08:02", "fee": 0, "funding_source_id": "99d23411-234-22dd-23po-13sd7c267b9e", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "net": 100.21, "settled_at": "2021-03-22T16:08:02", "source_id": "9f687fe6-dcf4-4462-92fa-80335301d9d2", "source_type": "PAYMENT_ATTEMPT", "status": "PENDING", "transaction_type": "PAYMENT" } } ], "x-scope": [ { "scope": "financial_transaction:read", "group": "Finance", "resource_name": "Financial Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/financial/settlements": { "get": { "tags": [ "Finance > Settlements" ], "summary": "2|List all Settlements", "description": "Get list of settlements that contributed to the Airwallex account balance from a specified settled date, with optional filters on end settled date, currency and status.", "operationId": "listSettlement", "parameters": [ { "name": "currency", "in": "query", "description": "Currency of the settlement.", "required": true, "schema": { "type": "string", "default": "CNY" } }, { "name": "from_settled_at", "in": "query", "description": "The start date of `settled_at` in ISO8601 format (inclusive).", "required": true, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default is 100, max is 1000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "Status of the settlement, one of: `PENDING`, `SETTLED`.", "required": true, "schema": { "type": "string", "default": "PENDING" } }, { "name": "to_settled_at", "in": "query", "description": "The end date of `settled_at` in ISO8601 format (inclusive).", "required": true, "schema": { "type": "string", "default": "2017-04-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentAcceptanceFinancialSettlement" } } } }, "examples": { "default": { "value": { "has_more": true, "items": [ { "amount": 99, "created_at": "2019-11-21", "currency": "CNY", "estimated_settled_at": "2019-11-21", "fee": 1, "settlement_id": "bat_20190328_EUR_1", "settled_at": "2019-11-21", "status": "PENDING" } ] } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/financial/settlements", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": true, "items": [ { "amount": 99, "created_at": "2019-11-21", "currency": "CNY", "estimated_settled_at": "2019-11-21", "fee": 1, "settlement_id": "bat_20190328_EUR_1", "settled_at": "2019-11-21", "status": "PENDING" } ] } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/financial/settlements/{id}/report": { "get": { "tags": [ "Finance > Settlements" ], "summary": "3|Retrieve a Settlement Report", "description": "Get a single batch settlement report by specifying the Airwallex settlement batch unique identifier.", "operationId": "listReport", "parameters": [ { "name": "file_format", "in": "query", "description": "File format of the requested report. Supported formats are `csv` and `excel`. Default format is `excel`.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Batch unique identifier of transaction.", "required": true, "schema": { "type": "string", "default": "bat_20190328_EUR_1" }, "examples": { "default": { "value": "settlement_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAcceptanceFinancialSettlementReport" }, "examples": { "default": { "value": { "created_at": "2019-11-15T20:00:48+00:00", "settlement_id": "bat_20190328_EUR_1", "report_url": "https://www.airwallex.com", "report_status": "READY" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `resource_not_found` (invalid `settlement_id`), `validation_error` (e.g. report too large to generate)." }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/financial/settlements/settlement_id/report", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "created_at": "2019-11-15T20:00:48+00:00", "settlement_id": "bat_20190328_EUR_1", "report_url": "https://www.airwallex.com", "report_status": "READY" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/financial/settlements/{id}": { "get": { "tags": [ "Finance > Settlements" ], "summary": "1|Retrieve a Settlement", "description": "Get a specific settlement detail by specifying the Airwallex settlement unique identifier.", "operationId": "retrieveSettlement", "parameters": [ { "name": "id", "in": "path", "description": "Batch unique identifier of transaction.", "required": true, "schema": { "type": "string", "default": "bat_20190328_EUR_1" }, "examples": { "default": { "value": "settlement_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAcceptanceFinancialSettlement" }, "examples": { "default": { "value": { "amount": 99, "created_at": "2019-11-21", "currency": "CNY", "estimated_settled_at": "2019-11-21", "fee": 1, "settlement_id": "bat_20190328_EUR_1", "settled_at": "2019-11-21", "status": "PENDING" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/financial/settlements/settlement_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 99, "created_at": "2019-11-21", "currency": "CNY", "estimated_settled_at": "2019-11-21", "fee": 1, "settlement_id": "bat_20190328_EUR_1", "settled_at": "2019-11-21", "status": "PENDING" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/authorizations": { "get": { "tags": [ "Issuing > Authorizations" ], "summary": "2|List all Authorizations", "description": "Retrieves details of all card authorizations associated with your account. By default, authorizations created within the last 30 days are returned unless both *to* and *from* created_at request fields are populated.\n\n*This endpoint uses the legacy transaction model. Use [Transaction Events](/docs/api/issuing/card_transaction_events), [Card Transactions](/docs/api/issuing/card_transactions), and [Lifecycles](/docs/api/issuing/card_transaction_lifecycles) for the three-level transaction model and more precise transaction status and event data.*", "operationId": "listAuthorizations", "parameters": [ { "name": "billing_currency", "in": "query", "description": "Currency in which the transaction was billed, in 3-letter ISO-4217 code.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "card_id", "in": "query", "description": "Unique Identifier for the card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "digital_wallet_token_id", "in": "query", "description": "Unique Identifier for the digital token.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "start of Transaction Date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "to_created_at - 30 day" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "retrieval_ref", "in": "query", "description": "Retrieval reference number.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Authorization status, Can be one of `CLEARED`, `EXPIRED`, `FAILED`, `PENDING`, `REVERSED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "End of Transaction Date in ISO8601 format (exclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "current time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "items" ], "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciAuthorization" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 1000, "billing_currency": "USD", "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "client_data": "Some client data", "create_time": "2018-03-22T16:08:02+00:00", "digital_wallet_token_id": "91eb855a-8169-40ea-b428-8405372da9a5", "expiry_date": "2018-03-22T16:08:02+00:00", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "PENDING", "transaction_amount": 100, "transaction_currency": "USD", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "updated_by_transaction": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": true, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/authorizations", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 1000, "billing_currency": "USD", "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "client_data": "Some client data", "create_time": "2018-03-22T16:08:02+00:00", "digital_wallet_token_id": "91eb855a-8169-40ea-b428-8405372da9a5", "expiry_date": "2018-03-22T16:08:02+00:00", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "PENDING", "transaction_amount": 100, "transaction_currency": "USD", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "updated_by_transaction": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" } ] } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account", "x-badges": [ { "name": "Deprecated" } ] } }, "/api/v1/issuing/authorizations/{id}": { "get": { "tags": [ "Issuing > Authorizations" ], "summary": "1|Retrieve an Authorization", "description": "Retrieves details of an authorization performed on a card issued to your account.\n\n*This endpoint uses the legacy transaction model. Use [Transaction Events](/docs/api/issuing/card_transaction_events), [Card Transactions](/docs/api/issuing/card_transactions), and [Lifecycles](/docs/api/issuing/card_transaction_lifecycles) for the three-level transaction model and more precise transaction status and event data.*", "operationId": "retrieveAuthorization", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for a transaction.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "authorization_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciAuthorization" }, "examples": { "default": { "value": { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 1000, "billing_currency": "USD", "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_nickname": "", "client_data": "Some client data", "create_time": "2018-03-22T16:08:02+00:00", "digital_wallet_token_id": "91eb855a-8169-40ea-b428-8405372da9a5", "expiry_date": "2018-03-22T16:08:02+00:00", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "PENDING", "transaction_amount": 100, "transaction_currency": "USD", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "updated_by_transaction": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": true, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/authorizations/authorization_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 1000, "billing_currency": "USD", "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_nickname": "", "client_data": "Some client data", "create_time": "2018-03-22T16:08:02+00:00", "digital_wallet_token_id": "91eb855a-8169-40ea-b428-8405372da9a5", "expiry_date": "2018-03-22T16:08:02+00:00", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "PENDING", "transaction_amount": 100, "transaction_currency": "USD", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "updated_by_transaction": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account", "x-badges": [ { "name": "Deprecated" } ] } }, "/api/v1/issuing/card_transaction_events": { "get": { "tags": [ "Issuing > Card Transaction Events" ], "summary": "2|List all Card Transaction Events", "description": "Retrieve a paginated list of transaction events. Each event includes its type, subtype, process result, and per-event amounts. Use the `lifecycle_id` or `card_transaction_id` filter to trace the sequence of events within a specific lifecycle or card transaction.", "operationId": "listCardTransactionEvents", "parameters": [ { "name": "billing_currency", "in": "query", "description": "Filter by billing currency (3-letter ISO 4217 code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "card_id", "in": "query", "description": "Filter by card. Only returns transaction events associated with this card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "card_transaction_id", "in": "query", "description": "Filter by card transaction. Only returns transaction events belonging to this card transaction.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "Filter for items created after this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "lifecycle_id", "in": "query", "description": "Filter by lifecycle. Only returns transaction events belonging to this lifecycle.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of related objects to be listed per page. The maximum is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "Filter for items created before this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "type", "in": "query", "description": "Filter by event type. One of `AUTHORIZATION`, `CLEARING`, or `REVERSAL_AUTH`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "AUTHORIZATION", "CLEARING", "REVERSAL_AUTH", "UNKNOWN" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciBookmarkedResultOfIssuingNonPciTransactionEvent" }, "examples": { "default": { "value": { "items": [ { "acquiring_institution_identifier": "410964", "auth_code": "VJT90Z", "billing_amount": 100, "billing_currency": "USD", "card_transaction_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "conversion_details": { "from_currency": "USD", "rate": 1.56, "to_currency": "AUD" }, "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "network_transaction_id": "386055120641953", "pos_entry_mode": "CONTACTLESS_CHIP", "process_result": "APPROVED", "retrieval_ref": "605103644028", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_category": "PURCHASE", "transaction_currency": "AUD", "transacted_at": "2018-03-22T16:08:02+00:00", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/card_transaction_events", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "acquiring_institution_identifier": "410964", "auth_code": "VJT90Z", "billing_amount": 100, "billing_currency": "USD", "card_transaction_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "conversion_details": { "from_currency": "USD", "rate": 1.56, "to_currency": "AUD" }, "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "network_transaction_id": "386055120641953", "pos_entry_mode": "CONTACTLESS_CHIP", "process_result": "APPROVED", "retrieval_ref": "605103644028", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_category": "PURCHASE", "transaction_currency": "AUD", "transacted_at": "2018-03-22T16:08:02+00:00", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/card_transaction_events/{id}": { "get": { "tags": [ "Issuing > Card Transaction Events" ], "summary": "1|Retrieve a Card Transaction Event", "description": "Retrieve a single transaction event by its unique identifier. The response includes the event type, subtype, process result, failure reason (if declined), and per-event billing and transaction amounts.", "operationId": "retrieveCardTransactionEvent", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the transaction event.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "card_transaction_event_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionEvent" }, "examples": { "default": { "value": { "acquiring_institution_identifier": "410964", "auth_code": "VJT90Z", "billing_amount": 100, "billing_currency": "USD", "card_transaction_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "conversion_details": { "from_currency": "USD", "rate": 1.56, "to_currency": "AUD" }, "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "failure_reason": "", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "network_transaction_id": "386055120641953", "pos_entry_mode": "CONTACTLESS_CHIP", "process_result": "APPROVED", "retrieval_ref": "605103644028", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_category": "PURCHASE", "transaction_currency": "AUD", "transacted_at": "2018-03-22T16:08:02+00:00", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/card_transaction_events/card_transaction_event_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "acquiring_institution_identifier": "410964", "auth_code": "VJT90Z", "billing_amount": 100, "billing_currency": "USD", "card_transaction_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "conversion_details": { "from_currency": "USD", "rate": 1.56, "to_currency": "AUD" }, "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "failure_reason": "", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "network_transaction_id": "386055120641953", "pos_entry_mode": "CONTACTLESS_CHIP", "process_result": "APPROVED", "retrieval_ref": "605103644028", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_category": "PURCHASE", "transaction_currency": "AUD", "transacted_at": "2018-03-22T16:08:02+00:00", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/lifecycles": { "get": { "tags": [ "Issuing > Card Transaction Lifecycles" ], "summary": "2|List all Card Transaction Lifecycles", "description": "Retrieve a paginated list of lifecycles. Each lifecycle provides a network-level view of a payment with aggregated billing amounts. Use the `card_id` filter to narrow results to a specific card.", "operationId": "listLifecycles", "parameters": [ { "name": "card_id", "in": "query", "description": "Filter by card. Only returns lifecycles associated with this card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "Filter for items created after this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of related objects to be listed per page. The maximum is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "Filter for items created before this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciBookmarkedResultOfIssuingNonPciLifecycle" }, "examples": { "default": { "value": { "items": [ { "billing_amounts": [ { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 } ], "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "created_at": "2018-03-22T16:08:02+00:00", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/lifecycles", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "billing_amounts": [ { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 } ], "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "created_at": "2018-03-22T16:08:02+00:00", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/lifecycles/{id}": { "get": { "tags": [ "Issuing > Card Transaction Lifecycles" ], "summary": "1|Retrieve a Card Transaction Lifecycle", "description": "Retrieve a single lifecycle by its unique identifier. The response includes aggregated billing amounts across all card transactions and transaction events in this lifecycle.", "operationId": "retrieveLifecycles", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the lifecycle.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "card_transaction_lifecycle_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciLifecycle" }, "examples": { "default": { "value": { "billing_amounts": [ { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 } ], "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "created_at": "2018-03-22T16:08:02+00:00", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/lifecycles/card_transaction_lifecycle_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "billing_amounts": [ { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 } ], "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "created_at": "2018-03-22T16:08:02+00:00", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/card_transactions": { "get": { "tags": [ "Issuing > Card Transactions" ], "summary": "2|List all Card Transactions", "description": "Retrieve a paginated list of card transactions. Each card transaction includes its status, fund direction, merchant details, and aggregated billing amounts. Use the `lifecycle_id` filter to retrieve all card transactions within a specific lifecycle, or `status` to filter by transaction status.", "operationId": "listCardTransactions", "parameters": [ { "name": "billing_currency", "in": "query", "description": "Filter by billing currency (3-letter ISO 4217 code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "card_id", "in": "query", "description": "Filter by card. Only returns card transactions associated with this card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "Filter for items created after this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "lifecycle_id", "in": "query", "description": "Filter by lifecycle. Only returns card transactions belonging to this lifecycle.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of related objects to be listed per page. The maximum is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "Filter by status. One of `AUTHORIZED`, `CLEARED`, `DECLINED`, `EXPIRED`, `REVERSED`, or `VERIFIED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "AUTHORIZED", "CLEARED", "DECLINED", "EXPIRED", "REVERSED", "VERIFIED", "UNKNOWN" ] } }, { "name": "to_created_at", "in": "query", "description": "Filter for items created before this date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciBookmarkedResultOfIssuingNonPciCardTransaction" }, "examples": { "default": { "value": { "items": [ { "billing_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "card_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "fund_direction": "DEBIT", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "status": "AUTHORIZED", "transaction_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/card_transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "billing_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "card_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "fund_direction": "DEBIT", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "status": "AUTHORIZED", "transaction_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "updated_at": "2018-03-22T16:08:02+00:00" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/card_transactions/{id}": { "get": { "tags": [ "Issuing > Card Transactions" ], "summary": "1|Retrieve a Card Transaction", "description": "Retrieve a single card transaction by its unique identifier. The response includes the current status, fund direction, merchant details, and aggregated billing amounts.", "operationId": "retrieveCardTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the card transaction.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "card_transaction_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCardTransaction" }, "examples": { "default": { "value": { "billing_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "card_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "failure_reason": "", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "fund_direction": "DEBIT", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "status": "AUTHORIZED", "transaction_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/card_transactions/card_transaction_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "billing_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "card_id": "5b2dc266-09ad-4235-b61a-767c7cd6d6ef", "created_at": "2018-03-22T16:08:02+00:00", "digital_wallet_token": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "payment_method": "GOOGLE_PAY" }, "expiry_date": "2026-02-01T16:08:02+00:00", "failure_reason": "", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "fund_direction": "DEBIT", "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "lifecycle_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "masked_card_number": "************4242", "merchant": { "additional_merchant_info": { "merchant_brand_category_id": 17000, "merchant_brand_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "merchant_brand_name": "Meta", "merchant_brand_subcategory_id": 17004, "merchant_logo_url": "https://example.com/logo.png" }, "category_code": "4829", "city": "New York", "country": "US", "identifier": "012345678910123", "name": "Test Merchant", "postcode": "10001", "state": "NY" }, "status": "AUTHORIZED", "transaction_amounts": { "currency": "USD", "total_authorized": 100, "total_credited": 0, "total_debited": 100, "total_declined": 0, "total_expired": 0, "total_pending": 0, "total_reversed": 0 }, "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cardholders/create": { "post": { "tags": [ "Issuing > Cardholders" ], "summary": "1|Create a Cardholder", "description": "Cardholders are an authorized representative of your business. Two types of cardholder are permissible, Individual and Delegate. \n`INDIVIDUAL`: A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized card. \n`DELEGATE`: A cardholder who may be assigned to non-personalized cards only and acts as an authorized user of the card. \n \nAny cards attached to delegate cardholders are associated with the name of your business. Creation of cardholders involves passing a name screening process which requires some basic details about the cardholder.", "operationId": "createCardholder", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "individual", "type" ], "properties": { "email": { "type": "string", "description": "Email address of the cardholder." }, "individual": { "type": "object", "required": [ "address", "date_of_birth", "express_consent_obtained", "name" ], "description": "Details about the cardholder. Only relevant for individual cardholder type.", "properties": { "address": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "description": "Street address of the cardholder.", "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } } }, "cardholder_agreement_terms_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you have the express consent of this." }, "date_of_birth": { "type": "string", "format": "date", "description": "The individual's date of birth, in the format `YYYY-MM-DD`." }, "employers": { "type": "array", "description": "Information of the individual's employers.", "items": { "type": "object", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ] } } } }, "business_name": { "type": "string", "description": "Name of the employer." } } } }, "express_consent_obtained": { "type": "string", "description": "By setting this field to `yes` you confirm that you have the express consent of this cardholder for Airwallex to perform name and sanction screening or any further identity verification if required." }, "identification": { "type": "object", "required": [ "country", "expiry_date", "number", "type" ], "description": "Identification of the individual cardholder. This object is optional and is only required if name screening fails or if Airwallex deem necessary for your integration.", "properties": { "country": { "type": "string", "description": "ISO country code of identification document." }, "document_back_file_id": { "type": "string", "description": "The unique identifier for an image of the back of the given document. This can be retrieved by uploading a file to the file upload endpoint within the API." }, "document_front_file_id": { "type": "string", "description": "The unique identifier for an image of the front of the given document. This can be retrieved by uploading a file to the file upload endpoint within the API." }, "expiry_date": { "type": "string", "format": "date", "description": "Expiry date of the identification document provided, in the format YYYY-MM-DD." }, "gender": { "type": "string", "description": "Gender as specified on UK drivers license. Not required for other identification types.", "enum": [ "M", "F" ] }, "number": { "type": "string", "description": "Document number. May be a license number or passport number." }, "state": { "type": "string", "description": "State the document was issued in. Required only if type is DRIVERS_LICENSE and country is AU." }, "type": { "type": "string", "description": "Type of identification being provided.", "enum": [ "PASSPORT", "DRIVERS_LICENSE", "ID_CARD" ] } } }, "name": { "type": "object", "required": [ "first_name", "last_name" ], "description": "The full name of the Individual. Only characters in English are supported.", "properties": { "first_name": { "type": "string", "description": "First name of cardholder." }, "last_name": { "type": "string", "description": "Last name for cardholder." }, "middle_name": { "type": "string", "description": "Optional middle name of cardholder." }, "title": { "type": "string", "description": "Optional title of cardholder." } } }, "nationality": { "type": "string", "description": "The 2-letter ISO country code for the individual's nationality." }, "paperless_notification_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you consent to paperless notifications. You agree to the Electronic Communications Consent Agreement which states that we may provide you with all disclosures, notices and other communications, about Airwallex's services including this Agreement and any further amendments, in electronic form." }, "privacy_policy_terms_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you consent to the terms of the Privacy Policy." }, "tax_identification_number": { "type": "string", "description": "The tax identification number for the individual cardholder. Used for customs or regulatory reporting when required by the shipping destination. Format and requirements may differ by country." } } }, "mobile_number": { "type": "string", "description": "Mobile number of the cardholder." }, "postal_address": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "description": "Optional postal address of the cardholder. Only required if different to address and physical cards are to be issued.", "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } } }, "type": { "type": "string", "description": "The type of cardholder. One of INDIVIDUAL or DELEGATE, which are defined as follows: \n`INDIVIDUAL`: A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized card. \n`DELEGATE`: A cardholder who may be assigned to non-personalized cards only and acts as an authorized user of the card." } } }, "examples": { "default": { "value": { "email": "john@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "cardholder_agreement_terms_consent_obtained": "yes", "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "express_consent_obtained": "yes", "identification": { "country": "AU", "document_back_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "document_front_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "expiry_date": "2028-08-28", "gender": "F", "number": "001238243", "state": "NT", "type": "DRIVERS_LICENSE" }, "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "nationality": "UK", "paperless_notification_consent_obtained": "yes", "privacy_policy_terms_consent_obtained": "yes", "tax_identification_number": "" }, "mobile_number": "61432100100", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "type": "INDIVIDUAL" } } } } }, "description": "newCardholderRequest.", "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCardholder" }, "examples": { "default": { "value": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cardholders/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "email": "john@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "cardholder_agreement_terms_consent_obtained": "yes", "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "express_consent_obtained": "yes", "identification": { "country": "AU", "document_back_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "document_front_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "expiry_date": "2028-08-28", "gender": "F", "number": "001238243", "state": "NT", "type": "DRIVERS_LICENSE" }, "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "nationality": "UK", "paperless_notification_consent_obtained": "yes", "privacy_policy_terms_consent_obtained": "yes", "tax_identification_number": "" }, "mobile_number": "61432100100", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "type": "INDIVIDUAL" }, "response_body": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } ], "x-scope": [ { "scope": "issuing.cardholder:write", "group": "Issuing", "resource_name": "Cardholders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cardholders/{id}/delete": { "post": { "tags": [ "Issuing > Cardholders" ], "summary": "5|Delete a Cardholder", "description": "Deletes the cardholder with the corresponding unique identifier. Deleting the cardholder will also cause all employee cards that are linked to the cardholder to also be closed.", "operationId": "deleteCardholder", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the cardholder.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "cardholder_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciDeleteCardholder" }, "examples": { "default": { "value": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "deleted": true } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cardholders/cardholder_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "deleted": true } } ], "x-scope": [ { "scope": "issuing.cardholder:write", "group": "Issuing", "resource_name": "Cardholders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cardholders": { "get": { "tags": [ "Issuing > Cardholders" ], "summary": "3|List all Cardholders", "description": "Get all cardholders created within an account.", "operationId": "listCardholders", "parameters": [ { "name": "cardholder_status", "in": "query", "description": "Cardholder status.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "PENDING", "READY", "DISABLED", "INCOMPLETE" ] } }, { "name": "email", "in": "query", "description": "Email address of the cardholder to filter by.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, between 10 and 200. The default is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "items" ], "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciCardholder" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" } }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cardholders", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" } }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } ] } } ], "x-scope": [ { "scope": "issuing.cardholder:read", "group": "Issuing", "resource_name": "Cardholders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cardholders/{id}": { "get": { "tags": [ "Issuing > Cardholders" ], "summary": "2|Retrieve the Cardholder Details", "description": "Retrieve details for a cardholder.", "operationId": "retrieveCardholder", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the cardholder.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "cardholder_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCardholder" }, "examples": { "default": { "value": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cardholders/cardholder_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } ], "x-scope": [ { "scope": "issuing.cardholder:read", "group": "Issuing", "resource_name": "Cardholders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cardholders/{id}/update": { "post": { "tags": [ "Issuing > Cardholders" ], "summary": "4|Update a Cardholder", "description": "Update a cardholder with selected information. All fields are optional, and only those provided will be updated. If a composite object, e.g. `name` is provided, then all of its child fields must be provided and valid. Updating the cardholder may re-trigger the name screening process.", "operationId": "updateCardholder", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "cardholder_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "individual": { "type": "object", "required": [ "address", "date_of_birth", "express_consent_obtained", "name" ], "description": "Details about the cardholder. Only relevant for individual cardholder type.", "properties": { "address": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "description": "Street address of the cardholder.", "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } } }, "cardholder_agreement_terms_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you have the express consent of this." }, "date_of_birth": { "type": "string", "format": "date", "description": "The individual's date of birth, in the format `YYYY-MM-DD`." }, "employers": { "type": "array", "description": "Information of the individual's employers.", "items": { "type": "object", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ] } } } }, "business_name": { "type": "string", "description": "Name of the employer." } } } }, "express_consent_obtained": { "type": "string", "description": "By setting this field to `yes` you confirm that you have the express consent of this cardholder for Airwallex to perform name and sanction screening or any further identity verification if required." }, "identification": { "type": "object", "required": [ "country", "expiry_date", "number", "type" ], "description": "Identification of the individual cardholder. This object is optional and is only required if name screening fails or if Airwallex deem necessary for your integration.", "properties": { "country": { "type": "string", "description": "ISO country code of identification document." }, "document_back_file_id": { "type": "string", "description": "The unique identifier for an image of the back of the given document. This can be retrieved by uploading a file to the file upload endpoint within the API." }, "document_front_file_id": { "type": "string", "description": "The unique identifier for an image of the front of the given document. This can be retrieved by uploading a file to the file upload endpoint within the API." }, "expiry_date": { "type": "string", "format": "date", "description": "Expiry date of the identification document provided, in the format YYYY-MM-DD." }, "gender": { "type": "string", "description": "Gender as specified on UK drivers license. Not required for other identification types.", "enum": [ "M", "F" ] }, "number": { "type": "string", "description": "Document number. May be a license number or passport number." }, "state": { "type": "string", "description": "State the document was issued in. Required only if type is DRIVERS_LICENSE and country is AU." }, "type": { "type": "string", "description": "Type of identification being provided.", "enum": [ "PASSPORT", "DRIVERS_LICENSE", "ID_CARD" ] } } }, "name": { "type": "object", "required": [ "first_name", "last_name" ], "description": "The full name of the Individual. Only characters in English are supported.", "properties": { "first_name": { "type": "string", "description": "First name of cardholder." }, "last_name": { "type": "string", "description": "Last name for cardholder." }, "middle_name": { "type": "string", "description": "Optional middle name of cardholder." }, "title": { "type": "string", "description": "Optional title of cardholder." } } }, "nationality": { "type": "string", "description": "The 2-letter ISO country code for the individual's nationality." }, "paperless_notification_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you consent to paperless notifications. You agree to the Electronic Communications Consent Agreement which states that we may provide you with all disclosures, notices and other communications, about Airwallex's services including this Agreement and any further amendments, in electronic form." }, "privacy_policy_terms_consent_obtained": { "type": "string", "description": "For Canada entities only - By setting this field to yes you confirm that you consent to the terms of the Privacy Policy." }, "tax_identification_number": { "type": "string", "description": "The tax identification number for the individual cardholder. Used for customs or regulatory reporting when required by the shipping destination. Format and requirements may differ by country." } } }, "mobile_number": { "type": "string", "description": "Mobile number of the cardholder." }, "postal_address": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "description": "Optional postal address of the cardholder. Only required if different to address and physical cards are to be issued.", "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } } }, "type": { "type": "string", "description": "The type of cardholder. One of INDIVIDUAL or DELEGATE, which are defined as follows: \n`INDIVIDUAL`: A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized card. \n`DELEGATE`: A cardholder who may be assigned to non-personalized cards only and acts as an authorized user of the card." } } }, "examples": { "default": { "value": { "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "cardholder_agreement_terms_consent_obtained": "yes", "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "express_consent_obtained": "yes", "identification": { "country": "AU", "document_back_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "document_front_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "expiry_date": "2028-08-28", "gender": "F", "number": "001238243", "state": "NT", "type": "DRIVERS_LICENSE" }, "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "nationality": "UK", "paperless_notification_consent_obtained": "yes", "privacy_policy_terms_consent_obtained": "yes", "tax_identification_number": "" }, "mobile_number": "61432100100", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "type": "INDIVIDUAL" } } } } }, "description": "updateCardholderRequest.", "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCardholder" }, "examples": { "default": { "value": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cardholders/cardholder_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "cardholder_agreement_terms_consent_obtained": "yes", "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "express_consent_obtained": "yes", "identification": { "country": "AU", "document_back_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "document_front_file_id": "NzI3ZDAxM2ItZjMzMC00ZDIyLTk4YTQtMTE3ZTA0MjdhZTUyLHwsaG9uZ2tvbmcsfCxwYXNzcG9ydC5qcGdfMTYwNzY0MDI4OQ==", "expiry_date": "2028-08-28", "gender": "F", "number": "001238243", "state": "NT", "type": "DRIVERS_LICENSE" }, "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "nationality": "UK", "paperless_notification_consent_obtained": "yes", "privacy_policy_terms_consent_obtained": "yes", "tax_identification_number": "" }, "mobile_number": "61432100100", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "type": "INDIVIDUAL" }, "response_body": { "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "email": "jill@example.com", "individual": { "address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "date_of_birth": "1982-11-02", "employers": [ { "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ] } ], "name": { "first_name": "John", "last_name": "Smith", "middle_name": "Fitzgerald", "title": "Mr" }, "tax_identification_number": "" }, "mobile_number": "61-9922334321", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "status": "PENDING", "type": "INDIVIDUAL" } } ], "x-scope": [ { "scope": "issuing.cardholder:write", "group": "Issuing", "resource_name": "Cardholders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}/activate": { "post": { "tags": [ "Issuing > Cards" ], "summary": "5|Activate a Card", "description": "Activate a physical card for card payment authorizations.", "operationId": "cards_activate", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "default": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "examples": { "default": { "value": "card_id" } } } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciError" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cards/card_id/activate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK" } ], "x-scope": [ { "scope": "issuing.card:write", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/create": { "post": { "tags": [ "Issuing > Cards" ], "summary": "1|Create a Card", "description": "The card object is the actual resource associated with the card issued out by Airwallex. It holds details such as linked account, embossed name (for physical cards), shipping method and information (for physical cards), card based spend controls (eg. transaction limits, blocked merchant category codes etc.). The card object also determines who the card is for (ie for clients or their customers/employees), form factor (physical or virtual), and the number of uses (single or multiple).", "operationId": "createCard", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "authorization_controls", "cardholder_id", "created_by", "form_factor", "is_personalized", "program", "request_id" ], "properties": { "activate_on_issue": { "type": "boolean", "description": "Set this to `true` to activate the physical card when it is created. This will enable use of the card while it’s being delivered to the cardholder. Virtual cards will always be activated upon creation." }, "auto_close_date": { "type": "string", "format": "date", "description": "If provided, the card is automatically closed at the start of the specified day (00:00 GMT). The date must be in the format YYYY-MM-DD and must be at least 1 day and no more than 5 years after the card is created. If not provided, the card is not automatically closed and follows the standard expiry and reissue behavior." }, "additional_cardholder_ids": { "type": "array", "description": "The IDs of additional cardholders to associate this card with. Only valid if `is_personalized` is `false`.", "items": { "type": "string", "format": "uuid" } }, "alert_settings": { "type": "object", "description": "Contains alert configuration settings for the card.", "properties": { "low_remaining_transaction_limit": { "type": "object", "required": [ "enabled", "percent" ], "description": "Configures an alert for when the remaining spending limit dips below a specified percentage. When enabled, a webhook notification will be triggered if the remaining limit falls below the defined threshold. Note that:\n\n- Only one notification per spend limit interval will be sent. A webhook is triggered only when the threshold is crossed, and further spending below the threshold will not trigger additional notifications. Example: if the percent enabled is 10, a webhook will be sent once the remaining limit is at or less than 10%.\n- If the spend limit has been updated, a new notification will be sent when the new threshold is crossed.\n- This alert only applies to multiple use cards.\n- If not specified, this setting will be enabled by default with ``enabled`` set to ``true`` and ``percent`` set to an account specific default value.", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether the alert is active." }, "percent": { "type": "integer", "format": "int32", "description": "Specifies the percentage threshold for the alert." } } } } }, "authorization_controls": { "type": "object", "required": [ "allowed_transaction_count", "transaction_limits" ], "description": "Spend controls that determine the rules and restrictions to check for transaction authorizations.", "properties": { "active_from": { "type": "string", "description": "If provided, authorizations prior to this time will be rejected." }, "active_to": { "type": "string", "description": "If provided, authorizations after this time will be rejected." }, "allowed_currencies": { "type": "array", "description": "Allowed Currencies for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then all transaction currencies will be allowed.", "items": { "type": "string" } }, "allowed_merchant_brands": { "type": "object", "description": "Allowed Merchant Brands rules for transactions. Please note if this field is absent from request payload, then transactions from all merchant brands will be allowed.", "properties": { "categories": { "type": "array", "description": "Allowed Merchant Brands Categories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand categories will be allowed.", "items": { "type": "string" } }, "ids": { "type": "array", "description": "Allowed Merchant Brand identifiers for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand ids will be allowed. You can search for Merchant Brands ids using the [Merchant Brands API](/docs/api/issuing/merchant_brands/retrieve).", "items": { "type": "string", "format": "uuid" } }, "subcategories": { "type": "array", "description": "Allowed Merchant Brands Subcategories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand subcategories will be allowed.", "items": { "type": "string" } } } }, "allowed_merchant_categories": { "type": "array", "description": "Allowed Merchant Category Codes. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then all merchant categories will be allowed.", "items": { "type": "string" } }, "allowed_merchant_countries": { "type": "array", "description": "Allowed Merchant Countries for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant countries will be allowed (although some may still be blocked by our risk team).", "items": { "type": "string" } }, "allowed_transaction_count": { "type": "string", "description": "Specifies whether this card is a Single or Multiple Use card. Single Use means that the card can only be used for 1 successful debit transaction.", "enum": [ "SINGLE", "MULTIPLE" ] }, "blocked_transaction_usages": { "type": "array", "description": "List of disabled transaction usages, based on transaction_scope and usage_scope values. Please note if this field is absent from request payload or has a value of `null`, then all transaction usages will be allowed unless a default configration is added. \n \nYou can add multiple transaction_scope and usage_scope values. The most restrictive scope(s) would apply.", "items": { "type": "object", "properties": { "transaction_scope": { "type": "string", "description": "Types of transaction scope. It can be one of: `ALL_TRANSACTIONS`, `ONLINE_TRANSACTION`, `CONTACTLESS_TRANSACTION`, `CONTACT_CHIP_TRANSACTION`, `MAGSTRIPE`, `CASH_WITHDRAWAL`, `BILL_PAYMENT`, `ACCOUNT_FUNDING`." }, "usage_scope": { "type": "string", "description": "Determines if a transaction can be made domestically and/or internationally. It can be one of: `ALL`, `INTERNATIONAL`, `DOMESTIC`." } } } }, "transaction_limits": { "type": "object", "required": [ "limits" ], "description": "Transaction limits for the card. Multiple transaction limits can be configured based on single currency. Each transaction will be checked against the limits with interval after currency conversion rate applied.", "properties": { "cash_withdrawal_limits": { "type": "array", "description": "Cash withdrawal transaction limits are based on interval and amount. \n \nIf the daily limit is not set, the default daily limit amount for the selected limit currency will be used. The default daily limit amount is part of the account setting. To change the default daily limit amount, please reach out to your account manager. \n \nPlease note that the cash withdrawal transaction limits apply exclusively to cash withdrawals and are imposed to help manage potential liability for the account holder and for Airwallex. The account holder may be liable for any unauthorised spending on the card, so please apply the limits responsibly. \n \n**Important**: This limit will only appear if you have cash withdrawals enabled. Please speak to your account manager if you would like to enable cash withdrawals.", "items": { "type": "object", "required": [ "amount", "interval" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount. This field is mandatory and must be greater than 0. Customer can set perTransaction limit up to a maximum amount (The maximum amount is part of account setting)." }, "interval": { "type": "string", "description": "Transaction limit interval. This field is mandatory and must be one of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." } } } }, "currency": { "type": "string", "description": "Currency for transaction limits (3-letter ISO-4217 code). Will use USD if not set. Examples of valid base currencies are USD, AUD, GBP, EUR, CNY, HKD, SGD, NZD, JPY, CAD, CHF. More currencies may be available for your account: you may query the full list by calling the [Get issuing config](/docs/api/issuing/config/retrieve) endpoint." }, "limits": { "type": "array", "description": "Transaction limits are based on interval and amount. \n \nIf the per transaction limit is not set, the default per transaction limit amount for the selected limit currency will be used. The default per transaction amount is part of account settings. To change the default per transaction limit, please reach out to your account manager. \n \nThe account holder may be liable for any unauthorised spending on the card, so please apply limits responsibly.", "items": { "type": "object", "required": [ "amount", "interval" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount. This field is mandatory and must be greater than 0. Customer can set perTransaction limit up to a maximum amount (The maximum amount is part of account setting)." }, "interval": { "type": "string", "description": "Transaction limit interval. This field is mandatory and must be one of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." } } } } } } } }, "brand": { "type": "string", "description": "Scheme for Issuance. Default `VISA`." }, "cardholder_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the cardholder to associate this card with." }, "client_data": { "type": "string", "description": "Client data which will be stored against the card record in Airwallex." }, "created_by": { "type": "string", "description": "Full legal name of user requesting new card." }, "delivery_details": { "type": "object", "description": "Delivery detail of the card. Only available for physical cards.", "properties": { "mobile_number": { "type": "string", "description": "Optional mobile number for physical card delivery in E.164 format (e.g., +6512345678). Defaults to the cardholder's registered number if not provided. Required for EXPRESS delivery or when the destination country is China." }, "preferred_delivery_mode": { "type": "string", "description": "Customizable options that customers can specify for physical card delivery. The requested delivery mode will be provided on a best-effort basis. `MAIL`: Delivery of the card is delivered via mail shipment. `EXPRESS`: Delivery of the card is tracked and delivered via express shipment." } } }, "form_factor": { "type": "string", "description": "Form of the card - `PHYSICAL` or `VIRTUAL`." }, "funding_source_id": { "type": "string", "format": "uuid", "description": "A unique identifier that links a card to its designated funding source. This unique identifier determines which funding source will be accessed for the deduction of funds during transactions. The `funding_source_id` can be retrieved from the client's account manager. If `funding_source_id` is not provided, the default funding source would be the account's wallet." }, "is_personalized": { "type": "boolean", "description": "Determines whether the card should be assigned to a singular individual or to the business with multiple cardholders who are authorized to use the card. Note - only personalized cards can be created as physical and added to digital wallet providers." }, "metadata": { "type": "object", "description": "A set of key-value pairs that can be attached to the Card. You can specify up to 20 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "nick_name": { "type": "string", "description": "A nick name for the card." }, "note": { "type": "string", "description": "Notes that are to be stored against the card request (for client reference)." }, "postal_address": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "description": "Optional postal address of physical card delivery. The card will be issued to the cardholder's postal address if this value is not set. The cardholder's address will be used instead if cardholder's postal address does not exist.", "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } } }, "program": { "type": "object", "required": [ "purpose" ], "description": "Card program.", "properties": { "bin": { "type": "string", "pattern": "^\\d{6}(\\d{2})?$", "description": "Optional 6- or 8-digit network BIN. If provided, the requested BIN is used only if it is active, mapped to your program, and compatible with the card. Otherwise, the request is rejected with an `ineligible_bin` error. If omitted, Airwallex selects an eligible BIN automatically. Values that are not 6 or 8 digits return `invalid_bin_format`. This field is available only to accounts enabled for BIN selection. Contact your Airwallex Account Manager to request access." }, "interchange_percent": { "type": "string", "description": "Interchange percent of the card - This is only available for `sub_type=\"B2B_TRAVEL\"` cards. Interchange can vary from 0.8 to 1.9, with increments of 0.1." }, "purpose": { "type": "string", "description": "`COMMERCIAL`: A card used for business purposes backed by funding belonging to a business. \n`CONSUMER`: A card used for personal purposes backed by funding belonging to an individual." }, "sub_type": { "type": "string", "description": "Sub type of the program - This is used for specific products under the defined program types. e.g `B2B_TRAVEL` which designates BINs for travel use cases (E.g OTAs)." }, "type": { "type": "string", "description": "Card type - `PREPAID`, `DEBIT`, `CREDIT` or `DEFERRED_DEBIT`. `DEFERRED_DEBIT` is Deferred Debit card available for OTA (Online Travel Agent) customers only in UK/Europe countries. If card type is not set, the default card type which is a part of your account setting will be used." } } }, "purpose": { "type": "string", "description": "Optional purpose for card's usage when card `issueTo` is `ORGANISATION`. Can be one of - `BUSINESS_EXPENSES`, `CLIENT_EXPENSES`, `MARKETING_EXPENSES`, `OFFICE_SUPPLIES`, `ONLINE_PURCHASING`, `OTHER`, `SUBSCRIPTIONS`, `TEAM_EXPENSES`, `TRAVEL_EXPENSES`. Default value is `BUSINESS_EXPENSES`." }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client. Requests with the same request_id will be ignored. This allows requests to be replayed if client is unsure of the outcome, e.g. due to network issues, system failures, etc. Note: Can be non-UUID as long as it is unique between requests." } } }, "examples": { "default": { "value": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "VISA", "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_by": "John Smith", "delivery_details": { "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "metadata": { "key1": "value1", "key2": "value2" }, "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } }, "description": "newCardRequest.", "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCard" }, "examples": { "default": { "value": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n,\"invalid_bin_format\"\n,\"ineligible_bin\"\n,\"invalid_card_profile\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cards/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "VISA", "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_by": "John Smith", "delivery_details": { "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "metadata": { "key1": "value1", "key2": "value2" }, "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "response_body": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } ], "x-scope": [ { "scope": "issuing.card:write", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards": { "get": { "tags": [ "Issuing > Cards" ], "summary": "3|List all Cards", "description": "Get cards issued under an account. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated.", "operationId": "listCards", "parameters": [ { "name": "card_status", "in": "query", "description": "Current card status \nOne of `PENDING`, `FAILED`, `INACTIVE`, `ACTIVE`, `LOST`, `STOLEN`, `CLOSED`, `BLOCKED`, `EXPIRED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "PENDING", "FAILED", "INACTIVE", "ACTIVE", "LOST", "STOLEN", "CLOSED", "BLOCKED", "EXPIRED", "UNKNOWN" ], "default": "PENDING" } }, { "name": "cardholder_id", "in": "query", "description": "The id of the cardholder for the card, if it is an employee card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid", "default": "7f0216e7-0348-4a36-9871-d1ba82c13410" } }, { "name": "from_created_at", "in": "query", "description": "Created_from_date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2018-10-01T00:00:00+0000" } }, { "name": "from_updated_at", "in": "query", "description": "Updated_from_date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2023-12-30T00:00:00+0000" } }, { "name": "nick_name", "in": "query", "description": "Will be used to return cards whose nickname exactly matches the value of this field.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "Travel" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page, between 10 and 200. The default is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "Created_to_date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2018-10-31T00:00:00+0000" } }, { "name": "to_updated_at", "in": "query", "description": "Updated_to_date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2023-12-31T00:00:00+0000" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "items" ], "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciCardSummary" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "additional_cardholder_ids": [ "7f0216e7-0348-4a36-9871-d1ba82c13410", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "created_at": "2018-10-31T00:00:00+0000", "nick_name": "Travel", "updated_at": "2024-01-09T00:00:00+0000" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cards", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "additional_cardholder_ids": [ "7f0216e7-0348-4a36-9871-d1ba82c13410", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "created_at": "2018-10-31T00:00:00+0000", "nick_name": "Travel", "updated_at": "2024-01-09T00:00:00+0000" } ] } } ], "x-scope": [ { "scope": "issuing.card:read", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}/details": { "get": { "tags": [ "Issuing > Cards" ], "summary": "7|List all Sensitive Card Details", "description": "Get sensitive card information for virtual cards. This endpoint will only return data for active cards.", "operationId": "listDetails", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "default": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "examples": { "default": { "value": "card_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciCardPci" }, "examples": { "default": { "value": { "card_number": "4111111111111111", "cvv": "123", "expiry_month": 1, "expiry_year": 2022, "name_on_card": "John Smith" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciError" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cards/card_id/details", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "card_number": "4111111111111111", "cvv": "123", "expiry_month": 1, "expiry_year": 2022, "name_on_card": "John Smith" } } ], "x-scope": [ { "scope": "issuing.card:read", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}/limits": { "get": { "tags": [ "Issuing > Cards" ], "summary": "8|List all Card Remaining Limits", "description": "Retrieve remaining limits of a card.", "operationId": "listLimits", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "card_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciRemainingLimits" }, "examples": { "default": { "value": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION", "remaining": 1000 } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION", "remaining": 1000 } ] } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cards/card_id/limits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION", "remaining": 1000 } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION", "remaining": 1000 } ] } } ], "x-scope": [ { "scope": "issuing.card:read", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}/provision_digital_token": { "post": { "tags": [ "Issuing > Cards" ], "summary": "6|Provision a Card to a Digital Wallet", "description": "Provisions a card into a digital wallet for in-app (push) provisioning. Available only to accounts with white-label digital wallets enabled.\n\nThe request body is wallet-specific and selected by the `type` field. The interactive form shows a single body shape, so the per-type request bodies are documented here:\n\n**`apple_pay`** (Apple Wallet / PassKit provisioning):\n- `device_certs` (array): device certificate chain, leaf certificate first\n- `nonce_signature` (string): signature over the nonce\n- `nonce` (string): one-time nonce\n\n**`google_pay`** (Google Pay provisioning):\n- `device_id` (string): stable device identifier from the Google Pay SDK\n- `client_customer_id` (string): wallet account holder identifier\n\n**`samsung_pay`** (Samsung Pay provisioning):\n- `device_id` (string): stable device identifier from the Samsung Pay SDK\n- `client_customer_id` (string): wallet account holder identifier.", "operationId": "provisionDigitalToken", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "default": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "examples": { "default": { "value": "card_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Digital wallet type.", "enum": [ "apple_pay", "google_pay", "samsung_pay" ] }, "device_certs": { "type": "array", "description": "Required when `type` is `apple_pay`. Device certificate chain from the Apple Wallet (PassKit) provisioning request, leaf certificate first.", "items": { "type": "string" } }, "nonce": { "type": "string", "description": "Required when `type` is `apple_pay`. One-time nonce supplied by Apple PassKit." }, "nonce_signature": { "type": "string", "description": "Required when `type` is `apple_pay`. Signature over the nonce, supplied by Apple PassKit." }, "client_customer_id": { "type": "string", "description": "Required when `type` is `google_pay` or `samsung_pay`. Identifier for the wallet account holder, provided by the wallet SDK." }, "device_id": { "type": "string", "description": "Required when `type` is `google_pay` or `samsung_pay`. Stable device identifier provided by the wallet SDK." }, "server_session_id": { "type": "string", "description": "Optional. Used for push provisioning with Google Pay." } } }, "examples": { "default": { "value": { "type": "apple_pay", "device_certs": [], "nonce": "", "nonce_signature": "" } } } } }, "description": "provisionDigitalTokenRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciApiProvisioning" }, "examples": { "default": { "value": { "card_id": "", "activation_data": "", "encrypted_pass_data": "", "ephemeral_public_key": "" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciError" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cards/card_id/provision_digital_token", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "apple_pay", "device_certs": [], "nonce": "", "nonce_signature": "" }, "response_body": { "card_id": "", "activation_data": "", "encrypted_pass_data": "", "ephemeral_public_key": "" } } ], "x-scope": [ { "scope": "issuing.card:write", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}": { "get": { "tags": [ "Issuing > Cards" ], "summary": "2|Retrieve a Card", "description": "Retrieve Card details.", "operationId": "retrieveCard", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "card_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCard" }, "examples": { "default": { "value": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/cards/card_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "allowed_transaction_count": "SINGLE", "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } ], "x-scope": [ { "scope": "issuing.card:read", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/cards/{id}/update": { "post": { "tags": [ "Issuing > Cards" ], "summary": "4|Update a Card", "description": "Updates card details by setting the values of the included parameters. Parameters that are not included will be left unchanged.", "operationId": "updateCard", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the card.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "card_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "additional_cardholder_ids": { "type": "array", "description": "The IDs of additional cardholders to associate this card with. Only valid if `is_personalized` is `false`.", "items": { "type": "string", "format": "uuid" } }, "alert_settings": { "type": "object", "description": "Contains alert configuration settings for the card.", "properties": { "low_remaining_transaction_limit": { "type": "object", "required": [ "enabled", "percent" ], "description": "Configures an alert for when the remaining spending limit dips below a specified percentage. When enabled, a webhook notification will be triggered if the remaining limit falls below the defined threshold. Note that:\n\n- Only one notification per spend limit interval will be sent. A webhook is triggered only when the threshold is crossed, and further spending below the threshold will not trigger additional notifications. Example: if the percent enabled is 10, a webhook will be sent once the remaining limit is at or less than 10%.\n- If the spend limit has been updated, a new notification will be sent when the new threshold is crossed.\n- This alert only applies to multiple use cards.\n- If not specified, this setting will be enabled by default with ``enabled`` set to ``true`` and ``percent`` set to an account specific default value.", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether the alert is active." }, "percent": { "type": "integer", "format": "int32", "description": "Specifies the percentage threshold for the alert." } } } } }, "authorization_controls": { "type": "object", "description": "Spend controls that determine the rules and restrictions to check for transaction authorizations.", "properties": { "active_from": { "type": "string", "description": "If not provided, current value will be maintained. If provided, authorizations prior to this time will be rejected." }, "active_to": { "type": "string", "description": "If not provided, current value will be maintained. If provided, authorizations after this time will be rejected." }, "allowed_currencies": { "type": "array", "description": "Allowed Currencies for transactions.", "items": { "type": "string" } }, "allowed_merchant_brands": { "type": "object", "description": "Allowed Merchant Brands rules for transactions. Please note if this field is absent from request payload, then transactions from all merchant brands will be allowed.", "properties": { "categories": { "type": "array", "description": "Allowed Merchant Brands Categories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand categories will be allowed.", "items": { "type": "string" } }, "ids": { "type": "array", "description": "Allowed Merchant Brand identifiers for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand ids will be allowed. You can search for Merchant Brands ids using the [Merchant Brands API](/docs/api/issuing/merchant_brands/retrieve).", "items": { "type": "string", "format": "uuid" } }, "subcategories": { "type": "array", "description": "Allowed Merchant Brands Subcategories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand subcategories will be allowed.", "items": { "type": "string" } } } }, "allowed_merchant_categories": { "type": "array", "description": "Allowed Merchant Category Codes. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then all merchant categories will be allowed. Default value is `[]`.", "items": { "type": "string" } }, "allowed_merchant_countries": { "type": "array", "description": "Allowed Merchant Countries for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant countries will be allowed (although some may still be blocked by our risk team).", "items": { "type": "string" } }, "blocked_transaction_usages": { "type": "array", "description": "List of disabled transaction usages, based on transaction_scope and usage_scope values. You can add multiple transaction_scope and usage_scope values. The most restrictive scope(s) would apply.", "items": { "type": "object", "properties": { "transaction_scope": { "type": "string", "description": "Types of transaction scope. It can be one of: `ALL_TRANSACTIONS`, `ONLINE_TRANSACTION`, `CONTACTLESS_TRANSACTION`, `CONTACT_CHIP_TRANSACTION`, `MAGSTRIPE`, `CASH_WITHDRAWAL`, `BILL_PAYMENT`, `ACCOUNT_FUNDING`." }, "usage_scope": { "type": "string", "description": "Determines if a transaction can be made domestically and/or internationally. It can be one of: `ALL`, `INTERNATIONAL`, `DOMESTIC`." } } } }, "transaction_limits": { "type": "object", "required": [ "cash_withdrawal_limits", "limits" ], "description": "Transaction limits for the card. Multiple transaction limits can be configured based on single currency. Each transaction will be checked against the limits with interval after currency conversion rate applied.", "properties": { "cash_withdrawal_limits": { "type": "array", "description": "Cash withdrawal transaction limits are based on interval and amount. \n \nIf the daily limit is not set, the default daily limit amount for the selected limit currency will be used. The default daily limit amount is part of the account setting. To change the default daily limit amount, please reach out to your account manager. \n \nPlease note that the cash withdrawal transaction limits apply exclusively to cash withdrawals and are imposed to help manage potential liability for the account holder and for Airwallex. The account holder may be liable for any unauthorised spending on the card, so please apply the limits responsibly. \n \n**Important**: This limit will only appear if you have cash withdrawals enabled. Please speak to your account manager if you would like to enable cash withdrawals.", "items": { "type": "object", "required": [ "amount", "interval" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount. This field is mandatory and must be greater than 0. Customer can set perTransaction limit up to a maximum amount (The maximum amount is part of account setting)." }, "interval": { "type": "string", "description": "Transaction limit interval. This field is mandatory and must be one of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." } } } }, "currency": { "type": "string", "description": "Currency for transaction limits (3-letter ISO-4217 code). Will keep current one if not provided." }, "limits": { "type": "array", "description": "Transaction limits are based on interval and amount. \n \nIf the per transaction limit is not set, the default per transaction limit amount for the selected limit currency will be used. The default per transaction amount is part of account settings. To change the default per transaction limit, please reach out to your account manager. \n \nThe account holder may be liable for any unauthorised spending on the card, so please apply limits responsibly.", "items": { "type": "object", "required": [ "amount", "interval" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount. This field is mandatory and must be greater than 0. Customer can set perTransaction limit up to a maximum amount (The maximum amount is part of account setting)." }, "interval": { "type": "string", "description": "Transaction limit interval. This field is mandatory and must be one of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." } } } } } } } }, "auto_close_date": { "type": "string", "format": "date", "description": "If provided, the card is automatically closed at the start of the specified day (00:00 GMT). The date must be in the format YYYY-MM-DD and must be at least 1 day and no more than 5 years after the update request is made. Set the field to null to clear the scheduled closure. If not provided, the current value is maintained." }, "card_status": { "type": "string", "description": "Card status, Allowed values are `INACTIVE`, `ACTIVE`, `CLOSED`." }, "cardholder_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the cardholder to associate this card with." }, "metadata": { "type": "object", "description": "A set of key-value pairs that can be attached to the Card. You can specify up to 20 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "nick_name": { "type": "string", "description": "A nick name for the card." }, "purpose": { "type": "string", "description": "Optional purpose for card's usage when card `issueTo` value is `ORGANISATION`. Can be one of - `BUSINESS_EXPENSES`, `CLIENT_EXPENSES`, `MARKETING_EXPENSES`, `OFFICE_SUPPLIES`, `ONLINE_PURCHASING`, `OTHER`, `SUBSCRIPTIONS`, `TEAM_EXPENSES`, `TRAVEL_EXPENSES`. Default value is `BUSINESS_EXPENSES`." } } }, "examples": { "default": { "value": { "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "card_status": "INACTIVE", "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "metadata": { "key1": "value1", "key2": "value2" }, "nick_name": "travelling", "purpose": "" } } } } }, "description": "cardUpdateRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciCard" }, "examples": { "default": { "value": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_categories": [ "7531", "7534" ], "allowed_transaction_count": "SINGLE", "allowed_merchant_countries": [ "US", "AU" ], "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/cards/card_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_brands": { "categories": [ "10000", "16000" ], "ids": [ "245e5003-58ec-540c-89a0-e148e54c2518" ], "subcategories": [ "10001", "16003" ] }, "allowed_merchant_categories": [ "7531", "7534" ], "allowed_merchant_countries": [ "US", "AU" ], "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "card_status": "INACTIVE", "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "metadata": { "key1": "value1", "key2": "value2" }, "nick_name": "travelling", "purpose": "" }, "response_body": { "activate_on_issue": false, "additional_cardholder_ids": [ "7f687fe6-dcf4-4462-92fa-80335301d9d2", "b0a1b145-4853-4456-b4b3-d690c7f3535c" ], "auto_close_date": "2027-01-31", "alert_settings": { "low_remaining_transaction_limit": { "enabled": false, "percent": 10 } }, "all_card_versions": [ { "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "created_at": "2024-01-09T00:00:00+0000" } ], "authorization_controls": { "active_from": "2018-10-31T00:00:00+0000", "active_to": "2018-10-31T00:00:00+0000", "allowed_currencies": [ "USD", "AUD" ], "allowed_merchant_categories": [ "7531", "7534" ], "allowed_transaction_count": "SINGLE", "allowed_merchant_countries": [ "US", "AU" ], "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "transaction_limits": { "cash_withdrawal_limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ], "currency": "USD", "limits": [ { "amount": 1000, "interval": "PER_TRANSACTION" } ] } }, "brand": "visa", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "************4111", "card_status": "ACTIVE", "card_version": 1, "cardholder_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "20190817_dfelsflkj73494lksdfg9480ww", "created_at": "2024-01-09T00:00:00+0000", "created_by": "", "delivery_details": { "delivery_mode": "MAIL", "delivery_vendor": "DHL", "mobile_number": "+6512345678", "preferred_delivery_mode": "MAIL", "status": "DISPATCHED", "status_description": "The card has been printed.", "tracked": true, "tracking_link": "https://www.dhl.com/global-en/home/tracking/tracking-parcel.html?submit=1&tracking-id=ABCD1234", "tracking_number": "ABCD1234", "updated_at": "2024-01-09T00:00:00+0000" }, "form_factor": "VIRTUAL", "funding_source_id": "6682111f-cb4a-47ce-8e95-5abcc5394727", "is_personalized": true, "issue_to": "ORGANISATION", "metadata": { "key1": "value1", "key2": "value2" }, "name_on_card": "John Smith", "nick_name": "travelling", "note": "This is my first card.", "postal_address": { "city": "Melbourne", "country": "AU", "line1": "44 Gillespie St", "line2": "Unit 2", "postcode": "3121", "state": "VIC" }, "primary_contact_details": { "email": "john@example.com", "full_name": "John Smith", "mobile_number": "619922334321" }, "program": { "interchange_percent": "1.0", "purpose": "COMMERCIAL", "sub_type": "GOOD_FUNDS_CREDIT", "type": "PREPAID" }, "purpose": "BUSINESS_EXPENSES", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "updated_at": "2024-01-09T00:00:00+0000" } } ], "x-scope": [ { "scope": "issuing.card:write", "group": "Issuing", "resource_name": "Cards", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/config": { "get": { "tags": [ "Issuing > Config" ], "summary": "1|Retrieve the Issuing Config", "description": "Retrieves the default issuing settings configured for your account.", "operationId": "listConfig", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciIssuingSetting" }, "examples": { "default": { "value": { "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth_settings": { "created_at": "2018-03-22T16:08:02+00:00", "default_action": "DECLINED", "enabled": true, "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "updated_at": "2018-03-22T16:08:02+00:00", "url": "https://your.domain/remote-auth" }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true }, "spending_limit_settings": { "per_transaction_limits": [ { "currency": "AUD", "default": 1000, "maximum": 1000 } ] } } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/config", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth_settings": { "created_at": "2018-03-22T16:08:02+00:00", "default_action": "DECLINED", "enabled": true, "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "updated_at": "2018-03-22T16:08:02+00:00", "url": "https://your.domain/remote-auth" }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true }, "spending_limit_settings": { "per_transaction_limits": [ { "currency": "AUD", "default": 1000, "maximum": 1000 } ] } } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.config:read", "group": "Issuing", "resource_name": "Config", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/config/update": { "post": { "tags": [ "Issuing > Config" ], "summary": "2|Update the Issuing Config", "description": "Update issuing config (currently only support remote call config update).", "operationId": "updateConfig", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enable_auto_conversion": { "type": "boolean", "description": "Whether auto currency conversion is enabled." }, "primary_currency": { "type": "string", "description": "The designated primary currency used as the funding source for auto currency conversion." }, "remote_auth": { "type": "object", "description": "Remote authorization config. Please read the [remote auth product documentation](/docs/issuing/card-controls/remote-authorization) for more information. You will need to reach out to our support team to enable this feature for you.", "properties": { "default_action": { "type": "string", "description": "Default action when remote auth failed - `AUTHORIZED` or `DECLINED`." }, "enabled": { "type": "boolean", "description": "Remote auth feature enabled flag." }, "new_shared_secret": { "type": "boolean", "description": "Should create a new shared secret for remote auth." }, "url": { "type": "string", "description": "The url for your remote auth endpoint, this is a mandatory field when you init your remote auth config." }, "version": { "type": "integer", "format": "int32", "description": "Specifies the remote auth payload version (1 or 2). Defaults to 2 on creation. If omitted during updates, the existing value is retained." } } }, "remote_call_config": { "type": "object", "description": "Remote call config. You will need to reach out to our support team to enable this feature for you.", "properties": { "methods": { "type": "array", "description": "Individual remote call method configs.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the method being configured." }, "path": { "type": "string", "description": "Path that will be combined with url for remote calls." } } } }, "shared_secret": { "type": "string", "description": "Shared secret to verify remote call requests. Please note this field only return once when you init remote call config or request a new secret in the update request, get issuing setting always return null.", "readOnly": true }, "url": { "type": "string", "description": "The base url for remote calls, which will be combined with the path supplied for individual methods." } } }, "remote_provisioning_config": { "type": "object", "description": "Remote provisioning config. You will need to reach out to our support team to enable this feature for you.", "properties": { "default_action": { "type": "string", "description": "Default action when remote provisioning attempt fails.", "enum": [ "UNKNOWN", "CONDITIONAL_APPROVAL", "GENERIC_DECLINE" ] }, "enabled": { "type": "boolean", "description": "Remote Provisioning config enabled flag, Airwallex will start sending remote provisioning requests to your endpoint once this flag is enabled." } } } } }, "examples": { "default": { "value": { "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth": { "default_action": "DECLINED", "enabled": true, "new_shared_secret": true, "url": "https://your.domain/remote-auth", "version": 2 }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true } } } } } }, "description": "issuingConfigUpdateRequestDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciIssuingSetting" }, "examples": { "default": { "value": { "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth_settings": { "created_at": "2018-03-22T16:08:02+00:00", "default_action": "DECLINED", "enabled": true, "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "updated_at": "2018-03-22T16:08:02+00:00", "url": "https://your.domain/remote-auth" }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true }, "spending_limit_settings": { "per_transaction_limits": [ { "currency": "AUD", "default": 1000, "maximum": 1000 } ] } } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/config/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth": { "default_action": "DECLINED", "enabled": true, "new_shared_secret": true, "url": "https://your.domain/remote-auth", "version": 2 }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true } }, "response_body": { "blocked_transaction_usages": [ { "transaction_scope": "MAGSTRIPE", "usage_scope": "INTERNATIONAL" }, { "transaction_scope": "ONLINE_TRANSACTION", "usage_scope": "ALL" } ], "enable_auto_conversion": true, "primary_currency": "USD", "remote_auth_settings": { "created_at": "2018-03-22T16:08:02+00:00", "default_action": "DECLINED", "enabled": true, "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "updated_at": "2018-03-22T16:08:02+00:00", "url": "https://your.domain/remote-auth" }, "remote_call_config": { "methods": [ { "name": "Echo", "path": "/echo" } ], "shared_secret": "50qJEcIBT36Fg5DU1pxV1HSAcTPDA8etZnb5fYObi70BcCT52q19PFxyfkXd", "url": "https://your.domain" }, "remote_provisioning_config": { "default_action": "UNKNOWN", "enabled": true }, "spending_limit_settings": { "per_transaction_limits": [ { "currency": "AUD", "default": 1000, "maximum": 1000 } ] } } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.config:write", "group": "Issuing", "resource_name": "Config", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/digital_wallet_tokens/{id}/lifecycle": { "post": { "tags": [ "Issuing > Digital Wallet Tokens" ], "summary": "3|Update the Digital Wallet Token Status", "description": "Only available to platforms running their own white-labelled card program. Changes a digital wallet token's status - suspend, resume, delete, or activate via call centre verification (see `operation_type` below). Applied asynchronously: Airwallex accepts the request immediately, then confirms the status change with the card network. Airwallex performs cardholder ID&V for call centre verification, before applying the change.", "operationId": "lifecycle", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the digital wallet token.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "digital_wallet_token_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "operation_type" ], "properties": { "activation_code": { "type": "string", "description": "Required when `operation_type` is `CALL_CENTER_ACTIVATION` and ignored for all other operations. A reference of up to 8 characters, captured when the cardholder's identity is verified by the Airwallex call center, that serves as a record that the activation was approved through that process. It is not validated and does not affect the outcome of the request.", "maxLength": 8 }, "operation_reason": { "type": "string", "description": "Optional free-text reason for the operation, recorded for audit purposes. For example, 'Suspended due to lost device'." }, "operation_type": { "type": "string", "description": "The operation to perform on the token.", "enum": [ "DELETE", "SUSPEND", "RESUME", "CALL_CENTER_ACTIVATION" ], "x-enumDescriptions": { "DELETE": "Permanently deactivate the token. Its status becomes `DEACTIVATED`. This cannot be undone, and the card must be provisioned again to create a new token.", "SUSPEND": "Temporarily block the token. Its status becomes `SUSPENDED` and the token cannot be used until it is resumed.", "RESUME": "Reactivate a suspended token. Its status returns to `ACTIVE`.", "CALL_CENTER_ACTIVATION": "Activate a token after the cardholder's identity has been verified by the Airwallex call center. Its status becomes `ACTIVE`. This operation requires `activation_code`." } } } }, "examples": { "default": { "value": { "activation_code": "", "operation_reason": "", "operation_type": "DELETE" } } } } }, "description": "request.", "required": true }, "responses": { "202": { "description": "Accepted. The request has been validated and queued. The token's status is updated asynchronously once the change is confirmed with the card network. No response body is returned." }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PciError" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-oauthSupported": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/digital_wallet_tokens/digital_wallet_token_id/lifecycle", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "request_body": { "activation_code": "", "operation_reason": "", "operation_type": "DELETE" } } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/digital_wallet_tokens": { "get": { "tags": [ "Issuing > Digital Wallet Tokens" ], "summary": "2|List all Digital Wallet Tokens", "description": "Get digital wallet tokens created under an account. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated.", "operationId": "listDigitalWalletTokens", "parameters": [ { "name": "card_id", "in": "query", "description": "Id of the card associated with the token.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "cardholder_id", "in": "query", "description": "Id of the cardholder associated with the token.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "Include tokens created after from_created_at (inclusive) in ISO8601 format.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "from_token_expires_on", "in": "query", "description": "Include tokens that expire after from_token_expires_on (inclusive) in format MMyy.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_created_at", "in": "query", "description": "Include tokens created before to_created_at (inclusive) in ISO8601 format.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_token_expires_on", "in": "query", "description": "Include tokens that expire before to_token_expires_on (inclusive) in format MMyy.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "token_reference_id", "in": "query", "description": "Unique identifier of the digital wallet token within the card network.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "token_statuses", "in": "query", "description": "Token statuses \nOne or more of `ACTIVE`, `INACTIVE`, `SUSPENDED`, `DEACTIVATED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "token_types", "in": "query", "description": "Token types \nOne or more of `SECURE_ELEMENT`, `HCE`, `CARD_ON_FILE`, `ECOMMERCE`, `QRC`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "items" ], "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciDigitalWalletToken" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "create_time": "2018-03-22T16:08:02+00:00", "device_information": { "device_id": "dSWbu2jPr9uRNe5UQolbeOxz", "device_type": "MOBILE_PHONE" }, "expiry_month": 1, "expiry_year": 2022, "masked_card_number": "************4242", "pan_reference_id": "V-5822325012766949099915", "risk_information": { "wallet_provider_account_score": "5", "wallet_provider_device_score": "5" }, "token_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "token_reference_id": "DNITHE301616178439057312", "token_status": "ACTIVE", "token_type": "CARD_ON_FILE" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/digital_wallet_tokens", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "create_time": "2018-03-22T16:08:02+00:00", "device_information": { "device_id": "dSWbu2jPr9uRNe5UQolbeOxz", "device_type": "MOBILE_PHONE" }, "expiry_month": 1, "expiry_year": 2022, "masked_card_number": "************4242", "pan_reference_id": "V-5822325012766949099915", "risk_information": { "wallet_provider_account_score": "5", "wallet_provider_device_score": "5" }, "token_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "token_reference_id": "DNITHE301616178439057312", "token_status": "ACTIVE", "token_type": "CARD_ON_FILE" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.digital_wallet_token:read", "group": "Issuing", "resource_name": "Digital Wallet Tokens", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/digital_wallet_tokens/{id}": { "get": { "tags": [ "Issuing > Digital Wallet Tokens" ], "summary": "1|Retrieve a Digital Wallet Token", "description": "Retrieves details of a digital wallet token for a given token ID.", "operationId": "retrieveDigitalWalletToken", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the digital wallet token.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "digital_wallet_token_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciDigitalWalletToken" }, "examples": { "default": { "value": { "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "create_time": "2018-03-22T16:08:02+00:00", "device_information": { "device_id": "dSWbu2jPr9uRNe5UQolbeOxz", "device_type": "MOBILE_PHONE" }, "expiry_month": 1, "expiry_year": 2022, "masked_card_number": "************4242", "pan_reference_id": "V-5822325012766949099915", "risk_information": { "wallet_provider_account_score": "5", "wallet_provider_device_score": "5" }, "token_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "token_reference_id": "DNITHE301616178439057312", "token_status": "ACTIVE", "token_type": "CARD_ON_FILE" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/digital_wallet_tokens/digital_wallet_token_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "card_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "cardholder_id": "7f0216e7-0348-4a36-9871-d1ba82c13410", "create_time": "2018-03-22T16:08:02+00:00", "device_information": { "device_id": "dSWbu2jPr9uRNe5UQolbeOxz", "device_type": "MOBILE_PHONE" }, "expiry_month": 1, "expiry_year": 2022, "masked_card_number": "************4242", "pan_reference_id": "V-5822325012766949099915", "risk_information": { "wallet_provider_account_score": "5", "wallet_provider_device_score": "5" }, "token_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "token_reference_id": "DNITHE301616178439057312", "token_status": "ACTIVE", "token_type": "CARD_ON_FILE" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.digital_wallet_token:read", "group": "Issuing", "resource_name": "Digital Wallet Tokens", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/merchant_brands": { "get": { "tags": [ "Issuing > Merchant Brands" ], "summary": "2|List all Merchant Brands", "description": "Retrieve all Merchant Brands matching (by prefix) the name provided. If no name is provided, all Merchant Brands will be returned in alphabetical order.", "operationId": "listMerchantBrands", "parameters": [ { "name": "name", "in": "query", "description": "Merchant brand name to filter results.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page marker used to retrieve the previous or next page of results. Set this field to the value returned by `page_before` or `page_after` to retrieve the previous or next page, respectively.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "0" } }, { "name": "page_size", "in": "query", "description": "The number of items to return per page. Defaults to 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciBookmarkedResultOfIssuingNonPciMerchantBrand" }, "examples": { "default": { "value": { "items": [ { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "logo_url": "https://example.com/logo.png", "name": "Awesome Company" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/merchant_brands", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "logo_url": "https://example.com/logo.png", "name": "Awesome Company" } ], "page_after": "YWZ0ZXI9MmFjNmEzMjQtM2IwNC00M2JkLThmNTUtOWQ5YzdmZjEzZGZm", "page_before": "YmVmb3JlPWVmZDQxZTk3LTU2MzctNDQ5MC04NjNkLTU2MDE5MjIwNDQ2YQ==" } } ], "x-scope": [ { "scope": "issuing.merchant_brand:read", "group": "Issuing", "resource_name": "Merchant Brands", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/merchant_brands/{id}": { "get": { "tags": [ "Issuing > Merchant Brands" ], "summary": "1|Retrieve a Merchant Brand", "description": "Retrieve a single merchant brand by its unique identifier.", "operationId": "retrieveMerchantBrand", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for the Merchant Brand.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "merchant_brand_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciMerchantBrand" }, "examples": { "default": { "value": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "logo_url": "https://example.com/logo.png", "name": "Awesome Company" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/merchant_brands/merchant_brand_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "logo_url": "https://example.com/logo.png", "name": "Awesome Company" } } ], "x-scope": [ { "scope": "issuing.merchant_brand:read", "group": "Issuing", "resource_name": "Merchant Brands", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes/{id}/cancel": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "6|Cancel a Transaction Dispute", "description": "When a dispute status = SUBMITTED, the dispute can still be canceled via this API. Once the dispute status changes to IN_PROGRESS, the dispute is submitted to the card scheme by Airwallex and cannot be canceled. Relevant dispute fees may apply once the dispute status = IN_PROGRESS.", "operationId": "transactionDisputes_cancel", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for this dispute.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0" }, "examples": { "default": { "value": "transaction_dispute_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionDispute" }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/transaction_disputes/transaction_dispute_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:write", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes/create": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "1|Create a Transaction Dispute", "description": "Creates a dispute for a card transaction in a draft status. The dispute can be updated multiple times before submission to Airwallex for assessment. The transaction dispute object is the resource of a card transaction dispute raised to Airwallex.It contains all the information related to a dispute such as amount, status and update history.", "operationId": "createTransactionDispute", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "card_transaction_event_id" ], "properties": { "additional_info": { "type": "object", "description": "Additional information for the dispute.", "properties": { "actual_delivery_date": { "type": "string", "description": "The date on which the cardholder actually received the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "attempted_return_date": { "type": "string", "description": "The date on which the cardholder attempted to return the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "card_charge_permission_withdrawn_date": { "type": "string", "description": "The date on which the cardholder withdrew permission for the card charge (e.g. cancelled a subscription or recurring payment). Strongly recommended to set this field when dispute reason is RECURRING_CANCELED." }, "expected_delivery_date": { "type": "string", "description": "The date by which the cardholder expected to receive the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_RECEIVED or GOODS_SERVICE_CANCELED." }, "order_cancellation_date": { "type": "string", "description": "The date on which the goods, service, or reservation was cancelled. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_CANCELED." }, "returned_date": { "type": "string", "description": "The date on which the cardholder returned the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." } } }, "amount": { "type": "number", "description": "The amount to be disputed. If not specified, the dispute will take the billing amount as the dispute amount. If specified, the specified amount is used as the dispute amount for partial dispute. The specified amount cannot be larger than the billing amount. Note: The dispute currency is always in the billing currency of the transaction." }, "card_transaction_event_id": { "type": "string", "format": "uuid", "description": "The unique identifier for the card transaction event to be disputed." }, "evidence_files": { "type": "array", "description": "A list of file id that contains the evidence for the dispute. The file id can be retrieved after uploading the supporting document via [POST Upload a file](/docs/api/supporting_services/file_service/upload_files).", "items": { "type": "string" } }, "notes": { "type": "string", "description": "The explanation on why the cardholder is disputing the transaction can be provided here." }, "reason": { "type": "string", "description": "The reason for raising the dispute. It can be one of: `SUSPECTED_FRAUD`, `UNAUTHORIZED_TRANSACTION`, `DUPLICATED_TRANSACTION`, `PAID_BY_OTHER_MEANS`, `GOODS_SERVICE_NOT_AS_DESCRIBED`, `GOODS_DAMAGED`, `GOODS_SERVICE_NOT_RECEVIED`, `REFUND_UNPROCESSED`, `GOODS_SERVICE_CANCELED`, `RECURRING_CANCELED`, `OTHER`. Learn more about the [dispute reasons](/docs/issuing/transactions/handle-transaction-disputes#dispute-reasons).", "enum": [ "SUSPECTED_FRAUD", "UNAUTHORIZED_TRANSACTION", "DUPLICATED_TRANSACTION", "PAID_BY_OTHER_MEANS", "GOODS_SERVICE_NOT_AS_DESCRIBED", "GOODS_DAMAGED", "GOODS_SERVICE_NOT_RECEIVED", "REFUND_UNPROCESSED", "GOODS_SERVICE_CANCELED", "RECURRING_CANCELED", "OTHER" ] }, "reference": { "type": "string", "description": "A value can be added for your internal reference. Maximum 20 characters." } } }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2" } } } } }, "description": "request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionDispute" }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/transaction_disputes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2" }, "response_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:write", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes": { "get": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "3|List all Transaction Disputes", "description": "Retrieve all transaction disputes. Filter for results using the parameters available.", "operationId": "listTransactionDisputes", "parameters": [ { "name": "card_transaction_event_id", "in": "query", "description": "The unique identifier for the disputed card transaction event.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "card_transaction_id", "in": "query", "description": "The unique identifier for the disputed card transaction.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "detailed_status", "in": "query", "description": "The detailed status of the dispute life cycle between Airwallex and the card scheme.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "DISPUTE_FILED", "PRE_ARB_RECEIVED", "PRE_ARB_DECLINED_BY_ISSUER", "ARBITRATION_RECEIVED", "DISPUTE_DECLINED", "PRE_ARB_DELIVERED", "PRE_ARB_DECLINED_BY_ACQUIRER", "ARB_DELIVERED", "WON", "LOST" ] } }, { "name": "from_created_at", "in": "query", "description": "The minimum created_at, in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "from_updated_at", "in": "query", "description": "The minimum updated_at, in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "Page bookmark to specify the position of page start.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "0" } }, { "name": "page_size", "in": "query", "description": "Number of dispute per page.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "reason", "in": "query", "description": "The reason for raising the dispute. Learn more about the [dispute reasons](/docs/issuing/transactions/handle-transaction-disputes#dispute-reasons).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "SUSPECTED_FRAUD", "UNAUTHORIZED_TRANSACTION", "DUPLICATED_TRANSACTION", "PAID_BY_OTHER_MEANS", "GOODS_SERVICE_NOT_AS_DESCRIBED", "GOODS_DAMAGED", "GOODS_SERVICE_NOT_RECEIVED", "REFUND_UNPROCESSED", "GOODS_SERVICE_CANCELED", "RECURRING_CANCELED", "OTHER" ] } }, { "name": "reference", "in": "query", "description": "A value added for your internal reference.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The latest status of the dispute. Learn more about the [dispute statuses](/docs/issuing/transactions/handle-transaction-disputes/dispute-statuses).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "DRAFT", "EXPIRED", "SUBMITTED", "REJECTED", "CANCELED", "IN_PROGRESS", "WON", "LOST" ] } }, { "name": "to_created_at", "in": "query", "description": "The maximum created_at, in ISO8601 format (exclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to_updated_at", "in": "query", "description": "The maximum updated_at, in ISO8601 format (exclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updated_by", "in": "query", "description": "The party who updated the dispute.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "CUSTOMER", "AIRWALLEX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciQueryDispute" }, "examples": { "default": { "value": { "items": [ { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "page_after": "YWFhYWFhYWEtOGM3ZC00OTcyLThlNTktNjFkMTFjYjYxNGMx", "page_before": "YmJiYmJiYmItNDg5Mi00NGI3LTk3NGYtNjI5OGM5YWY2ZTEx" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/transaction_disputes", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "page_after": "YWFhYWFhYWEtOGM3ZC00OTcyLThlNTktNjFkMTFjYjYxNGMx", "page_before": "YmJiYmJiYmItNDg5Mi00NGI3LTk3NGYtNjI5OGM5YWY2ZTEx" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:read", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes/{id}": { "get": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "2|Retrieve a Transaction Dispute", "description": "Retrieve single transaction dispute.", "operationId": "retrieveTransactionDispute", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for this dispute.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0" }, "examples": { "default": { "value": "transaction_dispute_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionDispute" }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/transaction_disputes/transaction_dispute_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:read", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes/{id}/submit": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "5|Submit a Transaction Dispute", "description": "Submit a dispute to Airwallex for review and processing. After a dispute has been submitted, its status will change to SUBMITTED.", "operationId": "transactionDisputes_submit", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for this dispute.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0" }, "examples": { "default": { "value": "transaction_dispute_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionDispute" }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/transaction_disputes/transaction_dispute_id/submit", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:write", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transaction_disputes/{id}/update": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "summary": "4|Update a Transaction Dispute", "description": "A dispute that has been created can be updated via this API. In the DRAFT status, all the fields in the dispute can be updated. Once a dispute is submitted, only new evidence or explanation can be added to the dispute.", "operationId": "updateTransactionDispute", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for this dispute.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0" }, "examples": { "default": { "value": "transaction_dispute_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "additional_info": { "type": "object", "description": "Additional information related to the dispute, such as relevant dates.", "properties": { "actual_delivery_date": { "type": "string", "description": "The date on which the cardholder actually received the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "attempted_return_date": { "type": "string", "description": "The date on which the cardholder attempted to return the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "card_charge_permission_withdrawn_date": { "type": "string", "description": "The date on which the cardholder withdrew permission for the card charge (e.g. cancelled a subscription or recurring payment). Strongly recommended to set this field when dispute reason is RECURRING_CANCELED." }, "expected_delivery_date": { "type": "string", "description": "The date by which the cardholder expected to receive the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_RECEIVED or GOODS_SERVICE_CANCELED." }, "order_cancellation_date": { "type": "string", "description": "The date on which the goods, service, or reservation was cancelled. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_CANCELED." }, "returned_date": { "type": "string", "description": "The date on which the cardholder returned the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." } } }, "amount": { "type": "number", "description": "The disputed amount. This value can be updated only when dispute status = DRAFT. Once a dispute is submitted, this cannot be updated." }, "evidence_files": { "type": "array", "description": "A list of file id that contains the evidence for the dispute. The file id can be retrieved after uploading the supporting document via [POST Upload a file](/docs/api/supporting_services/file_service/upload_files).", "items": { "type": "string" } }, "notes": { "type": "string", "description": "The explanation on why the cardholder is disputing the transaction can be provided here." }, "reason": { "type": "string", "description": "The reason for raising the dispute. This value can be updated only when dispute status = DRAFT. Once a dispute is submitted, this cannot be updated.", "enum": [ "SUSPECTED_FRAUD", "UNAUTHORIZED_TRANSACTION", "DUPLICATED_TRANSACTION", "PAID_BY_OTHER_MEANS", "GOODS_SERVICE_NOT_AS_DESCRIBED", "GOODS_DAMAGED", "GOODS_SERVICE_NOT_RECEIVED", "REFUND_UNPROCESSED", "GOODS_SERVICE_CANCELED", "RECURRING_CANCELED", "OTHER" ] }, "request_id": { "type": "string", "format": "uuid", "description": "A unique request identifier specified by the client. Requests with the same request_id will be ignored. This allows requests to be replayed if the client is unsure of the outcome, e.g. due to network issues, system failures, etc." } } }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "request_id": "ac2dc266-09ad-4235-b61a-767c7cd6d6e0" } } } } }, "description": "request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransactionDispute" }, "examples": { "default": { "value": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/issuing/transaction_disputes/transaction_dispute_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "request_id": "ac2dc266-09ad-4235-b61a-767c7cd6d6e0" }, "response_body": { "additional_info": { "expected_delivery_date": "2023-04-23T16:08:02+0000" }, "amount": 100, "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e2", "created_at": "2023-04-23T16:08:02+0000", "detailed_status": "PRE_ARB_RECEIVED", "id": "6c2dc266-09ad-4235-b61a-767c7cd6d6e0", "notes": "Fraud case", "reason": "SUSPECTED_FRAUD", "reference": "A@*Ddkss0@_2", "status": "DRAFT", "update_history": [ { "evidence_files": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "note": "Fraud case", "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } ], "updated_at": "2023-04-23T16:08:02+0000", "updated_by": "CUSTOMER" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "issuing.transaction_dispute:write", "group": "Issuing", "resource_name": "Transaction Disputes", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/issuing/transactions": { "get": { "tags": [ "Issuing > Transactions" ], "summary": "2|List all Transactions", "description": "Retrieve all transactions associated with an account or for a specific card. Will default to a 30 day period unless both *to* and *from* created_at request fields are populated.\n\n*This endpoint uses the legacy transaction model. Use [Transaction Events](/docs/api/issuing/card_transaction_events), [Card Transactions](/docs/api/issuing/card_transactions), and [Lifecycles](/docs/api/issuing/card_transaction_lifecycles) for the three-level transaction model and more precise transaction status and event data.*", "operationId": "transactions_listTransactions", "parameters": [ { "name": "billing_currency", "in": "query", "description": "Currency in which the transaction was billed, in 3-letter ISO-4217 code.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "card_id", "in": "query", "description": "Unique Identifier for the card.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "digital_wallet_token_id", "in": "query", "description": "Unique Identifier for the digital token.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "from_created_at", "in": "query", "description": "start of Transaction Date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "to_created_at - 30 day" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "retrieval_ref", "in": "query", "description": "Retrieval reference number.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "end of Transaction Date in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "current time" } }, { "name": "transaction_type", "in": "query", "description": "Transaction Type - one of `AUTHORIZATION`, `CLEARING`, `REFUND`, `REVERSAL`, `ORIGINAL_CREDIT`. See [Issuing Purchase Lifecycle](/docs/issuing/transactions/transaction-lifecycle) for transaction type definitions.\n* AUTHORIZATION - Funds reserved due to card usage\n* CLEARING - Deducting purchase amount from account balance\n* REFUND - Refunding the purchase amount back to account balance\n* REVERSAL - Reversing an authorization\n* ORIGINAL_CREDIT - Merchant initiated credit transactions.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "has_more", "items" ], "properties": { "has_more": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciTransaction" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "Some client data", "digital_wallet_token_id": "2af871b8-466e-465e-a8de-eeaac9f82392", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "matched_authorizations": [ "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" ], "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "posted_date": "2018-03-22T16:08:02+00:00", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "APPROVED", "transaction_amount": 100, "transaction_currency": "USD", "transaction_date": "2018-03-21T16:08:02+00:00", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "transaction_type": "REFUND" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": true, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "client_data": "Some client data", "digital_wallet_token_id": "2af871b8-466e-465e-a8de-eeaac9f82392", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "matched_authorizations": [ "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" ], "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "posted_date": "2018-03-22T16:08:02+00:00", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "APPROVED", "transaction_amount": 100, "transaction_currency": "USD", "transaction_date": "2018-03-21T16:08:02+00:00", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "transaction_type": "REFUND" } ] } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account", "x-badges": [ { "name": "Deprecated" } ] } }, "/api/v1/issuing/transactions/{id}": { "get": { "tags": [ "Issuing > Transactions" ], "summary": "1|Retrieve a Transaction", "description": "Retrieve single transaction.\n\n*This endpoint uses the legacy transaction model. Use [Transaction Events](/docs/api/issuing/card_transaction_events), [Card Transactions](/docs/api/issuing/card_transactions), and [Lifecycles](/docs/api/issuing/card_transaction_lifecycles) for the three-level transaction model and more precise transaction status and event data.*", "operationId": "retrieveTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Unique Identifier for a transaction.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" }, "examples": { "default": { "value": "transaction_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonPciTransaction" }, "examples": { "default": { "value": { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "digital_wallet_token_id": "2af871b8-466e-465e-a8de-eeaac9f82392", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "matched_authorizations": [ "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" ], "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "posted_date": "2018-03-22T16:08:02+00:00", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "APPROVED", "transaction_amount": 100, "transaction_currency": "USD", "transaction_date": "2018-03-21T16:08:02+00:00", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "transaction_type": "REFUND" } } } } } }, "400": { "description": "[\"field_required\"\n,\"bad_request\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": true, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/issuing/transactions/transaction_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "acquiring_institution_identifier": "123456", "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "digital_wallet_token_id": "2af871b8-466e-465e-a8de-eeaac9f82392", "failure_reason": "INSUFFICIENT_FUNDS", "fee_details": [ { "amount": 500, "currency": "USD", "type": "ATM_ACCESS_FEE" } ], "card_transaction_data": { "card_transaction_lifecycle_id": "95ede192-3a86-461e-96d9-f51b55aae79e", "card_transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_event_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "masked_card_number": "************4242", "matched_authorizations": [ "6c2dc266-09ad-4235-b61a-767c7cd6d6ea" ], "merchant": { "additional_merchant_info": { "merchant_category": "Professional Services", "merchant_full_name": "Meta", "merchant_logo_url": "https://example.com/merchant-logo.png", "merchant_sub_category": "Advertising and Marketing" }, "category_code": "4829", "city": "San Francisco", "country": "USA", "identifier": "012345678910123", "name": "Merchant A", "postcode": "94111", "state": "CA" }, "network_transaction_id": "3951729271768745", "posted_date": "2018-03-22T16:08:02+00:00", "retrieval_ref": "909916088001", "risk_details": { "risk_actions_performed": [ "TRANSACTION_BLOCKED" ], "risk_factors": [ "Suspicious transaction velocity" ], "three_dsecure_outcome": "AUTHENTICATED" }, "status": "APPROVED", "transaction_amount": 100, "transaction_currency": "USD", "transaction_date": "2018-03-21T16:08:02+00:00", "transaction_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "transaction_type": "REFUND" } } ], "x-scope": [ { "scope": "issuing.transaction:read", "group": "Issuing", "resource_name": "Authorizations and Transactions", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account", "x-badges": [ { "name": "Deprecated" } ] } }, "/api/v1/pa/config/applepay/registered_domains/add_items": { "post": { "tags": [ "Payment Acceptance > Config" ], "summary": "5|Add Apple Pay Domains", "description": "Register one or more web domains to Apple Pay.", "operationId": "applepayRegisteredDomainsAddItems", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "The account unique identifier that this request is on behalf of.", "required": false, "schema": { "type": "string", "default": "acct_JD0UmuRLNcytX7sBj0lfWA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "A list of domains to be registered.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "items": [ "domain3.com" ] } } } } }, "description": "Apple pay domains register request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRegisteredDomains" }, "examples": { "default": { "value": { "items": [ "domain1.com", "domain2.com", "domain3.com" ] } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/config/applepay/registered_domains/add_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "items": [ "domain3.com" ] }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ "domain1.com", "domain2.com", "domain3.com" ] } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/applepay/registered_domains/remove_items": { "post": { "tags": [ "Payment Acceptance > Config" ], "summary": "6|Remove Apple Pay Domains", "description": "Remove one or more registered web domains from Apple Pay.", "operationId": "applepayRegisteredDomainsRemoveItems", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "The account unique identifier that this request is on behalf of.", "required": false, "schema": { "type": "string", "default": "acct_JD0UmuRLNcytX7sBj0lfWA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "A list of domains to be removed.", "items": { "type": "string" } }, "reason": { "type": "string", "description": "The reason for removing these domains. Maximum length is 500." } } }, "examples": { "default": { "value": { "items": [ "domain3.com" ], "reason": "Not used anymore." } } } } }, "description": "Apple pay domains unregister request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRegisteredDomains" }, "examples": { "default": { "value": { "items": [ "domain1.com", "domain2.com" ] } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/config/applepay/registered_domains/remove_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "items": [ "domain3.com" ], "reason": "Not used anymore." }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ "domain1.com", "domain2.com" ] } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/applepay/registered_domains": { "get": { "tags": [ "Payment Acceptance > Config" ], "summary": "4|List all Apple Pay Domains", "description": "Get all the web domains registered in Apple Pay.", "operationId": "listApplepayRegisteredDomains", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "The account unique identifier that this request is on behalf of.", "required": false, "schema": { "type": "string", "default": "acct_JD0UmuRLNcytX7sBj0lfWA" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplePayRegisteredDomains" }, "examples": { "default": { "value": { "items": [ "domain1.com", "domain2.com" ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/config/applepay/registered_domains", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ "domain1.com", "domain2.com" ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/banks": { "get": { "tags": [ "Payment Acceptance > Config" ], "summary": "3|List all Available Bank Names", "description": "Some payment method types such as `online_banking` require the `bank_name` to be filled when confirming a Payment Intent. You may call this API to retrieve a list of available banks and let the shopper choose one before confirming a Payment Intent. Refer to [confirm](/docs/api/payments/payment_intents/confirm).", "operationId": "listBanks", "parameters": [ { "name": "country_code", "in": "query", "description": "Country code to filter the available banks. Use the two-character ISO Standard Country Codes. \n \nFor payment method type like `online_banking` and `bank_transfer`, the available bank list differs by different countries and `country_code` is needed to get the bank list. \n \nFor other payment method types, `country_code` will be ignored.", "required": false, "schema": { "type": "string", "default": "MY" }, "examples": { "default": { "value": "NL" } } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of banks to be listed per page. Default value is 100. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 }, "examples": { "default": { "value": 10 } } }, { "name": "payment_method_type", "in": "query", "description": "The payment method type to find the available banks. For other payment methods that don't require `bank_name`, an empty list will be returned.", "required": true, "schema": { "type": "string", "default": "bank_transfer" }, "examples": { "default": { "value": "ideal" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/BankConfig" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "bank_name": "asn", "display_name": "ASN Bank", "resources": { "logo_url": "https://checkout.airwallex.com/static/media/asn.257601a1.svg" } }, { "bank_name": "knab", "display_name": "Knab", "resources": { "logo_url": "https://checkout.airwallex.com/static/media/knab.38031ef6.svg" } } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/config/banks", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "country_code": "NL", "page_num": 0, "page_size": 10, "payment_method_type": "ideal" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "bank_name": "asn", "display_name": "ASN Bank", "resources": { "logo_url": "https://checkout.airwallex.com/static/media/asn.257601a1.svg" } }, { "bank_name": "knab", "display_name": "Knab", "resources": { "logo_url": "https://checkout.airwallex.com/static/media/knab.38031ef6.svg" } } ] } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/convertible_shopper_currencies": { "get": { "tags": [ "Payment Acceptance > Config" ], "summary": "7|List all Convertible Shopper Currencies", "description": "Retrieves a list of shopper currencies enabled for creating a conversion quote, which can be used as selectable options for payment currency conversion.", "operationId": "listConvertibleShopperCurrencies", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertibleShopperCurrencies" }, "examples": { "default": { "value": { "items": [ "AUD", "USD", "SGD", "EUR", "JPY" ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/config/convertible_shopper_currencies", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ "AUD", "USD", "SGD", "EUR", "JPY" ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/payment_method_types": { "get": { "tags": [ "Payment Acceptance > Config" ], "summary": "2|List all Available Payment Method Types", "description": "Retrieve configuration for available payment method types with different transaction modes. \n \n \nNote that the payment method types can be duplicate when it supports different transaction modes. \nA transaction mode refer to how merchant trigger transactions. It can be one-off and recurring. \n \nFor oneoff, refer to [Payment Intent API](/docs/api/payments/payment_intents). \nFor recurring, refer to [Payment Consent API](/docs/api/payments/payment_consents).", "operationId": "listPaymentMethodTypes", "parameters": [ { "name": "active", "in": "query", "description": "Indicate whether the payment method type is active.", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "country_code", "in": "query", "description": "The supported country code of the shopper.", "required": false, "schema": { "type": "string", "default": "AU" }, "examples": { "default": { "value": "US" } } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of payment method types to be listed per page. Default value is 100. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 }, "examples": { "default": { "value": 10 } } }, { "name": "transaction_currency", "in": "query", "description": "The supported transaction currency. `transaction_currency` is required when `country_code` is given.", "required": false, "schema": { "type": "string", "default": "USD" }, "examples": { "default": { "value": "USD" } } }, { "name": "transaction_mode", "in": "query", "description": "The supported transaction mode. One of `oneoff`, `recurring`.", "required": false, "schema": { "type": "string", "default": "oneoff" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentMethodTypeConfig" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "active": true, "flows": [], "name": "card", "transaction_currencies": [ "AUD", "USD", "SGD", "EUR", "JPY" ], "transaction_mode": "oneoff" }, { "active": true, "flows": [], "name": "applepay", "transaction_currencies": [ "*" ], "transaction_mode": "recurring" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/config/payment_method_types", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "country_code": "US", "page_num": 0, "page_size": 10, "transaction_currency": "USD" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "active": true, "flows": [], "name": "card", "transaction_currencies": [ "AUD", "USD", "SGD", "EUR", "JPY" ], "transaction_mode": "oneoff" }, { "active": true, "flows": [], "name": "applepay", "transaction_currencies": [ "*" ], "transaction_mode": "recurring" } ] } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/config/reserve_plan": { "get": { "tags": [ "Payment Acceptance > Config" ], "summary": "1|Retrieve the Current Reserve Plan", "description": "Retrieves [reserve plan](/docs/payments/get-started-with-payments/reserve-plan) configuration details for your Airwallex account.", "operationId": "retrieveReservePlan", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservePlan" }, "examples": { "default": { "value": { "delayed": { "delay_in_days": 3 }, "delayed_rolling": { "delay_in_days": 3, "rolling_percentage": 10, "rolling_window_in_days": 5 }, "rolling": { "rolling_percentage": 10, "rolling_window_in_days": 5 }, "type": "DELAYED_ROLLING" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/config/reserve_plan", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "delayed": { "delay_in_days": 3 }, "delayed_rolling": { "delay_in_days": 3, "rolling_percentage": 10, "rolling_window_in_days": 5 }, "rolling": { "rolling_percentage": 10, "rolling_window_in_days": 5 }, "type": "DELAYED_ROLLING" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/conversion_quotes/create": { "post": { "tags": [ "Payment Acceptance > Conversion Quotes" ], "summary": "1|Create a Conversion Quote", "description": "Create a new conversion quote for converting from merchant currency to shopper currency.", "operationId": "createConversionQuote", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_currency", "request_id", "shopper_currency" ], "properties": { "merchant_currency": { "type": "string", "description": "The currency used by the merchant for pricing or payment (3-letter ISO 4217 code)." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "shopper_currency": { "type": "string", "description": "The currency that the shopper prefers to use (3-letter ISO-4217 code)." }, "validity_period": { "type": "string", "description": "The period for which the conversion quote remains valid. If not specified, the default value is `HR_1`.", "enum": [ "HR_1", "HR_24" ] } } }, "examples": { "default": { "value": { "merchant_currency": "USD", "request_id": "71e0ff5a-d4c0-4c1d-b77b-64b2966d5411", "shopper_currency": "SGD", "validity_period": "HR_1" } } } } }, "description": "Conversion Quote Create Request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionQuote" }, "examples": { "default": { "value": { "conversion_rate": 1.287532, "created_at": "2025-07-15T06:15:09Z", "expires_at": "2025-07-15T07:15:09Z", "id": "cvq_hkpd5k6pgfub1fyurc86", "merchant_currency": "USD", "shopper_currency": "SGD", "status": "CREATED", "validity_period": "HR_1" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/conversion_quotes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "merchant_currency": "USD", "request_id": "71e0ff5a-d4c0-4c1d-b77b-64b2966d5411", "shopper_currency": "SGD", "validity_period": "HR_1" }, "response_body": { "conversion_rate": 1.287532, "created_at": "2025-07-15T06:15:09Z", "expires_at": "2025-07-15T07:15:09Z", "id": "cvq_hkpd5k6pgfub1fyurc86", "merchant_currency": "USD", "shopper_currency": "SGD", "status": "CREATED", "validity_period": "HR_1" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/conversion_quotes/{id}": { "get": { "tags": [ "Payment Acceptance > Conversion Quotes" ], "summary": "2|Retrieve a Conversion Quote", "description": "Get a conversion quote by specifying its unique id.", "operationId": "retrieveConversionQuote", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the conversion quote.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "conversion_quote_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionQuote" }, "examples": { "default": { "value": { "conversion_rate": 1.287532, "created_at": "2025-07-15T06:15:09Z", "expires_at": "2025-07-15T07:15:09Z", "id": "cvq_hkpd5k6pgfub1fyurc86", "merchant_currency": "USD", "shopper_currency": "SGD", "status": "CREATED", "validity_period": "HR_1" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/conversion_quotes/conversion_quote_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "conversion_rate": 1.287532, "created_at": "2025-07-15T06:15:09Z", "expires_at": "2025-07-15T07:15:09Z", "id": "cvq_hkpd5k6pgfub1fyurc86", "merchant_currency": "USD", "shopper_currency": "SGD", "status": "CREATED", "validity_period": "HR_1" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customer_balance_transactions/{id}": { "get": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "summary": "1|Retrieve a Customer Balance Transaction", "description": "Retrieve a Customer Balance Transaction by unique ID.", "operationId": "retrieveCustomerBalanceTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Customer Balance Transaction unique ID.", "required": true, "schema": { "type": "string", "default": "cbt_sgst8pzlnhkkf18vp0a" }, "examples": { "default": { "value": "cbt_sgst8pzlnhkkf18vp0a" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBalanceTransactionResponse" }, "examples": { "default": { "value": { "id": "cbt_sgst8pzlnhkkf18vp0a", "type": "bank_transfer", "created_at": "2024-06-01T10:30:05+00:00", "updated_at": "2024-06-01T10:30:05+00:00", "bank_transfer": { "amount": 100, "currency": "USD", "received_at": "2024-06-01T10:30:00+00:00", "status": "RECEIVED", "payer": { "customer_id": "cus_sgstcq8tphkfma1574m", "payer_name": "John Smith", "payer_email": "john.smith@example.com", "bank_name": "Bank of America", "account_name": "John Smith Checking Account", "account_number": "1234567890" }, "bank_transfer_instructions": { "bank_name": "Bank of America", "account_name": "Merchant Settlement Account", "account_number": "9876543210" } } } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/customer_balance_transactions/cbt_sgst8pzlnhkkf18vp0a", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cbt_sgst8pzlnhkkf18vp0a", "type": "bank_transfer", "created_at": "2024-06-01T10:30:05+00:00", "updated_at": "2024-06-01T10:30:05+00:00", "bank_transfer": { "amount": 100, "currency": "USD", "received_at": "2024-06-01T10:30:00+00:00", "status": "RECEIVED", "payer": { "customer_id": "cus_sgstcq8tphkfma1574m", "payer_name": "John Smith", "payer_email": "john.smith@example.com", "bank_name": "Bank of America", "account_name": "John Smith Checking Account", "account_number": "1234567890" }, "bank_transfer_instructions": { "bank_name": "Bank of America", "account_name": "Merchant Settlement Account", "account_number": "9876543210" } } } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customers/create": { "post": { "tags": [ "Payment Acceptance > Customers" ], "summary": "1|Create a Customer", "description": "Create a **Customer** object. We require the Customer unique identifier in the merchant's system as a mandatory field.", "operationId": "createCustomer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchant_customer_id", "request_id" ], "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the customer.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "business_name": { "type": "string", "description": "Business name of the customer. Maximum length is 128." }, "email": { "type": "string", "description": "Email address of the customer. Maximum length is 256." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of this customer in merchant's system. Maximum length is 64." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this customer. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "phone_number": { "type": "string", "description": "Phone number of the customer." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0" } } } } }, "description": "Customer creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "examples": { "default": { "value": { "id": "cus_hkpdh1d0d298uf1", "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `resource_already_exists`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/customers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "cus_hkpdh1d0d298uf1", "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customers/{id}/generate_client_secret": { "get": { "tags": [ "Payment Acceptance > Customers" ], "summary": "5|Generate a Client Secret for a Customer", "description": "Generate a client secret for a Customer so that the client secret can be used as HTTP header `client-secret` from client-side to [create a Payment Method](/docs/api/payments/payment_methods/create) or [list Payment Method](/docs/api/payments/payment_methods/list).", "operationId": "generateClientSecret", "parameters": [ { "name": "id", "in": "path", "description": "Customer unique identifier.", "required": true, "schema": { "type": "string", "default": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "customer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerClientSecret" }, "examples": { "default": { "value": { "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NTk0OTM1NzUsImV4cCI6MTY1OTQ5NzE3NSwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiU0ciLCJhY2NvdW50X2lkIjoiMGFjZTdkY2EtMzUzOC00NGUwLWI2OGEtYjQwYjY1MWIzMDE5IiwiaW50ZW50X2lkIjoiaW50X3Nnc3RiOXRic2djOG90bndlMGoiLCJidXNpbmVzc19uYW1lIjoiV2lzaGNvbSBTaGFuZ2hhaSJ9.rqKdwFjF4ba8h2hsbppBxkmAhCcPbSdl_YhC7J_i8so", "expired_time": "2019-09-18T03:11:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/customers/customer_id/generate_client_secret", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NTk0OTM1NzUsImV4cCI6MTY1OTQ5NzE3NSwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiU0ciLCJhY2NvdW50X2lkIjoiMGFjZTdkY2EtMzUzOC00NGUwLWI2OGEtYjQwYjY1MWIzMDE5IiwiaW50ZW50X2lkIjoiaW50X3Nnc3RiOXRic2djOG90bndlMGoiLCJidXNpbmVzc19uYW1lIjoiV2lzaGNvbSBTaGFuZ2hhaSJ9.rqKdwFjF4ba8h2hsbppBxkmAhCcPbSdl_YhC7J_i8so", "expired_time": "2019-09-18T03:11:00+00:00" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customers": { "get": { "tags": [ "Payment Acceptance > Customers" ], "summary": "3|List all Customers", "description": "List all Customers.", "operationId": "listCustomers", "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2021-03-01T03:52:34+00:00" } }, { "name": "merchant_customer_id", "in": "query", "description": "The customer unique identifier on merchant side.", "required": false, "schema": { "type": "string" }, "examples": { "default": { "value": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0" } } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 1 } } }, { "name": "page_size", "in": "query", "description": "Number of Customers to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/Customer" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "cus_hkpdh1d0d298uf1", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/customers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "page_num": 1, "page_size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "cus_hkpdh1d0d298uf1", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customers/{id}": { "get": { "tags": [ "Payment Acceptance > Customers" ], "summary": "2|Retrieve a Customer", "description": "Retrieve a Customer by unique identifier. This unique identifier is first returned when creating a new Customer.", "operationId": "retrieveCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Customer unique identifier.", "required": true, "schema": { "type": "string", "default": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "cus_hkpdh1d0d298uf1" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "examples": { "default": { "value": { "id": "cus_hkpdh1d0d298uf1", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/customers/cus_hkpdh1d0d298uf1", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cus_hkpdh1d0d298uf1", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customers/{id}/update": { "post": { "tags": [ "Payment Acceptance > Customers" ], "summary": "4|Update a Customer", "description": "Update customer's personal information. Use the [Payment Methods API](/docs/api/payments/payment_methods/update) to update details of the attached Payment Methods.", "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Customer unique identifier.", "required": true, "schema": { "type": "string", "default": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "cus_hkpdh1d0d298uf1" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the customer.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "business_name": { "type": "string", "description": "Business name of the customer. Maximum length is 128." }, "email": { "type": "string", "description": "Email address of the customer. Maximum length is 256." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of this customer in merchant's system. Maximum length is 64." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this customer. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "phone_number": { "type": "string", "description": "Phone number of the customer." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "48dd845a-b4aa-4c7c-a4af-ea3ccfe1839e", "first_name": "John", "last_name": "Doe", "email": "updated_john.doe@example.com", "phone_number": "+1 1234567890", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0" } } } } }, "description": "Customer updating request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "examples": { "default": { "value": { "id": "cus_hkpdh1d0d298uf1", "request_id": "48dd845a-b4aa-4c7c-a4af-ea3ccfe1839e", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "updated_john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/customers/cus_hkpdh1d0d298uf1/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "48dd845a-b4aa-4c7c-a4af-ea3ccfe1839e", "first_name": "John", "last_name": "Doe", "email": "updated_john.doe@example.com", "phone_number": "+1 1234567890", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cus_hkpdh1d0d298uf1", "request_id": "48dd845a-b4aa-4c7c-a4af-ea3ccfe1839e", "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0", "first_name": "John", "last_name": "Doe", "email": "updated_john.doe@example.com", "phone_number": "+1 1234567890", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NDQwMTQ3MTAsImV4cCI6MTc0NDAxODMxMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiYjlkMmU0NTctOGEwNC00MDMzLWI3MTktZTJkOGNiZmQyZDY1IiwiY3VzdG9tZXJfaWQiOiJDVVMyMDI1MDMyMTAwMDEifQ.vonr_tnn7kA3GE3t9WCJoi5TjVnBu1rGnrwPeTTjU_I", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customs_declarations/create": { "post": { "tags": [ "Payment Acceptance > Customs Declarations" ], "summary": "1|Create a Customs Declaration", "description": "Start the declaration process by creating a customs declaration. Please note that sub_order fields are required. If there is no need to split your original order, please fill the sub_order fields with your original order information for declaration. In this case, remember to use the provider_order_id in the response for your order information/shipment information declaration.", "operationId": "createCustomsDeclaration", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customs_details", "payment_intent_id", "request_id" ], "properties": { "customs_details": { "type": "object", "required": [ "customs_code", "merchant_customs_name", "merchant_customs_number" ], "description": "Customs details.", "properties": { "customs_code": { "type": "string", "description": "China customs code, please refer to here for information https://www.airwallex.com/docs/payments/apac/wechat-pay/customs-declaration,https://www.airwallex.com/docs/payments/apac/alipay/customs-declaration." }, "merchant_customs_name": { "type": "string", "description": "Merchant's registered name in customs system. Maximum length is 256." }, "merchant_customs_number": { "type": "string", "description": "Merchant's registered number in customs system. Maximum length is 32." } } }, "payment_intent_id": { "type": "string", "description": "Unique identifier of the payment intent on which customs declaration will be created." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "shopper_details": { "type": "object", "required": [ "shopper_id", "shopper_name" ], "description": "Shopper details. Will be used for shopper identity check.", "properties": { "shopper_id": { "type": "string", "description": "Mainland China unique identifier of the shopper." }, "shopper_name": { "type": "string", "description": "Name of the shopper in simplified Chinese." } } }, "sub_order": { "type": "object", "required": [ "amount", "currency", "order_number", "shipping_fee" ], "description": "Suborder info, required when there are split orders.", "properties": { "amount": { "type": "number", "description": "The total amount of your sub_order, shipping fee shall be included, unit is Yuan. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "currency": { "type": "string", "description": "Currency for the suborder, only CNY supported now." }, "order_number": { "type": "string", "description": "Suborder number in merchant system. Maximum length is 128." }, "provider_order_id": { "type": "string", "description": "The unique transaction identifier assigned by the provider for your sub_order. Please use this field as the provider transaction no. for your order information/shipment information’s declaration. Example of our providers: Cards, WeChat, Alipay etc." }, "shipping_fee": { "type": "number", "description": "Suborder transport fee, unit is Yuan." } } } } }, "examples": { "default": { "value": { "request_id": "ac88c53b-f1bd-479b-a1b8-2686db548b39", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_name": "Airwallex", "merchant_customs_number": "C129000000" }, "sub_order": { "amount": 10, "currency": "USD", "order_number": "o100001213", "provider_order_id": "T912345678901234569", "shipping_fee": 0 } } } } } }, "description": "Customs declaration request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclaration" }, "examples": { "default": { "value": { "id": "cdc_hkpdkjd4t98sa", "request_id": "ac88c53b-f1bd-479b-a1b8-2686db548b39", "status": "UNDECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `resource_already_exists`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/customs_declarations/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "ac88c53b-f1bd-479b-a1b8-2686db548b39", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_name": "Airwallex", "merchant_customs_number": "C129000000" }, "sub_order": { "amount": 10, "currency": "USD", "order_number": "o100001213", "provider_order_id": "T912345678901234569", "shipping_fee": 0 } }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "cdc_hkpdkjd4t98sa", "request_id": "ac88c53b-f1bd-479b-a1b8-2686db548b39", "status": "UNDECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "customs_declaration:write", "group": "Payment Acceptance", "resource_name": "Customs Declarations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customs_declarations/{id}/redeclare": { "post": { "tags": [ "Payment Acceptance > Customs Declarations" ], "summary": "4|Redeclare a Customs Declaration", "description": "Redeclare an existing customs declaration. `SHANGHAI_CBT` does not support redeclaration after a successful declaration.", "operationId": "redeclare", "parameters": [ { "name": "id", "in": "path", "description": "Customs Declaration unique identifier.", "required": true, "schema": { "type": "string", "default": "cdc_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "cdc_hkpdkjd4t98sa" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "a268d48f-f42a-438e-bf99-ca74b7f58d09" } } } } }, "description": "Customs declaration redeclare request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclaration" }, "examples": { "default": { "value": { "id": "cdc_hkpdkjd4t98sa", "request_id": "a268d48f-f42a-438e-bf99-ca74b7f58d09", "status": "REDECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `provider_declined`, `provider_unavailable`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/customs_declarations/cdc_hkpdkjd4t98sa/redeclare", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "a268d48f-f42a-438e-bf99-ca74b7f58d09" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cdc_hkpdkjd4t98sa", "request_id": "a268d48f-f42a-438e-bf99-ca74b7f58d09", "status": "REDECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "customs_declaration:write", "group": "Payment Acceptance", "resource_name": "Customs Declarations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customs_declarations/{id}": { "get": { "tags": [ "Payment Acceptance > Customs Declarations" ], "summary": "2|Retrieve a Customs Declaration", "description": "Retrieve an existing customs declaration.", "operationId": "retrieveCustomsDeclaration", "parameters": [ { "name": "id", "in": "path", "description": "Customs Declaration unique identifier.", "required": true, "schema": { "type": "string", "default": "cdc_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "cdc_hkpdkjd4t98sa" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclaration" }, "examples": { "default": { "value": { "id": "cdc_hkpdkjd4t98sa", "request_id": "4dd119d8-331d-41a0-b037-122f0113b227", "status": "DECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/customs_declarations/cdc_hkpdkjd4t98sa", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cdc_hkpdkjd4t98sa", "request_id": "4dd119d8-331d-41a0-b037-122f0113b227", "status": "DECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "customs_declaration:read", "group": "Payment Acceptance", "resource_name": "Customs Declarations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/customs_declarations/{id}/update": { "post": { "tags": [ "Payment Acceptance > Customs Declarations" ], "summary": "3|Update a Customs Declaration", "description": "Update an existing customs declaration. `SHANGHAI_CBT` does not support update after a successful declaration.", "operationId": "updateCustomsDeclaration", "parameters": [ { "name": "id", "in": "path", "description": "id.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "cdc_hkpdkjd4t98sa" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "customs_code": { "type": "string", "description": "China customs code." }, "merchant_customs_name": { "type": "string", "description": "Merchant's registered name in customs system. Maximum length is 256." }, "merchant_customs_number": { "type": "string", "description": "Merchant's registered number in customs system. Maximum length is 32." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "shopper_details": { "type": "object", "required": [ "shopper_id", "shopper_name" ], "description": "Shopper details. Will be used to update shopper identity check information.", "properties": { "shopper_id": { "type": "string", "description": "Mainland China unique identifier of the shopper." }, "shopper_name": { "type": "string", "description": "Name of the shopper in simplified Chinese." } } }, "sub_order_amount": { "type": "number", "description": "Suborder amount. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." } } }, "examples": { "default": { "value": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_name": "C129000000", "merchant_customs_number": "Airwallex", "request_id": "ce113401-b801-4722-b43b-1ddb50e8951f", "shopper_details": { "shopper_id": "800000206709306711", "shopper_name": "nessus_was_textvpwjrhzt" }, "sub_order_amount": 10 } } } } }, "description": "Customs declaration update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclaration" }, "examples": { "default": { "value": { "id": "cdc_hkpdkjd4t98sa", "request_id": "ce113401-b801-4722-b43b-1ddb50e8951f", "status": "DECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `provider_declined`, `provider_unavailable`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/customs_declarations/cdc_hkpdkjd4t98sa/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_name": "C129000000", "merchant_customs_number": "Airwallex", "request_id": "ce113401-b801-4722-b43b-1ddb50e8951f", "shopper_details": { "shopper_id": "800000206709306711", "shopper_name": "nessus_was_textvpwjrhzt" }, "sub_order_amount": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cdc_hkpdkjd4t98sa", "request_id": "ce113401-b801-4722-b43b-1ddb50e8951f", "status": "DECLARED", "payment_method_type": "card", "provider_transaction_id": "t202401091234567890123456789", "awx_request_id": "1234567890123456789", "verification_department_code": "OTHERS", "verification_department_transaction_id": "tx1202401091234567890123456789", "customs_details": { "customs_code": "GUANGZHOU_ZS", "merchant_customs_number": "C129000000", "merchant_customs_name": "Airwallex" }, "sub_order": { "order_number": "o100001213", "provider_order_id": "T912345678901234569", "amount": 10, "shipping_fee": 0, "currency": "USD" }, "shopper_identity_check_result": "UNCHECKED", "created_at": "2024-01-31T06:59:10+00:00", "updated_at": "2024-01-31T06:59:10+00:00" } } ], "x-scope": [ { "scope": "customs_declaration:write", "group": "Payment Acceptance", "resource_name": "Customs Declarations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_split_reversals/create": { "post": { "tags": [ "Payment Acceptance > Funds Split Reversals" ], "summary": "1|Create a Funds Split Reversal", "description": "Initiate a Funds Split Reversal to take money back from a connected account. You must specify a Funds Split as the source of reversal. \n \nWhen reversing a Funds Split, You can optionally reverse part of it. You can do so as many times as you wish until the entire Funds Split has been reversed. Once entirely reversed, a Funds Split can’t be reversed again. This method will return an error when called on an already-reversed Funds Split, or when trying to reverse more money than is left on a Funds Split.", "operationId": "createFundsSplitReversal", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "The account unique identifier that this request is on behalf of.", "required": false, "schema": { "type": "string", "default": "acct_JD0UmuRLNcytX7sBj0lfWA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "funds_split_id", "request_id" ], "properties": { "amount": { "type": "string", "description": "Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "funds_split_id": { "type": "string", "description": "Unique identifier of Funds Split on which the Funds Split Reversal is created." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": "10", "metadata": { "foo": "bar" } } } } } }, "description": "Funds Split Reversal creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundsSplitReversal" }, "examples": { "default": { "value": { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": "10", "status": "CREATED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/funds_split_reversals/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": "10", "metadata": { "foo": "bar" } }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": "10", "status": "CREATED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } } ], "x-scope": [ { "scope": "funds_split:write", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_split_reversals": { "get": { "tags": [ "Payment Acceptance > Funds Split Reversals" ], "summary": "3|List all Funds Split Reversals", "description": "List all Funds Split Reversals.", "operationId": "listFundsSplitReversals", "parameters": [ { "name": "funds_split_id", "in": "query", "description": "Unique identifier of which funds_split this funds_split_reversal would be created from.", "required": true, "schema": { "type": "string", "default": "spt_hkstskz9vg1xc7uscdj" }, "examples": { "default": { "value": "rev_hkpdkhwr5h1375nct0l" } } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Fund Split Reversals to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/FundsSplitReversal" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": 10, "status": "CREATED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/funds_split_reversals", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "funds_split_id": "rev_hkpdkhwr5h1375nct0l", "page_num": 0, "page_size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": 10, "status": "CREATED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } ] } } ], "x-scope": [ { "scope": "funds_split:read", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_split_reversals/{id}": { "get": { "tags": [ "Payment Acceptance > Funds Split Reversals" ], "summary": "2|Retrieve a Funds Split Reversal", "description": "Retrieve a Funds Split Reversal by unique identifier.", "operationId": "retrieveFundsSplitReversal", "parameters": [ { "name": "id", "in": "path", "description": "Funds Split Reversal Id.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "rev_hkpdkhwr5h1375nct0l" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundsSplitReversal" }, "examples": { "default": { "value": { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": 10, "status": "RELEASED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/funds_split_reversals/rev_hkpdkhwr5h1375nct0l", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "rev_hkpdkhwr5h1375nct0l", "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43", "funds_split_id": "spt_hkpdkhwr5h1s5nct0l", "amount": 10, "status": "RELEASED", "metadata": { "foo": "bar" }, "created_at": "2024-04-09T02:46:19.320490400+00:00" } } ], "x-scope": [ { "scope": "funds_split:read", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_splits/create": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "summary": "1|Create a Funds Split", "description": "Start dividing the funds you are collecting by creating a Funds Split. \n \nA **Funds Split** can be created only after the **Payment Intent** succeeds and before funds settlement. Subscribe to `payment_intent.succeeded` webhook to confirm if the payment was successful or alternatively provide `funds_split_data` directly in Create/Confirm/Capture a Payment Intent request. \n \nThe destination account has to pass KYC to be able to receive fund splits \n \nThe `auto_release` flag controls at what point the split funds will be released and settled to the destination. The behavior is as follows: \\* **true(default)** - Automatically release the split funds following the standard settlement mode. \\* **false** - Release split funds as a separate manual process by calling release.", "operationId": "createFundsSplit", "parameters": [ { "name": "x-on-behalf-of", "in": "header", "description": "The account unique identifier that this request is on behalf of.", "required": false, "schema": { "type": "string", "default": "acct_JD0UmuRLNcytX7sBj0lfWA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "destination", "request_id", "source_id", "source_type" ], "properties": { "amount": { "type": "string", "description": "Amount of this split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "auto_release": { "type": "boolean", "description": "Set it to `false` if you want to release split manually. `true` by default." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts\n- a Funds Split Destination ID. Used to split funds to an external destination." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Funds Split. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "source_id": { "type": "string", "description": "Unique identifier of which source this split would be created from. Currently only payment_intent_id is supported." }, "source_type": { "type": "string", "description": "Type of the source for this split. Currently only PAYMENT_INTENT is supported." } } }, "examples": { "default": { "value": { "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "metadata": { "foo": "bar" } } } } } }, "description": "Funds Split creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundSplit" }, "examples": { "default": { "value": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "CREATED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `operation_not_supported`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/funds_splits/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "metadata": { "foo": "bar" } }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "CREATED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } ], "x-scope": [ { "scope": "funds_split:write", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_splits": { "get": { "tags": [ "Payment Acceptance > Funds Splits" ], "summary": "3|List all Funds Splits", "description": "List all Fund Splits.", "operationId": "listFundsSplits", "parameters": [ { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Fund Splits to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "source_id", "in": "query", "description": "Unique identifier of which source this split would be created from. Currently only payment_intent_id is supported.", "required": true, "schema": { "type": "string", "default": "int_hkstskz7vg1xc7uscdj" } }, { "name": "source_type", "in": "query", "description": "Type of the source for this split. Currently only PAYMENT_INTENT is supported.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/FundSplit" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "CREATED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/funds_splits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "page_num": 0, "page_size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "CREATED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } ] } } ], "x-scope": [ { "scope": "funds_split:read", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_splits/{id}/release": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "summary": "4|Release a Funds Split", "description": "Call this endpoint when you are ready to let the funds arrive at the destination. A Funds Split is capturable if `auto_release=false`. \n", "operationId": "fundsSplits_release", "parameters": [ { "name": "id", "in": "path", "description": "Fund Split Id.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "spt_hkpd1k27vg1xc7u" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "5894cf98-f4e4-49f6-9179-cb50e79beff5" } } } } }, "description": "Fund Split Release Request Raw.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundSplit" }, "examples": { "default": { "value": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "5894cf98-f4e4-49f6-9179-cb50e79beff5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "RELEASED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `operation_not_supported`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/funds_splits/spt_hkpd1k27vg1xc7u/release", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "5894cf98-f4e4-49f6-9179-cb50e79beff5" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "5894cf98-f4e4-49f6-9179-cb50e79beff5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "RELEASED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } ], "x-scope": [ { "scope": "funds_split:write", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/funds_splits/{id}": { "get": { "tags": [ "Payment Acceptance > Funds Splits" ], "summary": "2|Retrieve a Funds Split", "description": "Retrieve a Funds Split by unique identifier.", "operationId": "retrieveFundsSplit", "parameters": [ { "name": "id", "in": "path", "description": "Funds Split Id.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "spt_hkpd1k27vg1xc7u" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundSplit" }, "examples": { "default": { "value": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "RELEASED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/funds_splits/spt_hkpd1k27vg1xc7u", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "spt_hkpd1k27vg1xc7u", "request_id": "b7a93a42-fd15-4529-885f-4d4d7553f2f5", "source_id": "int_hkpdskz7vg1xc7uscdj", "source_type": "PAYMENT_INTENT", "currency": "USD", "amount": "0.23", "destination": "acct_sjnladsfjklasjd", "status": "RELEASED", "auto_release": true, "metadata": { "foo": "bar" }, "created_at": "2023-10-01T00:00:00+00:00" } } ], "x-scope": [ { "scope": "funds_split:read", "group": "Payment Acceptance", "resource_name": "Funds Splits", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_attempts": { "get": { "tags": [ "Payment Acceptance > Payment Attempts" ], "summary": "2|List all Payment Attempts", "description": "List all Payment Attempts. Specify a value for `payment_intent_id` to list the Payment Attempts made on the Payment Intent. You may filter out the results further by `method` and/or `status`.", "operationId": "listPaymentAttempts", "parameters": [ { "name": "currency", "in": "query", "description": "Payment Attempt currency.", "required": false, "schema": { "type": "string", "default": "USD" } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2021-05-01T03:52:34+00:00" } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Payment Attempts to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "payment_intent_id", "in": "query", "description": "Payment Intent unique identifier of the attempt.", "required": false, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" } }, { "name": "status", "in": "query", "description": "Payment Attempt status.", "required": false, "schema": { "type": "string", "default": "AUTHORIZED" }, "examples": { "default": { "value": "CAPTURE_REQUESTED,SETTLED,PAID,CAPTURE_REQUESTED,CANCELLED" } } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentAttempt" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "att_hkpd12a3456hi7", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "CAPTURE_REQUESTED", "payment_method_transaction_id": "1234567890", "acquirer_reference_number": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 100, "refunded_amount": 0, "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {} } } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_attempts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "page_num": 0, "page_size": 10, "status": "CAPTURE_REQUESTED,SETTLED,PAID,CAPTURE_REQUESTED,CANCELLED" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "att_hkpd12a3456hi7", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "CAPTURE_REQUESTED", "payment_method_transaction_id": "1234567890", "acquirer_reference_number": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 100, "refunded_amount": 0, "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {} } } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_attempts/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Attempts" ], "summary": "1|Retrieve a Payment Attempt", "operationId": "retrievePaymentAttempt", "parameters": [ { "name": "id", "in": "path", "description": "Payment Attempt unique identifier.", "required": true, "schema": { "type": "string", "default": "att_tHambObszjrtrCbazat45Im1F0" }, "examples": { "default": { "value": "att_hkpd12a3456hi7" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAttempt" }, "examples": { "default": { "value": { "id": "att_hkpd12a3456hi7", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "CAPTURE_REQUESTED", "payment_method_transaction_id": "1234567890", "acquirer_reference_number": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 100, "refunded_amount": 0, "settle_via": "airwallex", "authentication_data": { "ds_data": {} }, "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_attempts/att_hkpd12a3456hi7", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "att_hkpd12a3456hi7", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "CAPTURE_REQUESTED", "payment_method_transaction_id": "1234567890", "acquirer_reference_number": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 100, "refunded_amount": 0, "settle_via": "airwallex", "authentication_data": { "ds_data": {} }, "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/create": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "1|Create a Payment Consent", "description": "Create a Payment Consent.", "operationId": "createPaymentConsent", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customer_id", "next_triggered_by", "request_id" ], "properties": { "connected_account_id": { "type": "string", "description": "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." }, "customer_id": { "type": "string", "description": "Unique identifier from Airwallex of the customer who will make the payment with this Payment Consent." }, "merchant_trigger_reason": { "type": "string", "description": "Indicate whether the subsequent payments are scheduled. Only applicable when `next_triggered_by` is `merchant`.\n \nDefault: `unscheduled`.", "enum": [ "installments", "scheduled", "unscheduled" ] }, "metadata": { "type": "object", "description": "A set of key-value pairs that can be attached to this Payment Consent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "next_triggered_by": { "type": "string", "description": "The party to trigger subsequent payments.", "enum": [ "customer", "merchant" ] }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "terms_of_use": { "type": "object", "required": [ "payment_amount_type" ], "description": "Terms to specify how this Payment Consent will be used.", "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } } } } }, "examples": { "default": { "value": { "customer_id": "cus_hkpdsjz4vg1x3uscdj", "metadata": { "subscriptionNumber": "2025040700000001" }, "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d" } } } } }, "description": "Payment Consent creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_PAYMENT_METHOD", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "subscriptionNumber": "2025040700000001" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0", "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T06:57:15+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `resource_not_found`(invalid `customer_id`)" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_consents/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "customer_id": "cus_hkpdsjz4vg1x3uscdj", "metadata": { "subscriptionNumber": "2025040700000001" }, "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_PAYMENT_METHOD", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "subscriptionNumber": "2025040700000001" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0", "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T06:57:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/{id}/disable": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "7|Disable a Payment Consent", "description": "Disable a Payment Consent by unique identifier. After a Payment Consent is disabled, the status will become `DISABLED` and the Payment Consent cannot be used or updated.", "operationId": "paymentConsents_disable", "parameters": [ { "name": "id", "in": "path", "description": "Payment Consent unique identifier.", "required": true, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" }, "examples": { "default": { "value": "cst_hkpdsjz1vg0x1uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "43c4e930-1130-43ae-bfb2-b60cbfe1297f" } } } } }, "description": "Payment Consent disable request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "43c4e930-1130-43ae-bfb2-b60cbfe1297f", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "DISABLED", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `invalid_status_for_operation`, `provider_declined`, `provider_unavailable`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_consents/cst_hkpdsjz1vg0x1uscdj/disable", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "43c4e930-1130-43ae-bfb2-b60cbfe1297f" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "43c4e930-1130-43ae-bfb2-b60cbfe1297f", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "DISABLED", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents": { "get": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "3|List all Payment Consents", "description": "List all Payment Consents.", "operationId": "listPaymentConsents", "parameters": [ { "name": "customer_id", "in": "query", "description": "The unique identifier of a customer.", "required": false, "schema": { "type": "string", "default": "cus_RZh8rHfqOIxyuwrFyqZpmyBdX7m" } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2021-04-01T03:52:34Z" } }, { "name": "merchant_trigger_reason", "in": "query", "description": "One of `scheduled`, `unscheduled`.", "required": false, "schema": { "type": "string", "default": "scheduled" } }, { "name": "next_triggered_by", "in": "query", "description": "One of `merchant`, `customer`.", "required": false, "schema": { "type": "string", "default": "merchant" } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 1 } } }, { "name": "page_size", "in": "query", "description": "Number of Payment Consents to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "payment_method_id", "in": "query", "description": "The unique identifier of a Payment Method.", "required": false, "schema": { "type": "string", "default": "mtd_u79lnfufjxxfdc0" } }, { "name": "status", "in": "query", "description": "Status of Payment Consent.", "required": false, "schema": { "type": "string", "default": "REQUIRES_PAYMENT_METHOD" }, "examples": { "default": { "value": "REQUIRES_PAYMENT_METHOD,REQUIRES_CUSTOMER_ACTION" } } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2021-04-01T03:52:34Z" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentConsent" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "subscriptionNumber": "2025040700000001" }, "status": "REQUIRES_CUSTOMER_ACTION", "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T06:57:15+00:00", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_consents", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "page_num": 1, "page_size": 10, "status": "REQUIRES_PAYMENT_METHOD,REQUIRES_CUSTOMER_ACTION" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "0a0753bb-ec35-4a29-34bf-1fa712bc162d", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "subscriptionNumber": "2025040700000001" }, "status": "REQUIRES_CUSTOMER_ACTION", "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T06:57:15+00:00", "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "2|Retrieve a Payment Consent", "description": "Retrieve a Payment Consent by unique identifier.", "operationId": "retrievePaymentConsent", "parameters": [ { "name": "id", "in": "path", "description": "Payment Consent unique identifier.", "required": true, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" }, "examples": { "default": { "value": "cst_hkpdsjz1vg0x1uscdj" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "cf682fd8-ce4b-483f-a003-f2533d0a58d2", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_CUSTOMER_ACTION", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "next_action": { "type": "redirect_iframe", "method": "GET", "url": "https://www.example.com/redirect", "stage": "WAITING_DEVICE_DATA_COLLECTION" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_consents/cst_hkpdsjz1vg0x1uscdj", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "cf682fd8-ce4b-483f-a003-f2533d0a58d2", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_CUSTOMER_ACTION", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "next_action": { "type": "redirect_iframe", "method": "GET", "url": "https://www.example.com/redirect", "stage": "WAITING_DEVICE_DATA_COLLECTION" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/{id}/update": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "4|Update a Payment Consent", "description": "Update the metadata of a Payment Consent.", "operationId": "updatePaymentConsent", "parameters": [ { "name": "id", "in": "path", "description": "Payment Consent unique identifier.", "required": true, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" }, "examples": { "default": { "value": "cst_hkpdsjz1vg0x1uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "metadata": { "type": "object", "description": "A set of key-value pairs that will be updated for this Payment Consent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "60ee1700-fdc4-48b2-87e4-0cf21cd2de5e", "metadata": { "foo": "bar" } } } } } }, "description": "Payment Consent update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "60ee1700-fdc4-48b2-87e4-0cf21cd2de5e", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "VERIFIED", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h" }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_consents/cst_hkpdsjz1vg0x1uscdj/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "60ee1700-fdc4-48b2-87e4-0cf21cd2de5e", "metadata": { "foo": "bar" } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "60ee1700-fdc4-48b2-87e4-0cf21cd2de5e", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "VERIFIED", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h" }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/{id}/verify": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "5|Verify a Payment Consent", "description": "Verify the Payment Consent with the `payment_method` details (or `payment_method.id` if reusing an existing one) when the customer is ready to store payment credentials into the Payment Consent for subsequent payments. \n \nAdditional customer actions might be required to complete the verification for some payment methods. In that case, `next_action` will be returned to guide you through the process and the Payment Consent `status` will be updated to `REQUIRES_CUSTOMER_ACTION`. \n \nOnce the `status` becomes `VERIFIED`, the Payment Consent is ready for making subsequent payments. \n \nWhen verifying a Payment Consent initiated by `customer`, if an existing `VERIFIED` Payment Consent already references the provided card or bank account number, the request will be declined with `resource_already_exists` to avoid generating multiple identical Payment Consents.", "operationId": "verify", "parameters": [ { "name": "id", "in": "path", "description": "Payment Consent unique identifier.", "required": true, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" }, "examples": { "default": { "value": "cst_hkpdsjz1vg0x1uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "descriptor": { "type": "string", "description": "Descriptor that may be displayed to the customer during the verification." }, "device_data": { "type": "object", "description": "Client device information. It is recommended to provide this data to increase the odds of having frictionless 3DS.", "properties": { "accept_header": { "type": "string", "description": "Accept header value." }, "browser": { "type": "object", "description": "Browser specific data.", "properties": { "java_enabled": { "type": "boolean", "description": "Is Java enabled?" }, "javascript_enabled": { "type": "boolean", "description": "Is JavaScript enabled?" }, "user_agent": { "type": "string", "description": "User Agent header value." } } }, "device_id": { "type": "string", "description": "Device unique identifier or Advertisement unique identifier or IMEI." }, "ip_address": { "type": "string", "description": "Public IP address, both IPv4 and IPv6 are supported." }, "language": { "type": "string", "description": "Language or locale." }, "location": { "type": "object", "description": "Location data.", "properties": { "lat": { "type": "string", "description": "Latitude." }, "lon": { "type": "string", "description": "Longitude." } } }, "mobile": { "type": "object", "description": "Mobile specific data.", "properties": { "device_model": { "type": "string", "description": "Device model." }, "os_type": { "type": "string", "description": "OS type." }, "os_version": { "type": "string", "description": "OS version." } } }, "screen_color_depth": { "type": "integer", "format": "int32", "description": "Screen color depth in bits." }, "screen_height": { "type": "integer", "format": "int32", "description": "Screen height in pixels." }, "screen_width": { "type": "integer", "format": "int32", "description": "Screen width in pixels." }, "timezone": { "type": "string", "description": "Timezone offset to UTC in hours, with added minutes if necessary." } } }, "payment_method": { "type": "object", "required": [ "type" ], "description": "Payment Method information that will be used for subsequent payments. \n \nWhen `payment_method.type` is set to `card`, `ach_direct_debit`, `bacs_direct_debit`, `becs_direct_debit`, `sepa_direct_debit`, `eft_direct_debit`, `googlepay`, `applepay`, caller must provide either the `payment_method.id` of an existing Payment Method or the full payload of payment method information with which we will generate a new Payment Method.", "properties": { "ach_direct_debit": { "type": "object", "description": "ACH Direct Debit information.", "properties": { "aba_routing_number": { "type": "string", "description": "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`." }, "account_number": { "type": "string", "description": "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`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Account holder name. Required when verification method is `micro_deposit`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `plaid` or `micro_deposit`. Default: `micro_deposit`." } } }, "alipaycn": { "type": "object", "required": [ "flow" ], "description": "Alipaycn information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "alipayhk": { "type": "object", "required": [ "flow" ], "description": "Alipayhk information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "applepay": { "type": "object", "description": "Apple pay information.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "Payment data from Apple Pay Payment Token." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "bacs_direct_debit": { "type": "object", "description": "BACS Direct Debit information.", "properties": { "account_number": { "type": "string", "description": "Required when verification method is `micro_deposit`. Should not be set when verification method is `truelayer`." }, "address": { "type": "object", "required": [ "line1", "postcode", "town" ], "description": "Account holder's address. Required when verification method is `micro_deposit`.", "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes. One of `GB`, `US`. Default to `GB` if not provided." }, "line1": { "type": "string", "description": "House number and street name, e.g., `777 Casino Drive`." }, "line2": { "type": "string", "description": "Locality name, e.g., `Apartment 123`." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address. Should be provided if country code is `US`. Use the two-character ISO3166-2:US state code." }, "town": { "type": "string", "description": "Post town." } } }, "bank_name": { "type": "string", "description": "Bank of the account. Required when verification method is `truelayer`. Should not be set when verification method is `micro_deposit`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Account holder name. Required when verification method is `micro_deposit`." }, "sort_code": { "type": "string", "description": "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`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `truelayer` or `micro_deposit`. Default: `micro_deposit`." } } }, "becs_direct_debit": { "type": "object", "required": [ "account_number", "bsb_number", "owner_email", "owner_name" ], "description": "BECS Direct Debit information.", "properties": { "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email." }, "owner_name": { "type": "string", "description": "Account holder name." } } }, "card": { "type": "object", "description": "Card information.", "properties": { "additional_info": { "type": "object", "description": "Additional information of external network token requestor. Should be provided when number_type is `EXTERNAL_NETWORK_TOKEN`.", "properties": { "merchant_verification_value": { "type": "string", "description": "Merchant Verification Value (Provided by VISA during onboarding)\nor\nMasterCard Assigned ID (Provided by MasterCard during onboarding)." }, "token_requestor_id": { "type": "string", "description": "Token requestor unique identifier (Provided by card schemes during onboarding)." } } }, "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "cryptogram": { "type": "string", "description": "The cryptogram value. Must be provided if `card.number_type` is `EXTERNAL_NETWORK_TOKEN`. Maximum length is 28." }, "cvc": { "type": "string", "description": "CVC of this card. Required except using external network tokenized." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider (3RI for MIT subsequent transaction).", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "name": { "type": "string", "description": "Card holder name. Maximum length is 128." }, "number": { "type": "string", "description": "Card number." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`. Default: `PAN`." }, "three_ds_action": { "type": "string", "description": "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." } } }, "dana": { "type": "object", "required": [ "flow" ], "description": "Dana information. `flow` can be one of `qrcode`, `mobile_web`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "eft_direct_debit": { "type": "object", "description": "EFT Direct Debit information.", "properties": { "account_number": { "type": "string", "description": "4-17 digits number to identify a bank account in Canada. Required when verification method is `micro_deposit` or `micro_deposit_and_debit`. Should not be set when verification method is `plaid`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "institution_number": { "type": "string", "description": "3-digit number to identify a institution in Canada. Required when verification method is `micro_deposit` or `micro_deposit_and_debit`.Should not be set when verification method is `plaid`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email. Required when verification method is `micro_deposit` or `micro_deposit_and_debit`." }, "owner_name": { "type": "string", "description": "Account holder name. Required when verification method is `micro_deposit` or `micro_deposit_and_debit`." }, "transit_number": { "type": "string", "description": "5-digit number to identify a bank in Canada. Required when verification method is `micro_deposit` or `micro_deposit_and_debit`. Should not be set when verification method is `plaid`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `micro_deposit` or `micro_deposit_and_debit`. Default: `micro_deposit`." } } }, "gcash": { "type": "object", "required": [ "flow" ], "description": "Gcash information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "googlepay": { "type": "object", "description": "Google pay information.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "A UTF-8 encoded, serialized JSON object with the keys specified." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider. Only applicable when Google Pay `PAN_ONLY` authentication method is used.", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "id": { "type": "string", "description": "Unique identifier of the Payment Method attached for subsequent payments." }, "kakaopay": { "type": "object", "required": [ "flow" ], "description": "Kakaopay information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "payto": { "type": "object", "description": "Payto information.", "properties": { "bsb": { "type": "object", "required": [ "account_name", "account_number", "bsb_number" ], "properties": { "account_name": { "type": "string", "description": "The account name." }, "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." } } }, "pay_id": { "type": "object", "properties": { "australian_business_number": { "type": "string", "description": "11 digits number to identify the Pay Id. Required when `phone_number`, `owner_email`, and `organisation_id` is null." }, "organisation_id": { "type": "string", "description": "The organisation id of the recipient. The Pay ID must be in the format of `payid:airwallex.com`." }, "owner_email": { "type": "string", "description": "owner email to identify the Pay Id. Required when `phone_number`, `australian_business_number`, and `organisation_id` is null." }, "payer_name": { "type": "string", "description": "Payer name of the Pay Id." }, "phone_number": { "type": "string", "description": "The phone number of the Pay Id. Required when `owner_email`, `australian_business_number`, and `organisation_id` is null." } } } } }, "rabbit_line_pay": { "type": "object", "required": [ "flow" ], "description": "Rabbit LINE Pay information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "sepa_direct_debit": { "type": "object", "description": "SEPA Direct Debit information.", "properties": { "address": { "type": "object", "required": [ "postcode", "street", "town" ], "description": "Account holder's address.", "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "street": { "type": "string", "description": "street of the address. " }, "town": { "type": "string", "description": "town of the address." } } }, "bank_name": { "type": "string", "description": "Bank of the account. Required when verification method is `truelayer`. You can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "country_code": { "type": "string", "description": "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": { "type": "string", "description": "IBAN of the bank account. Required when verification method is `micro_deposit`. Should not be set when verification method is `truelayer`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Account holder name. Required when verification method is `micro_deposit`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `truelayer` or `micro_deposit`. Default: `micro_deposit`." } } }, "tng": { "type": "object", "required": [ "flow" ], "description": "Tng information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "truemoney": { "type": "object", "required": [ "flow" ], "description": "Truemoney information. `flow` can be one of `qrcode`, `mobile_web`, `mobile_app`.", "properties": { "flow": { "type": "string", "description": "Refer to the specification above." }, "os_type": { "type": "string", "description": "One of `ios`, `android`. `os_type` must be set when `flow` is `mobile_web`, `mobile_app`." } } }, "type": { "type": "string", "description": "Type of the Payment Method. One of `card`, `googlepay`, `applepay`, `alipayhk`, `truemoney`, `gcash`, `dana`, `kakaopay`, `tng`, `alipaycn`, `rabbit_line_pay`, `wechatpay`, `ach_direct_debit`, `bacs_direct_debit`, `becs_direct_debit`, `sepa_direct_debit`, `eft_direct_debit`." }, "wechatpay": { "type": "object", "required": [ "flow" ], "description": "Wechat information.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "flow": { "type": "string", "description": "The specific WeChat Pay flow to use. One of `qrcode`, `official_account`, `mini_program`, `mobile_app`, `mobile_web`." }, "open_id": { "type": "string", "description": "Required when `flow` is `mini_program`." } } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after Payment Consent verification." }, "risk_control_options": { "type": "object", "description": "Risk Control Options.", "properties": { "skip_risk_processing": { "type": "boolean", "description": "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`. " }, "tra_applicable": { "type": "boolean", "description": "Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing." } } }, "verification_options": { "type": "object", "description": "Additional information needed to verify a Payment Consent.", "properties": { "applepay": { "type": "object", "required": [ "currency" ], "description": "Apple pay information for verifying Payment Consent.", "properties": { "amount": { "type": "number", "description": "The alternative amount of verification if zero amount is not acceptable for the provider.\nThe transaction of this amount should be reverted once the verification process finished.\nMust be greater than 0. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "currency": { "type": "string", "description": "Currency of the initial Payment Intent to verify the Payment Consent.\nThree-letter ISO 4217 currency code. Must be a [supported currency](/docs/payments/supported-currencies)." } } }, "card": { "type": "object", "required": [ "currency" ], "description": "Card information for verifying Payment Consent.", "properties": { "amount": { "type": "number", "description": "The alternative amount of verification if zero amount is not acceptable for the provider.\nThe transaction of this amount should be reverted once the verification process finished.\nMust be greater than 0. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "currency": { "type": "string", "description": "Currency of the initial Payment Intent to verify the Payment Consent.\nThree-letter ISO currency code. Must be a [supported currency](/docs/payments/supported-currencies)." } } }, "googlepay": { "type": "object", "required": [ "currency" ], "description": "Google pay information for verifying Payment Consent.", "properties": { "amount": { "type": "number", "description": "The alternative amount of verification if zero amount is not acceptable for the provider.\nThe transaction of this amount should be reverted once the verification process finished.\nMust be greater than 0. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "currency": { "type": "string", "description": "Currency of the initial Payment Intent to verify the Payment Consent.\nThree-letter ISO currency code. Must be a [supported currency](/docs/payments/supported-currencies)." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider (3RI for MIT subsequent transaction).", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "three_ds_action": { "type": "string", "description": "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." } } }, "wechatpay": { "type": "object", "description": "WeChat Pay information for verifying Payment Consent.", "properties": { "currency": { "type": "string", "description": "Indicates the currency of subsequent Payment Intent that will be processed with this Payment Consent. Please refer to [supported currencies](/docs/payments/supported-currencies)." } } } } } } }, "examples": { "default": { "value": { "request_id": "3a3bafab-79ac-4e75-a966-01cf6c62056f", "device_data": { "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "language": "en-AU", "screen_color_depth": 32, "screen_height": 800, "screen_width": 390 }, "payment_method": { "type": "card", "card": { "number": "4035501000000008", "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "cvc": "737" } }, "verification_options": { "card": { "amount": 0.01, "currency": "USD" } }, "return_url": "https://www.airwallex.com", "should_check_duplicate_cit_consent": false } } } } }, "description": "Payment Consent verify request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "3a3bafab-79ac-4e75-a966-01cf6c62056f", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_CUSTOMER_ACTION", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "next_action": { "type": "redirect_iframe", "method": "GET", "url": "https://www.example.com/redirect", "stage": "WAITING_DEVICE_DATA_COLLECTION" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `frequency_above_limit`, `invalid_status_for_operation`, `provider_unavailable`, `configuration_error`, `authentication_declined`, `risk_declined`, `resource_already_exists`, `provider_declined`, `quote_expired`, `payment_method_not_allowed`, `card_brand_not_supported`, `issuer_declined`, `no_3ds_liability_shift`, `3ds_not_supported`, `rejected_by_routing_rules`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_consents/cst_hkpdsjz1vg0x1uscdj/verify", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "3a3bafab-79ac-4e75-a966-01cf6c62056f", "device_data": { "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "language": "en-AU", "screen_color_depth": 32, "screen_height": 800, "screen_width": 390 }, "payment_method": { "type": "card", "card": { "number": "4035501000000008", "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "cvc": "737" } }, "verification_options": { "card": { "amount": 0.01, "currency": "USD" } }, "return_url": "https://www.airwallex.com", "should_check_duplicate_cit_consent": false }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "3a3bafab-79ac-4e75-a966-01cf6c62056f", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "REQUIRES_CUSTOMER_ACTION", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "initial_payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_method": { "type": "card", "id": "mtd_hkpds1z4zh00i2eb1h", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "metadata": { "amount": "10", "subscriptionNumber": "2025040700000001" }, "mandate": {}, "next_action": { "type": "redirect_iframe", "method": "GET", "url": "https://www.example.com/redirect", "stage": "WAITING_DEVICE_DATA_COLLECTION" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_consents/{id}/verify_continue": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "summary": "6|Continue To Verify a Payment Consent", "description": "Continue verify a payment Consent, required when verification method is micro-deposit. Merchants can use this api to verify the amount of micro-deposit if the payment consent wait for the verification result of micro-deposit. Micro-debit is triggered when micro-deposit is triggered, micro-debit is not part of micro-deposit verification. If micro-deposit is success and micro-debit failed, merchants can use this api to retry micro-debit.\n", "operationId": "verifyContinue", "parameters": [ { "name": "id", "in": "path", "description": "Payment Consent unique identifier.", "required": true, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" }, "examples": { "default": { "value": "cst_hkpdsjz1vg0x1uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "micro_deposit": { "type": "object", "description": "The verification request of micro-deposit, required only if type is `verify_micro_deposits`.", "properties": { "amounts": { "type": "array", "description": "The amounts of the micro-deposit in the shopper’s bank statement. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units.", "items": { "type": "number" } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." }, "type": { "type": "string", "description": "Type of the continue type.", "enum": [ "retry_micro_debit", "verify_micro_deposits" ] } } }, "examples": { "default": { "value": { "request_id": "a1b6d685-ce24-4214-afda-71922546c57a", "type": "verify_micro_deposits", "micro_deposit": { "amounts": [ 0.01, 0.02 ] } } } } } }, "description": "Payment Consent continue verify request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentConsent" }, "examples": { "default": { "value": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "a1b6d685-ce24-4214-afda-71922546c57a", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "PENDING", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "foo": "bar" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0", "mandate": { "type": "verify_micro_deposits", "sepa_direct_debit": { "creditor_identifier": "DE123456789", "reference": "REF123456789" }, "version": "1.0", "accepted_at": "2021-08-31T07:01:15+00:00" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `frequency_above_limit`, `invalid_status_for_operation`, `provider_unavailable`, `configuration_error`, `authentication_declined`, `risk_declined`, `resource_already_exists`, `provider_declined`, `quote_expired`, `payment_method_not_allowed`, `card_brand_not_supported`, `issuer_declined`, `no_3ds_liability_shift`, `3ds_not_supported`, `rejected_by_routing_rules`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_consents/cst_hkpdsjz1vg0x1uscdj/verify_continue", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "a1b6d685-ce24-4214-afda-71922546c57a", "type": "verify_micro_deposits", "micro_deposit": { "amounts": [ 0.01, 0.02 ] } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "cst_hkpdsjz1vg0x1uscdj", "request_id": "a1b6d685-ce24-4214-afda-71922546c57a", "customer_id": "cus_hkpdsjz4vg1x3uscdj", "status": "PENDING", "next_triggered_by": "merchant", "merchant_trigger_reason": "scheduled", "metadata": { "foo": "bar" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiY29uc2VudF9pZCI6ImNzdF9oa3Bkc2p6MXZnMHgxdXNjZGoiLCJjdXN0b21lcl9pZCI6ImN1c19oa3Bkc2p6NHZnMXgzdXNjZGoifQ.c8zs0QlpUy_NwWy_JsHqHSiRpbtpGnIVWNsVHsSvJQ0", "mandate": { "type": "verify_micro_deposits", "sepa_direct_debit": { "creditor_identifier": "DE123456789", "reference": "REF123456789" }, "version": "1.0", "accepted_at": "2021-08-31T07:01:15+00:00" }, "created_at": "2021-08-31T06:57:15+00:00", "updated_at": "2021-08-31T07:01:15+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes/{id}/accept": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "4|Accept a Payment Dispute", "description": "Accept a Payment Dispute. When a Payment Dispute is under status `REQUIRES_RESPONSE`, you can accept it to avoid further escalation and fees. Accepting the dispute during `RFI` stage will trigger a full refund. The refund amount and reason can be customized by populating the `refund` field.", "operationId": "accept", "parameters": [ { "name": "id", "in": "path", "description": "Payment Dispute unique identifier.", "required": true, "schema": { "type": "string", "default": "dst_hkst98v9kgk2t7otgl0" }, "examples": { "default": { "value": "dst_hkpdw2eqp9oie" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "accepted_by": { "type": "string", "description": "User unique identifier of person/system accepts Payment Dispute." }, "description": { "type": "string", "description": "The accept description." }, "reason": { "type": "string", "description": "The accept reason, `OTHERS` is used by default. One of \n\n- `AGREEMENT_REACHED_WITH_CUSTOMER`\n- `CUSTOMER_RELATIONSHIP_MAINTENANCE` \n- `LOW_VALUE_TRANSACTION`\n- `VALID_CUSTOMER_DISPUTE` \n- `COLLABORATION_ACCEPTED_MANUAL`\n- `OTHERS`.\n" }, "refund": { "type": "object", "description": "The Refund to be created. It is applicable when accepting a dispute at the `RFI` stage.", "properties": { "amount": { "type": "number", "description": "The refund amount when accepting `RFI`. If not specified, it will be same as the remaining amount that has been captured but not yet refunded. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "reason": { "type": "string", "description": "The refund reason when accepting `RFI`. `OTHERS` is used by default. One of `REQUESTED_BY_CUSTOMER`, `DUPLICATE`, `FRAUDULENT`, `ABANDONED`, and `OTHERS`." } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." } } }, "examples": { "default": { "value": { "accepted_by": "airwallex", "description": "Accepted", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "request_id": "dd9a28c6-ef7b-44fe-b845-db487bf401c5", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" } } } } } }, "description": "Dispute respond request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDispute" }, "examples": { "default": { "value": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_disputes/dst_hkpdw2eqp9oie/accept", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "accepted_by": "airwallex", "description": "Accepted", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "request_id": "dd9a28c6-ef7b-44fe-b845-db487bf401c5", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_dispute:write", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes/{id}/challenge": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "5|Challenge a Payment Dispute", "description": "Challenge a Payment Dispute. When you receive a Payment Dispute in Chargeback or RFI stage with `REQUIRES_RESPONSE` status then you can further challenge the Payment Dispute. Challenge response should include at least one of the recommended evidence document types attached, please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files and refer to it under `supporting_documents`. There are different suggested information sections in different stages, please check if the section is applicable before submission.", "operationId": "challenge", "parameters": [ { "name": "id", "in": "path", "description": "Payment Dispute unique identifier.", "required": true, "schema": { "type": "string", "default": "dst_hkst98v9kgk2t7otgl0" }, "examples": { "default": { "value": "dst_hkpdw2eqp9oie" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "challenge_method": { "type": "string", "description": "The method used to challenge the dispute. Possible values: \n\n- **AI_DISPUTE_AUTOMATION**: Challenge using [AI Dispute Automation](/docs/payments/payment-operations/disputes/dispute-automation)\n - Applicable when Payment Dispute stage is `CHARGEBACK` and AI Dispute Automation status is `AVAILABLE`\n- **STANDARD**: Challenge using standard flow\n\nDefault to `STANDARD` if not provided." }, "challenged_by": { "type": "string", "description": "User unique identifier of person/system challenges Payment Dispute." }, "customer_info": { "type": "object", "description": "Customer information. Applicable when Payment Dispute stage is `CHARGEBACK`.", "properties": { "billing_address": { "type": "string", "description": "Customer billing address." }, "device_id": { "type": "string", "description": "Customer device unique identifier." }, "email": { "type": "string", "description": "Customer email." }, "ip": { "type": "string", "description": "Customer ip." }, "name": { "type": "string", "description": "Customer name." }, "phone_number": { "type": "string", "description": "Customer phone number." } } }, "delivery_info": { "type": "object", "description": "The delivery information of goods or services.", "properties": { "address": { "type": "string", "description": "The shipping address. Applicable at stage `RFI`." }, "delivered_at": { "type": "string", "format": "date-time", "description": "The date when services or goods are delivered." }, "fee_amount": { "type": "number", "description": "The amount of shipping fee. Applicable at stage `RFI`. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "fee_currency": { "type": "string", "description": "The currency of shipping fee. Applicable at stage `RFI`. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "name": { "type": "string", "description": "The recipient's name. Applicable at stage `RFI`." }, "phone_number": { "type": "string", "description": "The recipient's phone number. Applicable at stage `RFI`." }, "shipped_at": { "type": "string", "format": "date-time", "description": "The shipping date (the expected delivery date for `RFI`)." }, "shipping_company": { "type": "string", "description": "The company name managing this delivery, such as asendia-usa, 4px, and so on." }, "shipping_method": { "type": "string", "description": "The shipping method, such as Priority Mail, Flat rate, and so on. Applicable at stage `RFI`." }, "status": { "type": "string", "description": "The shipping status, such as `SHIPPED`, `DELIVERED`, and so on. Applicable at stage `RFI`." }, "tracking_number": { "type": "string", "description": "The shipping tracking number." } } }, "description": { "type": "string", "description": "The additional description of the Payment Dispute. \nDeprecated. Use `supporting_documents.documents.description` instead." }, "duplicate_charge_info": { "type": "object", "description": "The defense information when a Payment Dispute is raised due to a duplicate charge.", "properties": { "explanation": { "type": "string", "description": "The explanation of duplicate payment." }, "payment_id": { "type": "string", "description": "The unique identifier of duplicate payment." } } }, "evidence": { "type": "object", "description": "Evidence required when challenge_method is set to `AI_DISPUTE_AUTOMATION`.", "properties": { "access_activity_file_ids": { "type": "array", "description": "File unique identifiers of access activity files. Provide screenshots from your activity log that show the customer's on-site behaviour, such as login times or download timestamps. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "authenticity_proof_file_ids": { "type": "array", "description": "File unique identifiers of authenticity proof files. Provide documentation that confirms your products are genuine and not counterfeit. This can include certificates, supplier invoices, or brand authorization letters. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "customer_communication_file_ids": { "type": "array", "description": "File unique identifiers of customer communication files. Provide copies of any emails, chat logs, or messages with the customer that show communication before or after the purchase. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "duplicate_acquirer_reference_number": { "type": "string", "description": "Acquirer reference number of the duplicate transaction." }, "duplicate_explanation": { "type": "string", "description": "Explanation of the duplicate transaction." }, "duplicate_payment_file_ids": { "type": "array", "description": "File unique identifiers of duplicate payment files. Provide documents that show how this transaction differs from any potential duplicates. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "duplicate_transaction_amount_currency": { "type": "string", "description": "Amount and currency of the duplicate transaction." }, "duplicate_transaction_created_at": { "type": "string", "format": "date-time", "description": "Creation date of the duplicate transaction." }, "merchant_business_model_description": { "type": "string", "description": "Description of the merchant's business model." }, "order_fulfilled_at": { "type": "string", "format": "date-time", "description": "Date and time when the order was fulfilled." }, "order_fulfillment_file_ids": { "type": "array", "description": "File unique identifiers of order fulfillment files. Provide screenshots of delivery confirmation or shipment tracking information that clearly show the order was successfully delivered. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "order_snapshot_file_ids": { "type": "array", "description": "File unique identifiers of order snapshot files. Provide screenshots of the customer's receipt or order confirmation page as evidence that the customer placed the order. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "previous_dispute_won_on_same_card_file_ids": { "type": "array", "description": "File unique identifiers of previous won disputes on same card. Provide evidence of any previous disputes that you won for transactions using the same card. This helps establish a history of legitimate transactions. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "previous_purchase_similar_product_file_ids": { "type": "array", "description": "File unique identifiers of previous purchases of similar products. Provide proof of the customer's past purchases of similar items to show their history and relationship with your business. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "product_consumption_file_ids": { "type": "array", "description": "File unique identifiers of product usage files. Provide evidence that the customer has used the product or service, such as a login record or usage timestamp. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "product_description": { "type": "string", "description": "Description of the product." }, "product_snapshot_file_ids": { "type": "array", "description": "File unique identifiers of product snapshot files. Provide a screenshot of the product page or a photo of the item to show that the product matches its description. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "refund_policy_file_ids": { "type": "array", "description": "File unique identifiers for your refund policy documents. Upload all documents that describe your refund policy. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "refund_policy_url": { "type": "string", "description": "URL of the refund policy page." }, "user_agreement_file_ids": { "type": "array", "description": "File unique identifiers of user agreement files. Upload your user agreement forms that outline the terms and conditions for your customers. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } } } }, "order_info": { "type": "object", "description": "The order information. Applicable when Payment Dispute stage is `RFI`.", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Time at which this order was created." }, "id": { "type": "string", "description": "The order unique identifier." }, "invoice_number": { "type": "string", "description": "The invoice number of order." }, "products": { "type": "array", "description": "The products of order.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories." }, "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 128 characters." }, "desc": { "type": "string", "description": "Product description. Maximum of 500 characters." }, "effective_end_at": { "type": "string", "description": "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`)." }, "effective_start_at": { "type": "string", "description": "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`)." }, "image_url": { "type": "string", "description": "The preview image url for this product, which is usually displayed as thumbnail in the order details." }, "name": { "type": "string", "description": "Name of the product. Maximum of 255 characters." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "seller": { "type": "object", "description": "Seller info of the purchase order.", "properties": { "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system." } } }, "sku": { "type": "string", "description": "Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters." }, "type": { "type": "string", "description": "Type of product, such as `physical_good`, `intangible_good`, or `service`. Maximum of 128 characters." }, "unit_price": { "type": "number", "description": "Product unit price." }, "url": { "type": "string", "description": "The url that links to the product page at merchant site." } } } }, "total_amount": { "type": "number", "description": "The total amount of order. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "total_currency": { "type": "string", "description": "The currency of total amount in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." } } }, "product_description": { "type": "string", "description": "The description of the product. Applicable when the Payment Dispute stage is `CHARGEBACK`." }, "product_type": { "type": "string", "description": "The type of the product. Possible values: `PHYSICAL_GOODS`, `DIGITAL_PRODUCT_OR_SERVICE`, `OFFLINE_SERVICE`, `TRAVEL`, `RESERVE_OR_BOOKING`, `OTHERS`. Required when the Payment Dispute stage is `CHARGEBACK`." }, "reason": { "type": "string", "description": "The reason why the merchant challenges the dispute. Possible values: \n\n- **CUSTOMER_WITHDRAWN**: The customer withdrew the dispute\n- **CUSTOMER_REFUNDED**: The customer has already been refunded\n- **PRODUCT_RECEIVED**: The customer has already received / will receive the product or service\n- **PURCHASE_HISTORY**: The customer has a purchasing history with me\n- **NOT_ENTITLED**: The customer is not entitled to refund\n- **SEPARATE_PRODUCT**: The customer purchased separate products or services\n- **AUTHENTIC_PRODUCT**: The product is not damaged, defective or counterfeit\n- **OTHER_REASONS**: Other reasons for challenging.\n" }, "refund_refusal_reason": { "type": "string", "description": "Explanation of why refund is refused. Applicable when Payment Dispute stage is `CHARGEBACK`." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." }, "seller_info": { "type": "object", "description": "Seller information. Applicable when Payment Dispute stage is `RFI`.", "properties": { "name": { "type": "string", "description": "Seller name." }, "store_name": { "type": "string", "description": "Store name." }, "store_physical_address": { "type": "string", "description": "Store physical address." }, "store_url": { "type": "string", "description": "Store URL." } } }, "supporting_documents": { "type": "object", "description": "The file unique identifiers of support documents.", "properties": { "customer_communication_documents": { "type": "array", "description": "The file IDs of customer communication. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "customer_signature_documents": { "type": "array", "description": "The file IDs of customer signature. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "documents": { "type": "array", "description": "List of documents.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Additional file descriptions or explanations." }, "file_ids": { "type": "array", "description": "File unique identifiers of the documents.", "items": { "type": "string" } }, "type": { "type": "string", "description": "Type of the documents. Possible values: `PRIMARY`, `ORDER`, `CUSTOMER`, `OTHER`.\n\n- **PRIMARY**: The primary evidence depends on the challenge reason.\n- **ORDER**: Order related evidence.\n- **CUSTOMER**: Customer related evidence.\n- **OTHER**: Other supporting evidence.\n" } } } }, "duplicate_charge_defense_documents": { "type": "array", "description": "The file IDs of duplicate payment evidence. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "other_documents": { "type": "array", "description": "The list of file IDs of other documents. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "proof_of_delivery_documents": { "type": "array", "description": "The file IDs of proof of delivery. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "receipt_documents": { "type": "array", "description": "The file IDs of the receipt. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "refund_policy_documents": { "type": "array", "description": "The file IDs of the refund policy. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } } } } } }, "examples": { "default": { "value": { "challenged_by": "airwallex", "customer_info": { "billing_address": "1460 Mission St.#02W101, San Francisco, CA 94103, US", "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "email": "john.doe@example.com", "ip": "123.123.123.123", "name": "John Doe", "phone_number": "+1 1234567890" }, "delivery_info": { "address": "address", "delivered_at": "2023-10-01T10:00:00Z", "fee_amount": 0, "fee_currency": "null", "name": "null", "phone_number": "null", "shipped_at": "2023-10-01T10:00:00Z", "shipping_company": "SF", "shipping_method": "null", "status": "null", "tracking_number": "123456789" }, "product_description": "product description", "product_type": "OFFLINE_SERVICE", "request_id": "0cb05018-7ccd-42fa-9a5b-7d5197b9fb15", "supporting_documents": { "documents": [ { "type": "OTHER", "file_ids": [ "MTRkYjkyZWYtZTBh12tvbmcsfCxFdmlkZW5jZV9Qcm92aWRlZF9Gb3JfMTc0NDE3Nzg4NzU3Ng" ] } ] } } } } } }, "description": "Payment Dispute respond request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDispute" }, "examples": { "default": { "value": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "CHALLENGED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "challenge_details": [ { "stage": "CHARGEBACK", "product_type": "OFFLINE_SERVICE", "product_description": "product description", "customer_info": { "name": "John Doe", "email": "john.doe@example.com", "ip": "123.123.123.123", "billing_address": "1460 Mission St.#02W101, San Francisco, CA 94103, US", "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "phone_number": "+1 1234567890" }, "delivery_info": { "shipped_at": "2023-10-01T10:00:00+00:00", "delivered_at": "2023-10-01T10:00:00+00:00", "address": "address", "shipping_company": "SF", "tracking_number": "123456789" }, "supporting_documents": { "documents": [ { "type": "OTHER", "file_ids": [ "MTRkYjkyZWYtZTBh12tvbmcsfCxFdmlkZW5jZV9Qcm92aWRlZF9Gb3JfMTc0NDE3Nzg4NzU3Ng" ] } ] }, "challenged_by": "airwallex", "challenged_at": "2023-10-01T10:00:00+00:00", "reason": "Fraudulent transaction" } ], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_disputes/dst_hkpdw2eqp9oie/challenge", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "challenged_by": "airwallex", "customer_info": { "billing_address": "1460 Mission St.#02W101, San Francisco, CA 94103, US", "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "email": "john.doe@example.com", "ip": "123.123.123.123", "name": "John Doe", "phone_number": "+1 1234567890" }, "delivery_info": { "address": "address", "delivered_at": "2023-10-01T10:00:00Z", "fee_amount": 0, "fee_currency": "null", "name": "null", "phone_number": "null", "shipped_at": "2023-10-01T10:00:00Z", "shipping_company": "SF", "shipping_method": "null", "status": "null", "tracking_number": "123456789" }, "product_description": "product description", "product_type": "OFFLINE_SERVICE", "request_id": "0cb05018-7ccd-42fa-9a5b-7d5197b9fb15", "supporting_documents": { "documents": [ { "type": "OTHER", "file_ids": [ "MTRkYjkyZWYtZTBh12tvbmcsfCxFdmlkZW5jZV9Qcm92aWRlZF9Gb3JfMTc0NDE3Nzg4NzU3Ng" ] } ] } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "CHALLENGED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "challenge_details": [ { "stage": "CHARGEBACK", "product_type": "OFFLINE_SERVICE", "product_description": "product description", "customer_info": { "name": "John Doe", "email": "john.doe@example.com", "ip": "123.123.123.123", "billing_address": "1460 Mission St.#02W101, San Francisco, CA 94103, US", "device_id": "59ec5db9-399c-4043-9a6c-fcd1a48d99aa", "phone_number": "+1 1234567890" }, "delivery_info": { "shipped_at": "2023-10-01T10:00:00+00:00", "delivered_at": "2023-10-01T10:00:00+00:00", "address": "address", "shipping_company": "SF", "tracking_number": "123456789" }, "supporting_documents": { "documents": [ { "type": "OTHER", "file_ids": [ "MTRkYjkyZWYtZTBh12tvbmcsfCxFdmlkZW5jZV9Qcm92aWRlZF9Gb3JfMTc0NDE3Nzg4NzU3Ng" ] } ] }, "challenged_by": "airwallex", "challenged_at": "2023-10-01T10:00:00+00:00", "reason": "Fraudulent transaction" } ], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_dispute:write", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes": { "get": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "2|List all Payment Disputes", "description": "List all Payment Disputes using stage, status, reason code, due date, created time or updated time.", "operationId": "listPaymentDisputes", "parameters": [ { "name": "connected_account_id", "in": "query", "description": "Optional Airwallex-assigned identifier of the connected account to filter by. Only applicable to platforms.", "required": false, "schema": { "type": "string" } }, { "name": "customer_id", "in": "query", "description": "The customer unique identifier of original payment.", "required": false, "schema": { "type": "string", "default": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } }, { "name": "customer_name", "in": "query", "description": "The customer name of original payment.", "required": false, "schema": { "type": "string", "default": "John Doe" } }, { "name": "from_created_at", "in": "query", "description": "The start time of created_at in ISO8601 format.", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+0000" } }, { "name": "from_due_at", "in": "query", "description": "The start time of due_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+00:00" } }, { "name": "from_updated_at", "in": "query", "description": "The start time of updated_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+00:00" } }, { "name": "merchant_order_id", "in": "query", "description": "The order unique identifier of original payment.", "required": false, "schema": { "type": "string", "default": "123456" } }, { "name": "page", "in": "query", "description": "`0` or the BASE 64 encoded resource unique identifier of Payment Dispute and navigation direction to indicate the page should be returned. `0` is used by default for initial page.", "required": false, "schema": { "type": "string", "default": "0" }, "examples": { "default": { "value": "0" } } }, { "name": "payment_intent_id", "in": "query", "description": "Payment Dispute status.", "required": false, "schema": { "type": "string", "default": "int_sgstfwxj9gkanu6hezi" } }, { "name": "payment_method_type", "in": "query", "description": "The payment method type of original payment.", "required": false, "schema": { "type": "string", "default": "VISA" } }, { "name": "reason_code", "in": "query", "description": "Payment Dispute reason code.", "required": false, "schema": { "type": "string", "default": "10.4" } }, { "name": "size", "in": "query", "description": "Number of Payment Disputes to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "stage", "in": "query", "description": "Payment Dispute stage.", "required": false, "schema": { "type": "string", "default": "CHARGEBACK" } }, { "name": "status", "in": "query", "description": "Payment Dispute status.", "required": false, "schema": { "type": "string", "default": "REQUIRES_RESPONSE" } }, { "name": "to_created_at", "in": "query", "description": "The end time of created_at in ISO8601 format.", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+0000" } }, { "name": "to_due_at", "in": "query", "description": "The end time of due_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+00:00" } }, { "name": "to_updated_at", "in": "query", "description": "The end time of updated_at in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2023-08-08T08:00:00+00:00" } }, { "name": "transaction_type", "in": "query", "description": "The transaction type of the original transaction. Possible values: `PAYMENT`, `REFUND`.", "required": false, "schema": { "type": "string", "default": "PAYMENT" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseDTOOfPaymentAcceptancePaymentDispute" }, "examples": { "default": { "value": { "items": [ { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "mode": "COLLABORATION", "issuer_comment": "", "issuer_documents": [], "amount": 100, "currency": "USD", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_disputes", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "page": "0", "size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "mode": "COLLABORATION", "issuer_comment": "", "issuer_documents": [], "amount": 100, "currency": "USD", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe" } ] } } ], "x-scope": [ { "scope": "payment_dispute:read", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes/{id}/related_payment_intents": { "get": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "6|List all Related Payment Intents", "description": "Get related payment intents for a Payment Dispute. Only applicable when the dispute reason type is `FRAUDULENT` or `DUPLICATE_CHARGE`. ", "operationId": "listRelatedPaymentIntents", "parameters": [ { "name": "id", "in": "path", "description": "Payment Dispute unique identifier.", "required": true, "schema": { "type": "string", "default": "dst_hkst98v9kgk2t7otgl0" }, "examples": { "default": { "value": "{id}" } } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "schema": { "type": "string", "default": "0" }, "examples": { "default": { "value": "0" } } }, { "name": "page_size", "in": "query", "description": "Number of related payment intents to be listed per page. Maximum is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 10 } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponseDTOOfPaymentAcceptanceRelatedOrder" }, "examples": { "default": { "value": { "items": [ { "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "merchant_order_id": "ord_1234567890", "captured_amount": 100, "currency": "USD", "refunded_amount": 0, "created_at": "2023-10-01T10:00:00+00:00", "disputed": true, "fraudulent": false, "match_results": { "same_ip_address": false, "same_shipping_address": false, "same_email_address": false } } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_disputes/{id}/related_payment_intents", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "id": "dst_hkpdw2eqp9oie", "page": "0", "page_size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "merchant_order_id": "ord_1234567890", "captured_amount": 100, "currency": "USD", "refunded_amount": 0, "created_at": "2023-10-01T10:00:00+00:00", "disputed": true, "fraudulent": false, "match_results": { "same_ip_address": false, "same_shipping_address": false, "same_email_address": false } } ] } } ], "x-scope": [ { "scope": "payment_dispute:read", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "1|Retrieve a Payment Dispute", "description": "Retrieve Payment Dispute information using Payment Dispute unique identifier.", "operationId": "retrievePaymentDispute", "parameters": [ { "name": "id", "in": "path", "description": "Payment Dispute unique identifier.", "required": true, "schema": { "type": "string", "default": "dst_hkst98v9kgk2t7otgl0" }, "examples": { "default": { "value": "dst_hkpdw2eqp9oie" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDispute" }, "examples": { "default": { "value": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_disputes/dst_hkpdw2eqp9oie", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "dst_hkpdw2eqp9oie", "stage": "CHARGEBACK", "status": "ACCEPTED", "amount": 100, "currency": "USD", "mode": "COLLABORATION", "merchant_order_id": "D202503210001", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdw2eqp9oie", "acquirer_reference_number": "T1234567890", "payment_method_type": "VISA", "issuer_comment": "", "issuer_documents": [], "card_brand": "visa", "reason": { "original_code": "4837", "description": "Fraudulent transaction.", "type": "FRAUDULENT" }, "accept_details": [ { "stage": "CHARGEBACK", "reason": "AGREEMENT_REACHED_WITH_CUSTOMER", "description": "Accepted", "refund": { "amount": 100, "reason": "REQUESTED_BY_CUSTOMER" }, "accepted_by": "airwallex", "accepted_at": "2023-10-01T10:00:00+00:00" } ], "challenge_details": [], "due_at": "2023-11-01T10:00:00+00:00", "transaction_type": "PAYMENT", "customer_name": "John Doe", "created_at": "2023-10-01T10:00:00+00:00", "updated_at": "2023-10-01T10:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_dispute:read", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_disputes/{id}/update": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "summary": "3|Update a Payment Dispute", "description": "Update a Payment Dispute by ID. Currently only the `metadata` field can be updated.", "operationId": "updatePaymentDispute", "parameters": [ { "name": "id", "in": "path", "description": "Payment Dispute ID.", "required": true, "schema": { "type": "string", "default": "dst_hkst98v9kgk2t7otgl0" }, "examples": { "default": { "value": "payment_dispute_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "metadata" ], "properties": { "metadata": { "type": "object", "description": "A set of key-value pairs attached to the dispute. Maximum 50 key-value pairs. Keys and values must not exceed 256 characters.", "additionalProperties": { "type": "string" } } } }, "examples": { "default": { "value": { "metadata": { "key": "value" } } } } } }, "description": "Update dispute request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDispute" }, "examples": { "default": { "value": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+00:00", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "ai_dispute_automation": { "recommendation": { "action": "Challenge", "evidence_to_submit": [ "order_snapshot_file_ids", "product_description", "merchant_business_model_description" ] }, "status": "AVAILABLE", "unavailable_reason": "NOT_SUPPORTED" }, "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenge_method": "AI_DISPUTE_AUTOMATION", "challenged_at": "2023-09-18T03:11:00+00:00", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+00:00", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+00:00", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "evidence": { "access_activity_file_ids": [], "authenticity_proof_file_ids": [], "customer_communication_file_ids": [], "duplicate_payment_file_ids": [], "duplicate_transaction_amount_currency": "100.00 USD", "duplicate_transaction_created_at": "2024-01-15T10:30:00Z", "order_fulfilled_at": "2024-01-15T10:30:00Z", "order_fulfillment_file_ids": [], "order_snapshot_file_ids": [], "previous_dispute_won_on_same_card_file_ids": [], "previous_purchase_similar_product_file_ids": [], "product_consumption_file_ids": [], "product_description": "Digital subscription service", "product_snapshot_file_ids": [], "refund_policy_file_ids": [], "user_agreement_file_ids": [] }, "order_info": { "created_at": "2023-09-18T03:11:00+00:00", "id": "123456", "invoice_number": "456123", "products": [ { "category": "Apparel and accessories", "code": "3414314111", "desc": "IPHONE 7", "effective_end_at": "2020-12-31T23:59:59Z", "effective_start_at": "2020-01-01T00:00:00Z", "image_url": "https://example.airwallex.com/product/12345.png", "name": "IPHONE7", "quantity": 5, "sku": "100004", "type": "physical", "unit_price": 100.01, "url": "https://example.airwallex.com/product/12345" } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+00:00", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+00:00", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "metadata": {}, "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_disputes/payment_dispute_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "metadata": { "key": "value" } }, "response_body": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+00:00", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "ai_dispute_automation": { "recommendation": { "action": "Challenge", "evidence_to_submit": [ "order_snapshot_file_ids", "product_description", "merchant_business_model_description" ] }, "status": "AVAILABLE", "unavailable_reason": "NOT_SUPPORTED" }, "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenge_method": "AI_DISPUTE_AUTOMATION", "challenged_at": "2023-09-18T03:11:00+00:00", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+00:00", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+00:00", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "evidence": { "access_activity_file_ids": [], "authenticity_proof_file_ids": [], "customer_communication_file_ids": [], "duplicate_payment_file_ids": [], "duplicate_transaction_amount_currency": "100.00 USD", "duplicate_transaction_created_at": "2024-01-15T10:30:00Z", "order_fulfilled_at": "2024-01-15T10:30:00Z", "order_fulfillment_file_ids": [], "order_snapshot_file_ids": [], "previous_dispute_won_on_same_card_file_ids": [], "previous_purchase_similar_product_file_ids": [], "product_consumption_file_ids": [], "product_description": "Digital subscription service", "product_snapshot_file_ids": [], "refund_policy_file_ids": [], "user_agreement_file_ids": [] }, "order_info": { "created_at": "2023-09-18T03:11:00+00:00", "id": "123456", "invoice_number": "456123", "products": [ { "category": "Apparel and accessories", "code": "3414314111", "desc": "IPHONE 7", "effective_end_at": "2020-12-31T23:59:59Z", "effective_start_at": "2020-01-01T00:00:00Z", "image_url": "https://example.airwallex.com/product/12345.png", "name": "IPHONE7", "quantity": 5, "sku": "100004", "type": "physical", "unit_price": 100.01, "url": "https://example.airwallex.com/product/12345" } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+00:00", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+00:00", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "metadata": {}, "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+00:00" } } ], "x-scope": [ { "scope": "payment_dispute:write", "group": "Payment Acceptance", "resource_name": "Payment Disputes", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/cancel": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "9|Cancel a Payment Intent", "description": "A Payment Intent can be cancelled when it is in one of these statuses: `REQUIRES_PAYMENT_METHOD`, `REQUIRES_CUSTOMER_ACTION`, `REQUIRES_CAPTURE`. \n \nAny outstanding, un-captured funds will be refunded once cancelled.", "operationId": "paymentIntents_cancel", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "cancellation_reason": { "type": "string", "description": "The reason for canceling the Payment Intent." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "cancellation_reason": "Payment cancelled by shopper", "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066" } } } } }, "description": "Payment Intent cancellation request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066", "amount": 100, "currency": "USD", "status": "CANCELLED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `invalid_status_for_operation`, `provider_unavailable`, `provider_declined`, `issuer_declined`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "cancellation_reason": "Payment cancelled by shopper", "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "1b258880-9bc6-4d94-8c83-f5e2198a5066", "amount": 100, "currency": "USD", "status": "CANCELLED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/capture": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "6|Capture a Payment Intent", "description": "Capture funds that have been confirmed but have not yet been captured or have only been captured partially. A Payment Intent is capturable if `auto_capture=false` and its `next_action` indicates that capture is required.", "operationId": "capture", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "amount": { "type": "number", "description": "Amount to capture. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "funds_split_data": { "type": "array", "description": "When provided, it creates specified funds splits that are automatically released after the Payment Intent succeeds.", "items": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "Amount of this split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts\nIf a value is not specified, the destination will be as specified in the Payment Intent." } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "amount": 100, "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268" } } } } }, "description": "Payment Intent capture request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `frequency_above_limit`, `amount_above_limit`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/capture", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "amount": 100, "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "902871b9-f26d-4fd3-b4fd-4a7585f30268", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/confirm": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "5|Confirm a Payment Intent", "description": "Call this endpoint when your customer is ready to make a payment as per the details in the Payment Intent. \n \nAt a minimum, a Payment Method must be set as the funding source of the payment. This is done by providing a `payment_method` object when confirming the Payment Intent.", "operationId": "paymentIntents_confirm", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "ideal": { "value": "int_hkpdskz7vg1xc7uscdj" }, "default": { "value": "int_hkpdskz7vg1xc7uscdj" }, "klarna": { "value": "int_hkpdskz7vg1xc7uscdj" }, "paypal": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "customer_id": { "type": "string", "description": "Customer who intends to pay for the Payment Intent." }, "device_data": { "type": "object", "description": "Client device information. It is recommended to provide this data to increase the odds of having frictionless 3DS.", "properties": { "accept_header": { "type": "string", "description": "Accept header value." }, "browser": { "type": "object", "description": "Browser specific data.", "properties": { "java_enabled": { "type": "boolean", "description": "Is Java enabled?" }, "javascript_enabled": { "type": "boolean", "description": "Is JavaScript enabled?" }, "user_agent": { "type": "string", "description": "User Agent header value." } } }, "device_id": { "type": "string", "description": "Device unique identifier or Advertisement unique identifier or IMEI." }, "ip_address": { "type": "string", "description": "Public IP address, both IPv4 and IPv6 are supported." }, "language": { "type": "string", "description": "Language or locale." }, "location": { "type": "object", "description": "Location data.", "properties": { "lat": { "type": "string", "description": "Latitude." }, "lon": { "type": "string", "description": "Longitude." } } }, "mobile": { "type": "object", "description": "Mobile specific data.", "properties": { "device_model": { "type": "string", "description": "Device model." }, "os_type": { "type": "string", "description": "OS type." }, "os_version": { "type": "string", "description": "OS version." } } }, "screen_color_depth": { "type": "integer", "format": "int32", "description": "Screen color depth in bits." }, "screen_height": { "type": "integer", "format": "int32", "description": "Screen height in pixels." }, "screen_width": { "type": "integer", "format": "int32", "description": "Screen width in pixels." }, "timezone": { "type": "string", "description": "Timezone offset to UTC in hours, with added minutes if necessary." } } }, "external_recurring_data": { "type": "object", "required": [ "triggered_by" ], "description": "Some merchants prefer to maintain the recurring payments on their own instead of using **Payment Consent**. Providing this data indicates the request is an external recurring payment.\nOnly effective when `payment_consent_id` is not present, and the `payment_method.type` must be one of `card`, `applepay`, `googlepay`.", "properties": { "initial_payment": { "type": "boolean", "description": "Set this to `true` if it is the initial transaction request in a recurring series.\n\nDefault: `false`." }, "lifecycle_id": { "type": "string", "description": "The Mastercard **Transaction Link Identifier (TLID)**, assigned when the original payment in a recurring series is authorized, carried as ISO 8583 DE 105 Subfield 1. Provide it on subsequent merchant-initiated payments so issuers can link the series to the original authorization." }, "merchant_trigger_reason": { "type": "string", "description": "Indicate if this subsequent payment is scheduled. Only applicable when `triggered_by` is `merchant`. One of `scheduled`, `unscheduled`, `installments`.\n\nDefault: `scheduled`." }, "original_transaction_id": { "type": "string", "description": "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).\nDo not pass this value when `initial_payment` is `true` or if you are not clear about the valid formats (as listed below).\n- Visa (`card`) - 15 digits unique ID Visa assigns to the response of the original authorization request, i.e. `123456789012345`\n- Mastercard (`card`) - 13 characters trace id (DE 63 Subfield 1 & 2 + DE 15) from the response of the original authorization request, i.e. `MCC123ABC0101`.\n" }, "terms_of_use": { "type": "object", "required": [ "payment_amount_type" ], "description": "Terms to specify how this Payment Consent will be used.", "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } } }, "triggered_by": { "type": "string", "description": "The party who initiated this subsequent payment request. One of `merchant`, `customer`." } } }, "funds_split_data": { "type": "array", "description": "When provided, it creates specified funds splits that are automatically released after the Payment Intent succeeds.", "items": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "Amount of this split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts\nIf a value is not specified, the destination will be as specified in the Payment Intent." } } } }, "payment_consent": { "type": "object", "required": [ "next_triggered_by" ], "description": "The associated **Payment Consent** to set up along with the Payment Intent.", "properties": { "merchant_trigger_reason": { "type": "string", "description": "Indicate whether the subsequent payments are scheduled. Only applicable when `next_triggered_by` is `merchant`.\nDefault: `unscheduled`.", "enum": [ "installments", "scheduled", "unscheduled" ] }, "next_triggered_by": { "type": "string", "description": "The party to trigger subsequent payments. One of `merchant`, `customer`." }, "terms_of_use": { "type": "object", "required": [ "payment_amount_type" ], "description": "Terms to specify how this Payment Consent will be used.", "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } } } } }, "payment_consent_id": { "type": "string", "description": "Unique identifier of the Payment Consent referenced for this recurring payment." }, "payment_method": { "type": "object", "description": "The **Payment Method** to use for the Payment Intent.", "properties": { "ach_direct_debit": { "type": "object", "description": "ACH Direct Debit information.", "properties": { "aba_routing_number": { "type": "string", "description": "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`." }, "account_number": { "type": "string", "description": "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`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Email of the account holder. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Name of the account holder. Required when verification method is `micro_deposit`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `plaid` or `micro_deposit`. Default: `micro_deposit`." } } }, "afterpay": { "type": "object", "required": [ "shopper_email" ], "description": "Afterpay information. This must be provided if `type` is set to `afterpay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "date_of_birth": { "type": "string", "description": "Date of birth of the customer in the format: YYYY-MM-DD." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "shopper_email": { "type": "string", "description": "Email address of the shopper." } } }, "alfamart": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "Alframart information. This must be provided if `type` is set to `alfamart`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "alipaycn": { "type": "object", "required": [ "flow" ], "description": "Alipay CN information. This must be provided if `type` is set to `alipaycn`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`, `mini_program`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web`, `mobile_app` or `mini_program`. One of `ios`, `android`." }, "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } } } }, "alipayhk": { "type": "object", "required": [ "flow" ], "description": "Alipay HK information. This must be provided if `type` is set to `alipayhk`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." }, "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } } } }, "applepay": { "type": "object", "description": "Applepay information. This must be provided if `type` is set to `applepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "Payment data from Apple Pay Payment Token." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "atome": { "type": "object", "description": "Atome information. This must be provided if `type` is set to `atome`.", "properties": { "shopper_phone": { "type": "string", "description": "Customer's mobile number, formatted in [E.164](https://en.wikipedia.org/wiki/E.164) standard." } } }, "bacs_direct_debit": { "type": "object", "description": "BACS Direct Debit information.", "properties": { "account_number": { "type": "string", "description": "Required when verification method is `micro_deposit`. Should not be set when verification method is `truelayer`." }, "address": { "type": "object", "required": [ "line1", "postcode", "town" ], "description": "Account holder's address. Required when verification method is `micro_deposit`.", "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes. One of `GB`, `US`. Default to `GB` if not provided." }, "line1": { "type": "string", "description": "House number and street name, e.g., `777 Casino Drive`." }, "line2": { "type": "string", "description": "Locality name, e.g., `Apartment 123`." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address. Should be provided if country code is `US`. Use the two-character ISO3166-2:US state code." }, "town": { "type": "string", "description": "Post town." } } }, "bank_name": { "type": "string", "description": "Bank of the account. Required when verification method is `truelayer`. Should not be set when verification method is `micro_deposit`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Email of the account holder. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Name of the account holder. Required when verification method is `micro_deposit`." }, "sort_code": { "type": "string", "description": "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`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `truelayer` or `micro_deposit`. Default: `micro_deposit`." } } }, "bancontact": { "type": "object", "required": [ "shopper_name" ], "description": "Bancontact information. This must be provided if `type` is set to `bancontact`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "bank_transfer": { "type": "object", "description": "Bank Transfer information. This must be provided if `type` is set to `bank_transfer`.", "properties": { "bank_name": { "type": "string", "description": "The name of the bank. Supported banks are: \n \nID: `mandiri`, `danamon`, `cimb_niaga`, `permata`, `maybank`, `bri`, `bni`. \n \n \n \nYou can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "expires_at": { "type": "string", "description": "Expiry time of this attempt, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "ga_mode": { "type": "string", "description": "The type of GA mode. One of `PAYMENT_GA`, `PAYER_GA`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "transfer_type": { "type": "string", "description": "The type of Transfer. One of `SWIFT`, `LOCAL`, `BOTH`." } } }, "becs_direct_debit": { "type": "object", "required": [ "account_number", "bsb_number", "owner_email", "owner_name" ], "description": "BECS Direct Debit information. This must be provided if `type` is set to `becs_direct_debit`.", "properties": { "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Account holder's email." }, "owner_name": { "type": "string", "description": "Account holder name." } } }, "bitpay": { "type": "object", "required": [ "country_code", "shopper_name" ], "description": "Bit Pay information. This must be provided if `type` is set to `bitpay`.", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "blik": { "type": "object", "required": [ "shopper_name" ], "description": "BLIK information. This must be provided if `type` is set to `blik`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "boost": { "type": "object", "description": "Boost information. It takes effect when `type` is set to `boost`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "card": { "type": "object", "description": "Card information. This must be provided if `type` is set to `card`.", "properties": { "additional_info": { "type": "object", "description": "Additional information of external network token requestor. Should be provided when number_type is `EXTERNAL_NETWORK_TOKEN`.", "properties": { "merchant_verification_value": { "type": "string", "description": "Merchant Verification Value (Provided by VISA during onboarding)\nor\nMasterCard Assigned ID (Provided by MasterCard during onboarding)." }, "token_requestor_id": { "type": "string", "description": "Token requestor unique identifier (Provided by card schemes during onboarding)." } } }, "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "cryptogram": { "type": "string", "description": "The cryptogram value. Must be provided if card.number_type is `EXTERNAL_NETWORK_TOKEN`. Maximum length is 28." }, "cvc": { "type": "string", "description": "CVC code of this card. Required for all transactions except merchant initiated transactions and network tokenized transactions." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider (3RI for MIT subsequent transaction).", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "cartes_bancaires": { "type": "object", "description": "Represents Cartes Bancaires-specific authentication data from an external 3D-Secure provider. Required when the merchant uses Cartes Bancaires with external 3DS.", "properties": { "avalgo": { "type": "string", "description": "Cryptogram calculation algorithm used by the card issuer's ACS to calculate the authentication cryptogram (also known as `cavvAlgorithm`). Maps to the Cartes Bancaires message extension `CB-AVALGO`. Required when the merchant uses Cartes Bancaires with external 3DS." }, "exemption": { "type": "string", "maxLength": 4, "description": "Exemption indicator returned from Cartes Bancaires in the ARes. Maps to the Cartes Bancaires message extension `CB-EXEMPTION`. Maximum length is 4 characters. Required when the merchant uses Cartes Bancaires with external 3DS." }, "score": { "type": "string", "maxLength": 2, "description": "Transaction risk score returned from Cartes Bancaires in the ARes, a numeric string with a value from 0 to 99 (inclusive). Maps to the Cartes Bancaires message extension `CB-SCORE`. Required when the merchant uses Cartes Bancaires with external 3DS." } } }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "requestor_challenge_indicator": { "type": "string", "maxLength": 2, "description": "Challenge indicator (`threeDSRequestorChallengeInd`) that was requested in the AReq sent to the card issuer's ACS, a string containing 2 digits from 01 to 99. Applicable to Cartes Bancaires. Maximum length is 2 characters. Required when the merchant uses Cartes Bancaires with external 3DS." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "korean_card": { "type": "object", "required": [ "password_first2" ], "description": "Information for Korean Card.", "properties": { "business_number": { "type": "string", "description": "A 10-digit business number of the company. Either `business_number` or `date_of_birth` must be provided." }, "date_of_birth": { "type": "string", "description": "A 6-digit date of birth in the format of YYMMDD. Either `business_number` or `date_of_birth` must be provided." }, "password_first2": { "type": "string", "description": "Card password first 2 digits." } } }, "name": { "type": "string", "description": "Card holder name. Maximum length is 128." }, "number": { "type": "string", "description": "Card number." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`. Default: `PAN`." } } }, "card_present": { "type": "object", "required": [ "cardholder_verification_method", "pan_entry_mode", "terminal_info" ], "description": "Information required for card-present transactions. This must be provided if `type` is set to `card_present`.", "properties": { "cardholder_verification_method": { "type": "string", "description": "Cardholder verification method. \n- `offline_pin`: The PIN is verified offline by the EMV chip card. \n- `online_pin`: The PIN is encrypted and verified online by issuers or card schemes. `encrypted_pin` is required for `online_pin`. \n- `manual_signature`: The cardholder signature on the receipt is compared to the signature on the back of the card. \n- `no_cvm`: No verification needed. \n- `cdcvm`: Cardholder device verification method. The cardholder is verified using a device's authentication method. \n- `offline_pin_and_signature`: Both an offline PIN and a manual signature are used to verify the cardholder. \n- `skipped`: Verification process was bypassed." }, "emv_tags": { "type": "string", "description": "Tag-length-value (TLV)-encoded data read from a chip card. Required when pan_entry_mode is chip, contactless_chip. \n \nMandatory tags: \n- 82 - Application interchange profile \n- 84 - Dedicated file name \n- 95 - Terminal verification results \n- 9A - Application date \n- 9C - Transaction type \n- 5F2A - Transaction currency code \n- 9F02 - Amount authorized \n- 9F10 - Issuer application data \n- 9F1A - Terminal country code \n- 9F26 - Application cryptogram \n- 9F27 - Cryptogram information \n- 9F34 - Cardholder verification method results \n- 9F36 - Application transaction counter \n- 9F37 - Unpredictable number \n- 9F6E - Form factor indicator / Third party data \n \nRecommended tags: \n- 9F33 - Terminal capabilities \n- 9F35 - Terminal type \n- 9F41 - Transaction sequence counter \n \nProvide if present: \n- 5F34 - Card sequence number." }, "encrypted_pin": { "type": "string", "description": "Encrypted personal identification number. Required when `cardholder_verification_method` is `online_pin`." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month. Required when `pan_entry_mode` is `manual_entry`." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year. Required when `pan_entry_mode` is `manual_entry`." }, "fallback": { "type": "boolean", "description": "The default is `false`. Set to `true` when: \n- 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`. \n- 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": { "type": "string", "description": "Fallback reason applicable when `fallback` is `true`. \nSet to `chip_read_failure` when all of the following conditions are met: \n- The transaction is initiated at a chip-capable terminal. \n- `pan_entry_mode` is `magstripe`. \n- The previous transaction initiated by the terminal was an unsuccessful chip read." }, "key_serial_number": { "type": "string", "description": "Key serial number while using DUKPT for PIN encryption." }, "number": { "type": "string", "description": "Card number. Required when `pan_entry_mode` is `manual_entry`." }, "pan_entry_mode": { "type": "string", "description": "The way the terminal reads the card information. \n- `manual_entry`: Manually keyed into POS terminal. \n- `chip`: Read from direct contact with a chip card. \n- `magstripe`: Read from direct contact with magnetic stripe card. \n- `contactless_chip`: Read from a contactless interface using chip data. \n- `contactless_magstripe`: Read from a contactless interface using magnetic stripe data (MSD)." }, "terminal_info": { "type": "object", "required": [ "pin_entry_capability", "supported_pan_entry_modes", "terminal_identifier" ], "description": "Data obtained by the POS terminal from the card and terminal properties.", "properties": { "mobile_device": { "type": "boolean", "description": "Indicate whether the POS terminal is a mobile POS device. Default is `false`." }, "pin_entry_capability": { "type": "string", "description": "Describe the capability of the terminal device to accept PIN. \n- `unsupported`: Terminal does not have PIN entry capability. \n- `supported`: Terminal has PIN entry capability. Except the case suitable for software_based. \n- `software_based`: For a mobile POS device, a user can input PIN through software-based keyboard. \n- `disabled`: Terminal has PIN entry capability but PIN pad is not currently operative." }, "support_single_tap_with_pin": { "type": "boolean", "description": "Indicate whether the POS terminal could respond to a `request_pin` action. Default is `false`." }, "supported_pan_entry_modes": { "type": "array", "description": "List of `pan_entry_modes` supported by the terminal.", "items": { "type": "string" } }, "terminal_identifier": { "type": "string", "description": "An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system." }, "terminal_type": { "type": "string", "description": "Type of the POS terminal that processes this payment. \n- `attended_pos`: dedicated pos devices that attended by a merchant staff. \n- `unattended_pos`: dedicated pos devices that not attended. \n- `android_softpos`: android mobile devices that can work as pos device with software. \n- `ios_softpos`: iOS mobile devices that can work as pos device with software." }, "use_embedded_reader": { "type": "boolean", "description": "Indicate whether the reader is embedded in a mobile POS device. Default is `true`." } } }, "track1": { "type": "string", "description": "Track 1 read from magnetic stripe card." }, "track2": { "type": "string", "description": "Track 2 is read from a magnetic stripe card or is track 2 equivalent data get from the chip card. \nTrack 2 is required when `pan_entry_mode` is not `manual_entry`." } } }, "cash_app_pay": { "type": "object", "description": "cash app pay information. This must be provided if `type` is set to `cash_app_pay`.", "properties": { "flow": { "type": "string", "description": "The specific Cash App Pay flow to use. Only `qrcode`, `mobile_web` and `mobile_app`." } } }, "dana": { "type": "object", "required": [ "flow" ], "description": "Dana information. This must be provided if `type` is set to `dana`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "doku_ewallet": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "Doku E-Wallet information. This must be provided if `type` is set to `doku_ewallet`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "dragonpay": { "type": "object", "description": "Dragonpay information. It takes effect when `type` is set to `dragonpay`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "duit_now": { "type": "object", "description": "Duit Now information. It takes effect when `type` is set to `duit_now`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "eft_direct_debit": { "type": "object", "description": "EFT Direct Debit information.", "properties": { "account_number": { "type": "string", "description": "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`." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "institution_number": { "type": "string", "description": "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`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Email of the account holder. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Name of the account holder. Required when verification method is `micro_deposit`." }, "transit_number": { "type": "string", "description": "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`." }, "verification_method": { "type": "string", "description": "Verification method. Only supports `micro_deposit`." } } }, "eps": { "type": "object", "required": [ "shopper_name" ], "description": "EPS information. It takes effect when `type` is set to `eps`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "esun": { "type": "object", "description": "ESUN information. It takes effect when `type` is set to `esun`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "family_mart": { "type": "object", "description": "Family Mart information. It takes effect when `type` is set to `family_mart`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "fps": { "type": "object", "description": "FPS information. This must be provided if `type` is set to `fps`.", "properties": { "flow": { "type": "string", "description": "The specific FPS flow to use. Currently only support `qrcode`." } } }, "fpx": { "type": "object", "required": [ "bank_name" ], "description": "FPX Transfer information. This must be provided if `type` is set to `fpx`.", "properties": { "bank_name": { "type": "string", "description": "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`. \n \nYou can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "gcash": { "type": "object", "required": [ "flow" ], "description": "Gcash information. This must be provided if `type` is set to `gcash`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "go_pay": { "type": "object", "description": "Go Pay information. It takes effect when `type` is set to `go_pay`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "googlepay": { "type": "object", "description": "Googlepay information. This must be provided if `type` is set to `googlepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "A UTF-8 encoded, serialized JSON object with the keys specified." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider. Only applicable when Google Pay `PAN_ONLY` authentication method is used.", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "grabpay": { "type": "object", "description": "Grab Pay information. It takes effect when `type` is set to `grabpay`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "hi_life": { "type": "object", "description": "Hi-Life information. It takes effect when `type` is set to `hi_life`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "id": { "type": "string", "description": "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": { "type": "object", "description": "i DEAL information. It takes effect when `type` is set to `ideal`.", "properties": { "bank_name": { "type": "string", "description": "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`." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "indomaret": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "Indomaret information. This must be provided if `type` is set to `indomaret`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "jenius_pay": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "Jenius Pay information. This must be provided if `type` is set to `jenius_pay`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "kakaopay": { "type": "object", "required": [ "flow" ], "description": "Kakaopay information. This must be provided if `type` is set to `kakaopay`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "klarna": { "type": "object", "required": [ "country_code" ], "description": "Klarna information. This must be provided if `type` is set to `klarna`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "date_of_birth": { "type": "string", "description": "Date of birth of the customer in the format: YYYY-MM-DD." }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "country_code": { "type": "string", "description": "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`." }, "language": { "type": "string", "description": "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. \nAT: `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": { "type": "object", "required": [ "shopper_email", "shopper_name", "shopper_phone" ], "description": "Konbini information. This must be provided if `type` is set to `konbini`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper. Must be 10-11 digits of numbers." } } }, "linkaja": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "Link Aja information. This must be provided if `type` is set to `linkaja`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "maxima": { "type": "object", "required": [ "shopper_name" ], "description": "Maxima information. This must be provided if `type` is set to `maxima`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "multibanco": { "type": "object", "required": [ "shopper_name" ], "description": "Multibanco information. This must be provided if `type` is set to `multibanco`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "mybank": { "type": "object", "required": [ "shopper_name" ], "description": "My Bank information. This must be provided if `type` is set to `mybank`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "narvesen": { "type": "object", "required": [ "shopper_name" ], "description": "Narvesen information. This must be provided if `type` is set to `narvesen`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "octopus": { "type": "object", "description": "Octopus method information. It takes effect when `type` is set to `octopus`.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "flow": { "type": "string", "description": "Payment flow type. One of `qrcode`, `mobile_web`, `mobile_app`. Required when channel is not `pos`." }, "os_type": { "type": "string", "description": "OS type. Required when `flow` is `mobile_app` or `mobile_web`. One of `ios`, `android`." } } }, "online_banking": { "type": "object", "required": [ "country_code" ], "description": "Online Banking information. This must be provided if `type` is set to `online_banking`.", "properties": { "bank_name": { "type": "string", "description": "The name of the bank. Supported banks are: \n \nTH: `bangkok`, `krungsri`, `krungthai`, `siam_commercial`, `kasikorn`. \n \nEE: `citadele`, `lhv`, `seb`, `luminor`, `revolut`, `swedbank`, `coop`, `n26`. \n \nLV: `swedbank`, `seb`, `luminor`, `citadele`, `revolut`, `n26`. \n \nLT: `swedbank`, `seb`, `luminor`, `revolut`, `siauliu`, `citadele`, `medicinos`, `lithuanian_credit_union`. \n \nID: `permatanet`, `muamalat_id`, `cimb_clicks`, `danamon`, `bca`, `bri`. \n \nVN: `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`. \n \nPH: `bpi`. \n \n \n \nYou can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying. One of: `TH`, `EE`, `LV`, `LT`, `VN`, `ID`, `PH`, `KR`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper. Required when `country_code` is `EE`, `LV`, `LT`, `VN` or `ID`." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Required when `country_code` is `EE`, `LV`, `LT`, `VN` or `ID`." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper. Required when `country_code` is `EE`, `LV`, `LT`, `VN` or `ID`." } } }, "ovo": { "type": "object", "description": "OVO information. It takes effect when `type` is set to `ovo`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. If provided, it must be between 3 and 100 characters in length." } } }, "p24": { "type": "object", "required": [ "shopper_email", "shopper_name" ], "description": "P24 information. This must be provided if `type` is set to `p24`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "pay_now": { "type": "object", "description": "Pay Now information. It takes effect when `type` is set to `pay_now`.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "paybybankapp": { "type": "object", "required": [ "shopper_name" ], "description": "Pay by Bank app information. This must be provided if `type` is set to `paybybankapp`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "payeasy": { "type": "object", "required": [ "shopper_email", "shopper_name", "shopper_phone" ], "description": "Pay Easy information. This must be provided if `type` is set to `payeasy`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper. Must be 10-11 digits of numbers." } } }, "paypal": { "type": "object", "description": "Pay Pal information. It takes effect when `type` is set to `paypal`.", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "paypost": { "type": "object", "required": [ "shopper_name" ], "description": "Pay Post information. This must be provided if `type` is set to `paypost`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "paysafecard": { "type": "object", "required": [ "country_code", "shopper_name" ], "description": "paysafecard information. This must be provided if `type` is set to `paysafecard`.", "properties": { "country_code": { "type": "string", "description": "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`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "paysafecash": { "type": "object", "required": [ "country_code", "shopper_email", "shopper_name" ], "description": "Paysafecash information. This must be provided if `type` is set to `paysafecash`.", "properties": { "country_code": { "type": "string", "description": "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`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "paysera": { "type": "object", "required": [ "bank_name", "country_code", "shopper_name" ], "description": "Paysera information. This must be provided if `type` is set to `paysera`.", "properties": { "bank_name": { "type": "string", "description": "The name of the bank. One of: `citadele`, `n26`, `revolut`, `swedbank`, `lhv`, `luminor`, `seb`." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying. Available values including all EEA countries." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "payto": { "type": "object", "description": "Payto information. This must be provided if `type` is set to `payto`.", "properties": { "bsb": { "type": "object", "required": [ "account_name", "account_number", "bsb_number" ], "properties": { "account_name": { "type": "string", "description": "The account name." }, "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." } } }, "pay_id": { "type": "object", "properties": { "australian_business_number": { "type": "string", "description": "11 digits number to identify the Pay Id. Required when `phone_number`, `owner_email`, and `organisation_id` is null." }, "organisation_id": { "type": "string", "description": "The organisation id of the recipient. The Pay ID must be in the format of `payid:airwallex.com`." }, "owner_email": { "type": "string", "description": "owner email to identify the Pay Id. Required when `phone_number`, `australian_business_number`, and `organisation_id` is null." }, "payer_name": { "type": "string", "description": "Payer name of the Pay Id." }, "phone_number": { "type": "string", "description": "The phone number of the Pay Id. Required when `owner_email`, `australian_business_number`, and `organisation_id` is null." } } } } }, "payu": { "type": "object", "required": [ "shopper_name" ], "description": "Pay U information. This must be provided if `type` is set to `payu`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "perlas_terminals": { "type": "object", "required": [ "shopper_name" ], "description": "Perlas terminals information. This must be provided if `type` is set to `perlas_terminals`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "prompt_pay": { "type": "object", "description": "Prompt Pay information. It takes effect when `type` is set to `prompt_pay`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "rabbit_line_pay": { "type": "object", "required": [ "flow" ], "description": "Rabbit LINE Pay information. This must be provided if `type` is set to `rabbit_line_pay`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "satispay": { "type": "object", "required": [ "country_code", "shopper_name" ], "description": "Satispay information. This must be provided if `type` is set to `satispay`.", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying. One of `BE`, `DE`, `FR`, `IT`, `LU`." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } }, "sepa_direct_debit": { "type": "object", "description": "SEPA Direct Debit information.", "properties": { "address": { "type": "object", "required": [ "postcode", "street", "town" ], "description": "Account holder's address.", "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "street": { "type": "string", "description": "street of the address. " }, "town": { "type": "string", "description": "town of the address." } } }, "bank_name": { "type": "string", "description": "Bank of the account. Required when verification method is `truelayer`. You can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account. Default to `false`." }, "country_code": { "type": "string", "description": "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": { "type": "string", "description": "IBAN of the bank account. Required when verification method is `micro_deposit`. Should not be set when verification method is `truelayer`." }, "mandate_version": { "type": "string", "description": "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." }, "owner_email": { "type": "string", "description": "Email of the account holder. Required when verification method is `micro_deposit`." }, "owner_name": { "type": "string", "description": "Name of the account holder. Required when verification method is `micro_deposit`." }, "verification_method": { "type": "string", "description": "Verification method. Can be `truelayer` or `micro_deposit`. Default: `micro_deposit`." } } }, "seven_eleven": { "type": "object", "description": "7-Eleven information. It takes effect when if `type` is set to `seven_eleven`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "shopee_pay": { "type": "object", "description": "Shopee Pay information. It takes effect when `type` is set to `shopee_pay`.", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } } }, "skrill": { "type": "object", "required": [ "country_code", "shopper_email", "shopper_name" ], "description": "Skrill information. This must be provided if `type` is set to `skrill`.", "properties": { "country_code": { "type": "string", "description": "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](https://www.skrill.com/en/footer/terms-conditions/non-serviced-countries/)." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper. Should be in the format . The minimum length of lastname is two characters and the minimum length of the entire string is five characters." } } }, "tabby": { "type": "object", "description": "Tabby method information. This must be provided if `type` is set to `tabby`.", "properties": { "language": { "type": "string", "description": "The ISO 639-1 alpha-2 language code. Default value is `en`. Besides `en`, you can choose `ar`." }, "shopper_email": { "type": "string", "description": "The email of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "The phone of the shopper." } } }, "tng": { "type": "object", "required": [ "flow" ], "description": "Tng information. This must be provided if `type` is set to `tng`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "truemoney": { "type": "object", "required": [ "flow" ], "description": "Truemoney information. This must be provided if `type` is set to `truemoney`.", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "Required when `flow` is `mobile_web` or `mobile_app`. One of `ios`, `android`." } } }, "trustly": { "type": "object", "required": [ "country_code", "shopper_name" ], "description": "Trustly information. This must be provided if `type` is set to `trustly`.", "properties": { "country_code": { "type": "string", "description": "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`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "type": { "type": "string", "description": "Type of the Payment Method. 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": { "type": "object", "required": [ "bank_name", "shopper_email", "shopper_name" ], "description": "Verkkopankki information. This must be provided if `type` is set to `verkkopankki`.", "properties": { "bank_name": { "type": "string", "description": "The name of the bank. One of `aktia`, `danske`, `handelsbanken`, `nordea`, `osuuspankki`, `pop_pankki`, `s_pankki`, `saastopankki`, `tapiola`, `alandsbanken`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "wechatpay": { "type": "object", "required": [ "flow" ], "description": "WeChat Pay information. This must be provided if `type` is set to `wechatpay`.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "flow": { "type": "string", "description": "The specific WeChat Pay flow to use. One of `qrcode`, `official_account`, `mini_program`, `mobile_app`, `mobile_web`." }, "open_id": { "type": "string", "description": "Required when `flow` is `mini_program`." } } }, "zip": { "type": "object", "required": [ "shopper_name" ], "description": "Zip information. This must be provided if `type` is set to `zip`.", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper. Must be between 3 and 100 characters in length." } } } } }, "payment_method_options": { "type": "object", "description": "Options for Payment Method.", "properties": { "afterpay": { "type": "object", "description": "The Payment Method options for Afterpay.", "properties": { "auto_capture": { "type": "boolean", "description": "Whether the Payment Intent should be automatically captured after authorization. Defaults to `true`." } } }, "card": { "type": "object", "description": "The Payment Method options for card.", "properties": { "authorization_type": { "type": "string", "description": "The authorization type of the card payment. One of `final_auth`, `pre_auth`. Default to `final_auth`. Set it to `pre_auth` if you want to place a hold on your customer’s card for more than 7 days. Currently only available when the card brand is visa or mastercard. You must also set `auto_capture` to be `false` if you want to do pre-auth." }, "auto_capture": { "type": "boolean", "description": "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." }, "merchant_trigger_reason": { "type": "string", "description": "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.", "enum": [ "delayed_charges", "no_show", "partial_shipment", "reauthorization", "resubmission" ] } } }, "klarna": { "type": "object", "description": "The Payment Method options for Klarna.", "properties": { "auto_capture": { "type": "boolean", "description": "Whether the Payment Intent should be automatically captured after authorization. Defaults to `false`." } } }, "wechatpay": { "type": "object", "description": "The Payment Method options for wechatpay.", "properties": { "enable_funds_split": { "type": "boolean", "description": "Indicates whether funds split will be enabled for this WeChat Pay order." } } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after payment authentication or cancellation." }, "triggered_by": { "type": "string", "description": "Indicates who initiated the payment — the `merchant` or the `customer`.\n- `merchant`: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.\n- `customer`: The payment is initiated by the customer using stored payment method details. \n" } } }, "examples": { "ideal": { "value": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "ideal", "ideal": { "shopper_name": "John Doe" } }, "return_url": "https://www.airwallex.com" } }, "default": { "value": { "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", "billing": { "email": "john.doe@example.com", "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" } }, "klarna": { "value": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "klarna", "klarna": { "country_code": "US", "language": "en", "billing": { "email": "john.doe@example.com", "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" } } } }, "payment_method_options": { "klarna": { "auto_capture": true } }, "return_url": "https://www.airwallex.com" } }, "paypal": { "value": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "paypal", "paypal": { "shopper_name": "John Doe" } } } } } } }, "description": "Payment Intent confirmation request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "ideal": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "EUR", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "payment_method_options": {}, "next_action": { "type": "redirect", "method": "GET", "url": "https://www.example.com/redirect" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "EUR", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "ideal", "ideal": { "shopper_name": "John Doe" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } }, "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } }, "klarna": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "next_action": { "type": "redirect", "method": "GET", "url": "https://www.example.com/redirect" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "klarna", "klarna": { "country_code": "US", "language": "en" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } }, "paypal": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "payment_method_options": {}, "next_action": { "type": "render_qrcode", "qrcode": "weixin://wxpay/yy?pr=1" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "paypal", "paypal": { "shopper_name": "John Doe" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `frequency_above_limit`, `operation_above_limit`, `invalid_status_for_operation`, `provider_unavailable`, `configuration_error`, `authentication_declined`, `risk_declined`, `resource_already_exists`, `provider_declined`, `quote_expired`, `payment_method_not_allowed`, `card_brand_not_supported`, `issuer_declined`, `no_3ds_liability_shift`, `3ds_not_supported`, `rejected_by_routing_rules`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "ideal", "name": "iDEAL", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "ideal", "ideal": { "shopper_name": "John Doe" } }, "return_url": "https://www.airwallex.com" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "EUR", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "payment_method_options": {}, "next_action": { "type": "redirect", "method": "GET", "url": "https://www.example.com/redirect" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "EUR", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "ideal", "ideal": { "shopper_name": "John Doe" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } }, { "key": "default", "name": "Card", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "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", "billing": { "email": "john.doe@example.com", "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" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } }, { "key": "klarna", "name": "Klarna", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "klarna", "klarna": { "country_code": "US", "language": "en", "billing": { "email": "john.doe@example.com", "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" } } } }, "payment_method_options": { "klarna": { "auto_capture": true } }, "return_url": "https://www.airwallex.com" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "next_action": { "type": "redirect", "method": "GET", "url": "https://www.example.com/redirect" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "klarna", "klarna": { "country_code": "US", "language": "en" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } }, { "key": "paypal", "name": "PayPal", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "payment_method": { "type": "paypal", "paypal": { "shopper_name": "John Doe" } } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "d917ad44-6ae4-447e-a534-cce4ceebfd2e", "amount": 100, "currency": "USD", "status": "REQUIRES_CUSTOMER_ACTION", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "payment_method_options": {}, "next_action": { "type": "render_qrcode", "qrcode": "weixin://wxpay/yy?pr=1" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "paypal", "paypal": { "shopper_name": "John Doe" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHENTICATION_REDIRECTED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex" } } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/confirm_continue": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "7|Continue To Confirm a Payment Intent", "description": "In certain scenarios (i.e. 3DS and DCC), customer is required to provide additional information multiple times after the initial confirmation request.", "operationId": "confirmContinue", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "card_pin_data": { "type": "object", "required": [ "encrypted_pin" ], "description": "PIN data to continue a card-present transaction, required only if type = `submit_card_pin_data`.", "properties": { "encrypted_pin": { "type": "string", "description": "Encrypted personal identification number." }, "key_serial_number": { "type": "string", "description": "Key serial number while using DUKPT for PIN encryption." } } }, "micro_deposit": { "type": "object", "description": "The verification request of micro-deposit.", "properties": { "amounts": { "type": "array", "description": "The amounts of the micro-deposit in the shopper’s bank statement. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units.", "items": { "type": "number" } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "type": { "type": "string", "description": "Type of the continue type.", "enum": [ "submit_card_pin_data", "verify_micro_deposits" ] } } }, "examples": { "default": { "value": { "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6", "type": "verify_micro_deposits", "micro_deposit": { "amounts": [ 0.01, 0.02 ] } } } } } }, "description": "Payment Intent confirmation continue request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6", "amount": 100, "currency": "USD", "status": "PENDING", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T06:57:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "sepadirectdebit", "sepa_direct_debit": { "iban": "DE012345678901234567890", "owner_name": "John Doe", "owner_email": "john.doe@example.com", "micro_deposit": { "status": "VERIFIED" }, "business_account": false }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:01:00+00:00" }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "PENDING_AUTHORIZATION", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `frequency_above_limit`, `operation_above_limit`, `provider_declined`, `provider_unavailable`, `configuration_error`, `authentication_declined`, `issuer_declined`, `no_3ds_liability_shift`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/confirm_continue", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6", "type": "verify_micro_deposits", "micro_deposit": { "amounts": [ 0.01, 0.02 ] } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "b0d9ce86-b87f-4650-9665-5002f7961ea6", "amount": 100, "currency": "USD", "status": "PENDING", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T06:57:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "id": "mtd_hkpd5jjp8h6bg6x8lpn", "type": "sepadirectdebit", "sepa_direct_debit": { "iban": "DE012345678901234567890", "owner_name": "John Doe", "owner_email": "john.doe@example.com", "micro_deposit": { "status": "VERIFIED" }, "business_account": false }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:01:00+00:00" }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "PENDING_AUTHORIZATION", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/create": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "1|Create a Payment Intent", "description": "Start collecting payment from your customer by creating a Payment Intent. The payment `amount` and `currency`, as well as the merchant order unique identifier must be provided.", "operationId": "createPaymentIntent", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "merchant_order_id", "request_id" ], "properties": { "additional_info": { "type": "object", "description": "Additional info for the transaction.", "properties": { "account_funding_data": { "type": "object", "required": [ "type" ], "description": "Additional info for account funding transactions to ensure compliance with card networks.", "properties": { "recipient": { "type": "object", "description": "Details of the recipient for this account funding transaction.", "properties": { "account_number": { "type": "string", "description": "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": { "type": "object", "required": [ "country_code" ], "description": "Address of the recipient.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "line1": { "type": "string", "description": "Address line1." }, "line2": { "type": "string", "description": "Address line2." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address." } } }, "first_name": { "type": "string", "description": "First name of the recipient." }, "last_name": { "type": "string", "description": "Last name of the recipient." }, "middle_name": { "type": "string", "description": "Middle name of the recipient." } } }, "sender": { "type": "object", "description": "Details of the sender for this account funding transaction.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the sender.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "line1": { "type": "string", "description": "Address line1." }, "line2": { "type": "string", "description": "Address line2." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address." } } }, "date_of_birth": { "type": "string", "description": "The sender’s date of birth. Format: YYYY-MM-DD (e.g., \"1989-07-15\")." }, "first_name": { "type": "string", "description": "First name of the sender." }, "last_name": { "type": "string", "description": "Last name of the sender." }, "middle_name": { "type": "string", "description": "Middle name of the sender." } } }, "transfer_between_own_accounts": { "type": "boolean", "description": "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." }, "type": { "type": "string", "description": "Account funding transaction type. Possible values: \n\n- **ACCOUNT_TO_ACCOUNT_TRANSFER**: An account-to-account transfer, either within the same financial institution or to a different one.\n- **STORED_VALUE_DIGITAL_WALLET_TRANSFER**: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.\n- **STAGED_DIGITAL_WALLET_TRANSFER**: Funding a Staged Digital Wallet before the cardholder makes a purchase.\n- **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).\n- **LIQUID_ASSET_PURCHASE**: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).\n" } } }, "customer_activity_data": { "type": "object", "description": "(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.", "properties": { "account_type": { "type": "string", "description": "Customer account type. One of `GUEST`, `PRIVATE`, `BUSINESS`, `VIP`, `MERCHANT_OPERATED`, `TRIAL`, `MERCHANT_EMPLOYEE`, `PREMIUM_PAID`, `SMALL_BUSINESS`, `AGENT`." }, "first_successful_order_date": { "type": "string", "description": "Date at which the customer completes the first order on the merchant's site." }, "last_login_ip_address": { "type": "string", "description": "The public IP address used by the customer in the last login." }, "last_modified_at": { "type": "string", "description": "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`)." }, "linked_social_networks": { "type": "array", "description": "Social network data related to the customer.", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address on the social network." }, "name": { "type": "string", "description": "The social network used by the customer. Can be one of: `FACEBOOK`, `GOOGLE`, `TWITTER`, `REDDIT`, `PINTEREST`, `WECHAT`, `QQ`, `TWITCH`, `APPLE`, `DRIBBBLE`, `GITHUB`, `LINKEDIN`, `MAKER_STUDIOS`, `STACK_EXCHANGE`, `VIMEO`, `STEAM`, `OTHER`, `KAKAO`, `NAVER`, `GRAB`, `JKOPAY`, `LINE`, `OTHER`." }, "profile_id": { "type": "string", "description": "The customer's profile unique identifier on the social network." } } } }, "purchase_summaries": { "type": "array", "description": "The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis.", "items": { "type": "object", "required": [ "payment_method_type" ], "properties": { "currency": { "type": "string", "description": "The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "first_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their first purchase in the merchant's system with the specified payment method type." }, "last_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their last purchase in the merchant's system with the specified payment method type." }, "payment_method_type": { "type": "string", "description": "Payment method type, one of `affirm`, `afterpay`, `atome`, `klarna`, and `other`." }, "successful_purchase_amount": { "type": "number", "description": "Total volume of successful purchases. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "successful_purchase_count": { "type": "integer", "format": "int32", "description": "Total number of successful purchases." } } } }, "registered_via_social_media": { "type": "boolean", "description": "Whether the customer registers through social media. Default to `false`." }, "registration_date": { "type": "string", "description": "Date at which the customer registers on the merchant's site." }, "registration_ip_address": { "type": "string", "description": "The public IP address used by the customer when registering on the merchant's site." } } }, "enhanced_scheme_data": { "type": "object", "description": "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.", "properties": { "customer": { "type": "object", "description": "Details of the customer making a payment for this Payment Intent.", "properties": { "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "reference": { "type": "string", "description": "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." } } }, "customer_tax_identifier": { "type": "string", "description": "Tax identifier of the customer. Maximum of 13 characters." }, "duty_amount": { "type": "number", "description": "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": { "type": "string", "description": "Invoice reference number. Maximum of 17 characters." }, "local_tax_amount": { "type": "number", "description": "The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "merchant_tax_identifier": { "type": "string", "description": "Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters." }, "national_tax_amount": { "type": "number", "description": "The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "products": { "type": "array", "description": "Product list.", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 12 characters." }, "commodity_code": { "type": "string", "description": "The [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) for the product. Maximum of 12 characters." }, "description": { "type": "string", "description": "Product description. Maximum of 26 characters." }, "discount_amount": { "type": "number", "description": "The discount amount for the product. This amount must be expressed in the original currency of the transaction." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "tax_percent": { "type": "number", "description": "The tax rate percentage for the product. Should be less than 100, up to 2 decimal places." }, "total_amount": { "type": "number", "description": "The total amount for the product. This amount must be expressed in the original currency of the transaction." }, "total_tax_amount": { "type": "number", "description": "The total amount of tax for the product. This amount must be expressed in the original currency of the transaction." }, "unit": { "type": "string", "description": "The unit of measure code used for the product. Maximum of 12 characters." }, "unit_price": { "type": "number", "description": "Product unit price. This amount must be expressed in the original currency of the transaction." } } } }, "shipping": { "type": "object", "description": "Shipping information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Shipping address.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "date": { "type": "string", "description": "The date the goods were shipped to the destination, in YYYY-MM-DD format." }, "fee_amount": { "type": "number", "description": "Shipping fee amount. This amount must be expressed in the same currency as the transaction amount." }, "from_postcode": { "type": "string", "description": "The postcode of the location the goods are being shipped from. Maximum of 10 characters." } } }, "summary_commodity_code": { "type": "string", "description": "The first 2,4 or 6 digits of [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) 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." }, "total_tax_amount": { "type": "number", "description": "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." }, "vat_invoice_reference": { "type": "string", "description": "Value added tax invoice reference number. Maximum of 15 characters." } } }, "online_ticket_agency_data": { "type": "object", "description": "The additional information for online ticket agency data.", "properties": { "events": { "type": "array", "description": "The details of the event.", "items": { "type": "object", "required": [ "name" ], "properties": { "arena_location": { "type": "object", "required": [ "country_code" ], "description": "The location of the venue.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "arena_name": { "type": "string", "description": "The name of the venue." }, "arena_seat_number": { "type": "string", "description": "The seat number of the venue." }, "company": { "type": "string", "description": "The name of the company arranging the event." }, "customer_name": { "type": "string", "description": "The name of the customer." }, "customer_title": { "type": "string", "description": "The title used before the customer’s name. One of mr, ms, and mrs." }, "ends_at": { "type": "string", "description": "The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "name": { "type": "string", "description": "The name of the event." }, "starts_at": { "type": "string", "description": "The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "type": { "type": "string", "description": "The category or type of the event." } } } } } }, "online_travel_agency_data": { "type": "object", "description": "The additional information for online travel agency data.", "properties": { "accommodations": { "type": "array", "description": "The details of accommodation.", "items": { "type": "object", "required": [ "address", "check_in_date", "check_out_date", "guest_nationality", "guest_phone", "name", "room_type", "type" ], "properties": { "address": { "type": "object", "required": [ "city", "country_code", "postcode", "street" ], "description": "The address of this accommodation.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "check_in_date": { "type": "string", "description": "Check-in date, in YYYY-MM-DD format." }, "check_out_date": { "type": "string", "description": "Check-out date, in YYYY-MM-DD format." }, "early_checkin": { "type": "boolean", "description": "Indicates if early check-in was paid for." }, "guest_email": { "type": "string", "description": "Guest email address for communication and confirmations." }, "guest_name": { "type": "string", "description": "Full legal name of the guest." }, "guest_nationality": { "type": "string", "description": "Nationality of the guest (ISO 3166-1 alpha-2 code)." }, "guest_phone": { "type": "string", "description": "Guest phone number." }, "late_checkout": { "type": "boolean", "description": "Indicates if late checkout was paid for." }, "name": { "type": "string", "description": "Name of the accommodation." }, "pre_tax_amount": { "type": "number", "description": "Accommodation amount excluding tax." }, "ratings": { "type": "array", "description": "Hotel rating(s) (from various sources).", "items": { "type": "object", "properties": { "score": { "type": "string", "description": "The score of this rating." }, "source": { "type": "string", "description": "The source of this rating." }, "type": { "type": "string", "description": "The type of this rating. For example `Internal`, `External`." } } } }, "room_type": { "type": "string", "description": "Type of room. For example `Presidential Suite`, `Single Room`, `Double Room`, `Suite`." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the accommodation price." }, "type": { "type": "string", "description": "Type of accommodation. For example `Hotel`, `Hostel`, `Resort`, `Apartment`." } } } }, "buses": { "type": "array", "description": "The details of the buses travel.", "items": { "type": "object", "required": [ "arrival_city", "class_of_service", "departure_city", "passenger_name" ], "properties": { "arrival_city": { "type": "string", "description": "The city of the arrival. Maximum length is 100." }, "carrier": { "type": "string", "description": "The name of the transportation company." }, "class_of_service": { "type": "string", "description": "The itinerary service class." }, "departure_city": { "type": "string", "description": "The city of the departure. Maximum length is 100." }, "insurances": { "type": "array", "description": "The insurance list for the itinerary.", "items": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } } }, "passenger_identifier": { "type": "string", "description": "The identifier of the traveler in the merchant's system. Maximum length is 64." }, "passenger_name": { "type": "string", "description": "The name of the traveler. Maximum length is 100." }, "passenger_title": { "type": "string", "description": "The title used before the traveler’s name. One of `mr`, `ms`, and `mrs`." }, "price": { "type": "number", "description": "The itinerary unit price in payment intent currency." }, "scheduled_arrival_at": { "type": "string", "description": "The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." } } } }, "car_rentals": { "type": "array", "description": "The details of the car rental.", "items": { "type": "object", "required": [ "agreement_number", "driver_name", "driver_nationality", "drop_off_at", "pick_up_at" ], "properties": { "agreement_number": { "type": "string", "description": "Rental agreement number." }, "driver_email": { "type": "string", "description": "Driver email address for communication and confirmations." }, "driver_name": { "type": "string", "description": "Full legal name of the driver." }, "driver_nationality": { "type": "string", "description": "Nationality of the driver (ISO 3166-1 alpha-2 code)." }, "driver_phone": { "type": "string", "description": "Driver phone number." }, "drop_off_address": { "type": "object", "required": [ "city", "country_code", "street" ], "description": "The return address of this rental.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "drop_off_at": { "type": "string", "description": "Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "insurances": { "type": "array", "description": "The list of insurances.", "items": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } } }, "pick_up_address": { "type": "object", "required": [ "city", "country_code", "street" ], "description": "The start address of this rental.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "pick_up_at": { "type": "string", "description": "Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "pre_tax_amount": { "type": "number", "description": "Rental amount excluding tax." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the rental price." }, "vehicle": { "type": "object", "required": [ "license_plate", "manufacturer", "model" ], "description": "The details of the vehicle.", "properties": { "condition": { "type": "string", "description": "Condition of the vehicle. One of `GOOD`, `FAIR`, `POOR`." }, "license_plate": { "type": "string", "description": "License plate number." }, "manufacture_year": { "type": "string", "description": "Year of manufacture." }, "manufacturer": { "type": "string", "description": "Manufacturer of the vehicle." }, "model": { "type": "string", "description": "Model of the vehicle." }, "vin": { "type": "string", "description": "Vehicle Identification Number." } } } } } }, "customer": { "type": "object", "description": "Details of the customer making a payment for this Payment Intent.", "properties": { "loyalty_program_name": { "type": "string", "description": "The name of the loyalty program." }, "loyalty_program_points": { "type": "integer", "format": "int32", "description": "Points or miles in the loyalty program." }, "loyalty_program_tier": { "type": "string", "description": "Tier of the loyalty program. For example `Silver`, `Gold`, `Platinum`." }, "type": { "type": "string", "description": "Customer account type. One of `GUEST`, `MEMBER`." } } }, "ferries": { "type": "array", "description": "The details of the ferries travel.", "items": { "type": "object", "required": [ "arrival_city", "class_of_service", "departure_city", "passenger_name" ], "properties": { "arrival_city": { "type": "string", "description": "The city of the arrival. Maximum length is 100." }, "carrier": { "type": "string", "description": "The name of the transportation company." }, "class_of_service": { "type": "string", "description": "The itinerary service class." }, "departure_city": { "type": "string", "description": "The city of the departure. Maximum length is 100." }, "insurances": { "type": "array", "description": "The insurance list for the itinerary.", "items": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } } }, "passenger_identifier": { "type": "string", "description": "The identifier of the traveler in the merchant's system. Maximum length is 64." }, "passenger_name": { "type": "string", "description": "The name of the traveler. Maximum length is 100." }, "passenger_title": { "type": "string", "description": "The title used before the traveler’s name. One of `mr`, `ms`, and `mrs`." }, "price": { "type": "number", "description": "The itinerary unit price in payment intent currency." }, "scheduled_arrival_at": { "type": "string", "description": "The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." } } } }, "flights": { "type": "array", "description": "The details of the flights.", "items": { "type": "object", "required": [ "arrival_airport_code", "arrival_city", "arrival_country", "departure_airport_code", "departure_city", "departure_country", "flight_number", "passenger_name", "passenger_nationality", "scheduled_arrival_at", "scheduled_departure_at", "type" ], "properties": { "arrival_airport_code": { "type": "string", "description": "IATA code of the arrival airport." }, "arrival_city": { "type": "string", "description": "City where the arrival airport is located." }, "arrival_country": { "type": "string", "description": "Country where the arrival airport is located (ISO 3166-1 alpha-2 code)." }, "class_of_service": { "type": "string", "description": "Class of service. For example `Economy`, `Premium Economy`, `Business`, `First`." }, "departure_airport_code": { "type": "string", "description": "IATA code of the departure airport." }, "departure_city": { "type": "string", "description": "City where the departure airport is located." }, "departure_country": { "type": "string", "description": "Country where the departure airport is located (ISO 3166-1 alpha-2 code)." }, "flight_number": { "type": "string", "description": "Airline's unique flight number." }, "insurances": { "type": "array", "description": "The list of insurance.", "items": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } } }, "passenger_email": { "type": "string", "description": "Passenger email address for communication and confirmations." }, "passenger_name": { "type": "string", "description": "Full legal name of the passenger." }, "passenger_nationality": { "type": "string", "description": "Nationality of the passenger (ISO 3166-1 alpha-2 code)." }, "passenger_phone": { "type": "string", "description": "Passenger phone number." }, "pre_tax_amount": { "type": "number", "description": "Ticket amount excluding tax." }, "scheduled_arrival_at": { "type": "string", "description": "Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "seat_number": { "type": "string", "description": "Assigned seat number on the flight." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the ticket price." }, "type": { "type": "string", "description": "Whether the flight is domestic or international. One of `DOMESTIC`, `INTERNATIONAL`." } } } }, "order": { "type": "object", "required": [ "cancellable", "created_at" ], "description": "Purchase order related to this Payment Intent.", "properties": { "cancellable": { "type": "boolean", "description": "Indicates if the booking is cancellable." }, "created_at": { "type": "string", "description": "The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "prepayment_model": { "type": "string", "description": "The model of payment. One of `FULL`, `PARTIAL`." } } }, "trains": { "type": "array", "description": "The details of the trains travel.", "items": { "type": "object", "required": [ "arrival_city", "class_of_service", "departure_city", "passenger_name" ], "properties": { "arrival_city": { "type": "string", "description": "The city of the arrival. Maximum length is 100." }, "carrier": { "type": "string", "description": "The name of the transportation company." }, "class_of_service": { "type": "string", "description": "The itinerary service class." }, "departure_city": { "type": "string", "description": "The city of the departure. Maximum length is 100." }, "insurances": { "type": "array", "description": "The insurance list for the itinerary.", "items": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } } }, "passenger_identifier": { "type": "string", "description": "The identifier of the traveler in the merchant's system. Maximum length is 64." }, "passenger_name": { "type": "string", "description": "The name of the traveler. Maximum length is 100." }, "passenger_title": { "type": "string", "description": "The title used before the traveler’s name. One of `mr`, `ms`, and `mrs`." }, "price": { "type": "number", "description": "The itinerary unit price in payment intent currency." }, "scheduled_arrival_at": { "type": "string", "description": "The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." } } } } } } } }, "amount": { "type": "number", "description": "Payment amount. This is the order amount you would like to charge your customer. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "connected_account_id": { "type": "string", "description": "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." }, "currency": { "type": "string", "description": "Payment currency in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "customer": { "type": "object", "description": "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.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the customer.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "business_name": { "type": "string", "description": "Business name of the customer." }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of the customer in merchant's system. Maximum length is 64." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "customer_id": { "type": "string", "description": "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": { "type": "string", "description": "Descriptor that will display to the customer. Maximum length is 32." }, "device_data": { "type": "object", "description": "Client device information applicable when `payment_method` is set. It is recommended to provide this data for risk analysis.", "properties": { "accept_header": { "type": "string", "description": "Accept header value." }, "browser": { "type": "object", "description": "Browser specific data.", "properties": { "java_enabled": { "type": "boolean", "description": "Is Java enabled?" }, "javascript_enabled": { "type": "boolean", "description": "Is JavaScript enabled?" }, "user_agent": { "type": "string", "description": "User Agent header value." } } }, "device_id": { "type": "string", "description": "Device unique identifier or Advertisement unique identifier or IMEI." }, "ip_address": { "type": "string", "description": "Public IP address, both IPv4 and IPv6 are supported." }, "language": { "type": "string", "description": "Language or locale." }, "location": { "type": "object", "description": "Location data.", "properties": { "lat": { "type": "string", "description": "Latitude." }, "lon": { "type": "string", "description": "Longitude." } } }, "mobile": { "type": "object", "description": "Mobile specific data.", "properties": { "device_model": { "type": "string", "description": "Device model." }, "os_type": { "type": "string", "description": "OS type." }, "os_version": { "type": "string", "description": "OS version." } } }, "screen_color_depth": { "type": "integer", "format": "int32", "description": "Screen color depth in bits." }, "screen_height": { "type": "integer", "format": "int32", "description": "Screen height in pixels." }, "screen_width": { "type": "integer", "format": "int32", "description": "Screen width in pixels." }, "timezone": { "type": "string", "description": "Timezone offset to UTC in hours, with added minutes if necessary." } } }, "external_recurring_data": { "type": "object", "required": [ "triggered_by" ], "description": "Some merchants prefer to maintain the recurring payments on their own instead of using **Payment Consent**. Providing this data indicates the request is an external recurring payment.\nOnly effective when the `payment_method.type` is `card`, `applepay`, `googlepay`.", "properties": { "initial_payment": { "type": "boolean", "description": "Set this to `true` if it is the initial transaction request in a recurring series.\n\nDefault: `false`." }, "lifecycle_id": { "type": "string", "description": "The Mastercard **Transaction Link Identifier (TLID)**, assigned when the original payment in a recurring series is authorized, carried as ISO 8583 DE 105 Subfield 1. Provide it on subsequent merchant-initiated payments so issuers can link the series to the original authorization.\n\n- Pass it only on subsequent recurring payments over `card` where `triggered_by` is `merchant` and `initial_payment` is `false`." }, "merchant_trigger_reason": { "type": "string", "description": "Indicate if this subsequent payment is scheduled. Only applicable when `triggered_by` is `merchant`. One of `scheduled`, `unscheduled`, `installments`.\n\nDefault: `scheduled`." }, "original_transaction_id": { "type": "string", "description": "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).\nDo not pass this value when `initial_payment` is `true` or if you are not clear about the valid formats (as listed below).\n- Visa (`card`) - 15 digits unique ID Visa assigns to the response of the original authorization request, i.e. `123456789012345`\n- Mastercard (`card`) - 13 characters trace id (DE 63 Subfield 1 & 2 + DE 15) from the response of the original authorization request, i.e. `MCC123ABC0101`.\n" }, "terms_of_use": { "type": "object", "required": [ "payment_amount_type" ], "description": "Terms to specify how this Payment Consent will be used.", "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } } }, "triggered_by": { "type": "string", "description": "The party who initiated this subsequent payment request. One of `merchant`, `customer`." } } }, "funds_split_data": { "type": "array", "description": "When provided, it creates specified funds splits that are automatically released after the Payment Intent succeeds.", "items": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "Amount of this split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts\nIf a value is not specified, the destination will be as specified in the Payment Intent." } } } }, "merchant_category_code": { "type": "string", "description": "Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code." }, "merchant_order_id": { "type": "string", "description": "The order unique identifier created in merchant's order system that corresponds to this Payment Intent. Maximum length is 64." }, "merchant_website_url": { "type": "string", "description": "URL of the merchant's website where the customer is completing the transaction." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Intent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "order": { "type": "object", "description": "Purchase order related to this Payment Intent.", "properties": { "discount": { "type": "object", "description": "Discount used by the customer.", "properties": { "coupon_code": { "type": "string", "description": "Coupon code used." } } }, "foreign_retailer_amount": { "type": "number", "description": "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." }, "products": { "type": "array", "description": "Product list.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories." }, "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 128 characters." }, "desc": { "type": "string", "description": "Product description. Maximum of 500 characters." }, "effective_end_at": { "type": "string", "description": "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`)." }, "effective_start_at": { "type": "string", "description": "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`)." }, "image_url": { "type": "string", "description": "The preview image url for this product, which is usually displayed as thumbnail in the order details." }, "name": { "type": "string", "description": "Name of the product. Maximum of 255 characters." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "seller": { "type": "object", "description": "Seller info of the purchase order.", "properties": { "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system." } } }, "sku": { "type": "string", "description": "Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters." }, "type": { "type": "string", "description": "Type of product, such as `physical_good`, `intangible_good`, or `service`. Maximum of 128 characters." }, "unit_price": { "type": "number", "description": "Product unit price." }, "url": { "type": "string", "description": "The url that links to the product page at merchant site." } } } }, "sellers": { "type": "array", "description": "Seller list.", "items": { "type": "object", "properties": { "additional_info": { "type": "object", "description": "The additional information of the seller in the merchant's system for risk analysis.", "properties": { "address_updated_at": { "type": "string", "description": "The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "email_updated_at": { "type": "string", "description": "The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "password_updated_at": { "type": "string", "description": "The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "products_updated_at": { "type": "string", "description": "The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "sales_summary": { "type": "object", "description": "The sales summary of this seller during the last period.", "properties": { "currency": { "type": "string", "description": "The currency of sales amount." }, "period": { "type": "string", "description": "The period of this sales summary. Default to 12M (last 12 months)." }, "sales_amount": { "type": "number", "description": "The volume of sales completed by the seller in the last period." }, "sales_count": { "type": "integer", "format": "int32", "description": "The number of sales completed by the seller in the last period." } } } } }, "business_info": { "type": "object", "description": "The business information of the seller in the merchant's system for risk analysis.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the seller.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the seller." }, "phone_number": { "type": "string", "description": "Phone number of the seller." }, "rating": { "type": "number", "description": "The latest customer rating (out of 10) for this seller." }, "registration_date": { "type": "string", "description": "The date on which the seller registered in the merchant's system." } } }, "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system. Maximum length is 64." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system. Maximum length is 100." } } } }, "shipping": { "type": "object", "description": "Shipping information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Shipping address.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "fee_amount": { "type": "number", "description": "Shipping fee amount." }, "first_name": { "type": "string", "description": "First name of the recipient. Maximum of 128 characters." }, "last_name": { "type": "string", "description": "Last name of the recipient. Maximum of 128 characters." }, "phone_number": { "type": "string", "description": "Phone number of the recipient. Maximum of 50 characters." }, "shipping_delayed_at": { "type": "string", "description": "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": { "type": "string", "description": "Shipping method for the product. Maximum of 128 characters." } } }, "supplier": { "type": "object", "description": "Deprecated. \n \nUse `order.sellers` instead.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the supplier.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "business_name": { "type": "string", "description": "Business name of the supplier. Maximum length is 128." }, "email": { "type": "string", "description": "Email address of the supplier." }, "first_name": { "type": "string", "description": "First name of the supplier. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the supplier. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the supplier." } } }, "surcharge": { "type": "object", "required": [ "amount" ], "description": "Surcharge Information.", "properties": { "amount": { "type": "number", "description": "The surcharge amount. This amount is included in the Payment Intent's total `amount`." } } }, "tip": { "type": "object", "required": [ "amount" ], "description": "Tip information.", "properties": { "amount": { "type": "number", "description": "The tip amount. This amount is included in the total `amount`." } } }, "type": { "type": "string", "description": "Industry category of the order. Maximum of 128 characters." } } }, "payment_consent": { "type": "object", "required": [ "next_triggered_by" ], "description": "The associated **Payment Consent** to set up along with the Payment Intent. Only effective when the `payment_method.type` is `card`.", "properties": { "merchant_trigger_reason": { "type": "string", "description": "Indicate whether the subsequent payments are scheduled. Only applicable when `next_triggered_by` is `merchant`.\nDefault: `unscheduled`.", "enum": [ "installments", "scheduled", "unscheduled" ] }, "next_triggered_by": { "type": "string", "description": "The party to trigger subsequent payments. One of `merchant`, `customer`." }, "terms_of_use": { "type": "object", "required": [ "payment_amount_type" ], "description": "Terms to specify how this Payment Consent will be used.", "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } } } } }, "payment_method": { "type": "object", "description": "The payment method details to confirm the Payment Intent. The Payment Intent will be confirmed automatically when `payment_method` is set.", "properties": { "applepay": { "type": "object", "description": "Applepay information. This must be provided if `type` is set to `applepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "Payment data from Apple Pay Payment Token." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "card": { "type": "object", "description": "Information required for online card transactions. This must be provided if `type` is set to `card`.", "properties": { "additional_info": { "type": "object", "description": "Additional information of external network token requestor. Should be provided when number_type is `EXTERNAL_NETWORK_TOKEN`.", "properties": { "merchant_verification_value": { "type": "string", "description": "Merchant Verification Value (Provided by VISA during onboarding)\nor\nMasterCard Assigned ID (Provided by MasterCard during onboarding)." }, "token_requestor_id": { "type": "string", "description": "Token requestor unique identifier (Provided by card schemes during onboarding)." } } }, "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "cryptogram": { "type": "string", "description": "The cryptogram value. Must be provided if card.number_type is `EXTERNAL_NETWORK_TOKEN`. Maximum length is 28." }, "cvc": { "type": "string", "description": "CVC code of this card. Required for all transactions except merchant initiated transactions and network tokenized transactions." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "external_three_ds": { "type": "object", "description": "Authentication data from an external 3D-Secure provider (3RI for MIT subsequent transaction).", "properties": { "authentication_value": { "type": "string", "description": "Authentication value, will be used to provide proof of authentication for 3DS v2." }, "ds_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the Directory Server to identify a single transaction for 3DS v2." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder." }, "three_ds_exemption": { "type": "string", "description": "Add the SCA exemptions if your 3DS provider decides any exemptions are applicable. One of `TRA`, `LVP`, `ANONYMOUS`." }, "three_ds_server_transaction_id": { "type": "string", "format": "uuid", "description": "UUID assigned by the 3DS server to identify a single transaction for 3DS v2." }, "version": { "type": "string", "description": "3DS version in the format major.minor.patch." } } }, "korean_card": { "type": "object", "required": [ "password_first2" ], "description": "Information for Korean Card.", "properties": { "business_number": { "type": "string", "description": "A 10-digit business number of the company. Either `business_number` or `date_of_birth` must be provided." }, "date_of_birth": { "type": "string", "description": "A 6-digit date of birth in the format of YYMMDD. Either `business_number` or `date_of_birth` must be provided." }, "password_first2": { "type": "string", "description": "Card password first 2 digits." } } }, "name": { "type": "string", "description": "Card holder name. Maximum length is 128." }, "number": { "type": "string", "description": "Card number." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`. Default: `PAN`." } } }, "card_present": { "type": "object", "required": [ "cardholder_verification_method", "pan_entry_mode", "terminal_info" ], "description": "Information required for card-present transactions. This must be provided if `type` is set to `card_present`.", "properties": { "cardholder_verification_method": { "type": "string", "description": "Cardholder verification method. \n- `offline_pin`: The PIN is verified offline by the EMV chip card. \n- `online_pin`: The PIN is encrypted and verified online by issuers or card schemes. `encrypted_pin` is required for `online_pin`. \n- `manual_signature`: The cardholder signature on the receipt is compared to the signature on the back of the card. \n- `no_cvm`: No verification needed. \n- `cdcvm`: Cardholder device verification method. The cardholder is verified using a device's authentication method. \n- `offline_pin_and_signature`: Both an offline PIN and a manual signature are used to verify the cardholder. \n- `skipped`: Verification process was bypassed." }, "emv_tags": { "type": "string", "description": "Tag-length-value (TLV)-encoded data read from a chip card. Required when pan_entry_mode is chip, contactless_chip. \n \nMandatory tags: \n- 82 - Application interchange profile \n- 84 - Dedicated file name \n- 95 - Terminal verification results \n- 9A - Application date \n- 9C - Transaction type \n- 5F2A - Transaction currency code \n- 9F02 - Amount authorized \n- 9F10 - Issuer application data \n- 9F1A - Terminal country code \n- 9F26 - Application cryptogram \n- 9F27 - Cryptogram information \n- 9F34 - Cardholder verification method results \n- 9F36 - Application transaction counter \n- 9F37 - Unpredictable number \n- 9F6E - Form factor indicator / Third party data \n \nRecommended tags: \n- 9F33 - Terminal capabilities \n- 9F35 - Terminal type \n- 9F41 - Transaction sequence counter \n \nProvide if present: \n- 5F34 - Card sequence number." }, "encrypted_pin": { "type": "string", "description": "Encrypted personal identification number. Required when `cardholder_verification_method` is `online_pin`." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month. Required when `pan_entry_mode` is `manual_entry`." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year. Required when `pan_entry_mode` is `manual_entry`." }, "fallback": { "type": "boolean", "description": "The default is `false`. Set to `true` when: \n- 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`. \n- 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": { "type": "string", "description": "Fallback reason applicable when `fallback` is `true`. \nSet to `chip_read_failure` when all of the following conditions are met: \n- The transaction is initiated at a chip-capable terminal. \n- `pan_entry_mode` is `magstripe`. \n- The previous transaction initiated by the terminal was an unsuccessful chip read." }, "key_serial_number": { "type": "string", "description": "Key serial number while using DUKPT for PIN encryption." }, "number": { "type": "string", "description": "Card number. Required when `pan_entry_mode` is `manual_entry`." }, "pan_entry_mode": { "type": "string", "description": "The way the terminal reads the card information. \n- `manual_entry`: Manually keyed into POS terminal. \n- `chip`: Read from direct contact with a chip card. \n- `magstripe`: Read from direct contact with magnetic stripe card. \n- `contactless_chip`: Read from a contactless interface using chip data. \n- `contactless_magstripe`: Read from a contactless interface using magnetic stripe data (MSD)." }, "terminal_info": { "type": "object", "required": [ "pin_entry_capability", "supported_pan_entry_modes", "terminal_identifier" ], "description": "Data obtained by the POS terminal from the card and terminal properties.", "properties": { "mobile_device": { "type": "boolean", "description": "Indicate whether the POS terminal is a mobile POS device. Default is `false`." }, "pin_entry_capability": { "type": "string", "description": "Describe the capability of the terminal device to accept PIN. \n- `unsupported`: Terminal does not have PIN entry capability. \n- `supported`: Terminal has PIN entry capability. Except the case suitable for software_based. \n- `software_based`: For a mobile POS device, a user can input PIN through software-based keyboard. \n- `disabled`: Terminal has PIN entry capability but PIN pad is not currently operative." }, "support_single_tap_with_pin": { "type": "boolean", "description": "Indicate whether the POS terminal could respond to a `request_pin` action. Default is `false`." }, "supported_pan_entry_modes": { "type": "array", "description": "List of `pan_entry_modes` supported by the terminal.", "items": { "type": "string" } }, "terminal_identifier": { "type": "string", "description": "An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system." }, "terminal_type": { "type": "string", "description": "Type of the POS terminal that processes this payment. \n- `attended_pos`: dedicated pos devices that attended by a merchant staff. \n- `unattended_pos`: dedicated pos devices that not attended. \n- `android_softpos`: android mobile devices that can work as pos device with software. \n- `ios_softpos`: iOS mobile devices that can work as pos device with software." }, "use_embedded_reader": { "type": "boolean", "description": "Indicate whether the reader is embedded in a mobile POS device. Default is `true`." } } }, "track1": { "type": "string", "description": "Track 1 read from magnetic stripe card." }, "track2": { "type": "string", "description": "Track 2 is read from a magnetic stripe card or is track 2 equivalent data get from the chip card. \nTrack 2 is required when `pan_entry_mode` is not `manual_entry`." } } }, "googlepay": { "type": "object", "description": "Googlepay information. This must be provided if `type` is set to `googlepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "A UTF-8 encoded, serialized JSON object with the keys specified." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "id": { "type": "string", "description": "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": { "type": "object", "description": "Pay now information. This must be provided if `type` is set to `pay_now`.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "shopper_name": { "type": "string", "description": "The name of the shopper." } } }, "type": { "type": "string", "description": "Type of the Payment Method. One of `card`, `card_present`, `applepay`, `googlepay`, `wechatpay`, `pay_now`." }, "wechatpay": { "type": "object", "required": [ "flow" ], "description": "Wechatpay information. This must be provided if `type` is set to `wechatpay`.", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "flow": { "type": "string", "description": "The specific WeChat Pay flow to use. One of `qrcode`, `official_account`, `mini_program`, `mobile_app`, `mobile_web`." }, "open_id": { "type": "string", "description": "Required when `flow` is `mini_program`." } } } } }, "payment_method_options": { "type": "object", "description": "Options for Payment Method.", "properties": { "card": { "type": "object", "description": "The Payment Method options for card.", "properties": { "authorization_type": { "type": "string", "description": "The authorization type of the card payment. One of `final_auth`, `pre_auth`. Only applicable when `payment_method` is provided. Default to `final_auth`. Currently only available when `brand` is `visa` or `mastercard`." }, "auto_capture": { "type": "boolean", "description": "Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when `payment_method` is provided. Default to `true`." }, "card_input_via": { "type": "string", "description": "The channel through which the cardholder inputs the card. One of `ecommerce`, `moto`." }, "merchant_trigger_reason": { "type": "string", "description": "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.", "enum": [ "delayed_charges", "incremental_authorization", "no_show", "partial_shipment", "reauthorization", "resubmission" ] }, "three_ds_action": { "type": "string", "description": "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." } } }, "wechatpay": { "type": "object", "description": "The Payment Method options for wechatpay.", "properties": { "enable_funds_split": { "type": "boolean", "description": "Indicates whether funds split will be enabled for this WeChat Pay order." } } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after payment authentication." }, "risk_control_options": { "type": "object", "description": "Risk Control Options.", "properties": { "skip_risk_processing": { "type": "boolean", "description": "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`. " }, "tra_applicable": { "type": "boolean", "description": "Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing." } } } } }, "examples": { "default": { "value": { "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", "merchant_website_url": "https://www.example.com/", "metadata": { "foo": "bar" } } } } } }, "description": "Payment Intent creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "b01737e5-c5ab-4765-8834-cbd92dfeaf81", "amount": 100, "currency": "USD", "status": "REQUIRES_PAYMENT_METHOD", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiaW50ZW50X2lkIjoiaW50X2hrcGRza3o3dmcxeGM3dXNjZGoiLCJjdXN0b21lcl9pZCI6IjlmYWZjMmZiLTQyNjItNGZmOC1hMjA1LWQ2MGZiNDc4MWNiMCJ9.Rg1M2Vl0GDARU0rnTghenUVe9v1ix1IrSQOxQO7Zqyw", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T06:57:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `suspended_from_online_payments`, `currency_not_supported`, `resource_not_found`(invalid `customer_id`).\n\nIf `payment_method` is set in the request, the possible error codes also include those documented for **/api/v1/pa/payment_intents/{id}/confirm** API." }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "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", "merchant_website_url": "https://www.example.com/", "metadata": { "foo": "bar" } }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "b01737e5-c5ab-4765-8834-cbd92dfeaf81", "amount": 100, "currency": "USD", "status": "REQUIRES_PAYMENT_METHOD", "merchant_order_id": "D202503210001", "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzgzMDY2MzAsImV4cCI6MTczODMxMDIzMCwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiSEsiLCJhY2NvdW50X2lkIjoiN2EwYzQ3YzctNzM0Zi00NzdmLTk1OWItMzIxNTQyNzgxYTgyIiwiaW50ZW50X2lkIjoiaW50X2hrcGRza3o3dmcxeGM3dXNjZGoiLCJjdXN0b21lcl9pZCI6IjlmYWZjMmZiLTQyNjItNGZmOC1hMjA1LWQ2MGZiNDc4MWNiMCJ9.Rg1M2Vl0GDARU0rnTghenUVe9v1ix1IrSQOxQO7Zqyw", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T06:57:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/increment_authorization": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "8|Increment Authorization for a Payment Intent", "description": "Allows you to authorize additional funds on an existing Payment Intent before capture. This is useful when the final payment amount is not known upfront, such as in hotel or car rental scenarios. Only a single capture and clearing occurs for the final authorized amount.", "operationId": "incrementAuthorization", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "payment_intent_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "request_id" ], "properties": { "amount": { "type": "number", "description": "The new total amount to authorize, which must be greater than the previously authorized total amount on this Payment Intent. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "amount": 100, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "description": "Payment Intent incremental authorization request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "additional_info": { "account_funding_data": { "recipient": { "account_number": "1234567890", "address": { "city": "New York", "country_code": "US", "line1": "123 Main Street", "line2": "Apt 4B", "postcode": "10001", "state": "NY" }, "first_name": "Jane", "last_name": "Smith", "middle_name": "B" }, "sender": { "address": { "city": "New York", "country_code": "US", "line1": "123 Main Street", "line2": "Apt 4B", "postcode": "10001", "state": "NY" }, "date_of_birth": "1989-07-15", "first_name": "John", "last_name": "Doe", "middle_name": "A" }, "transfer_between_own_accounts": true, "type": "ACCOUNT_TO_ACCOUNT_TRANSFER" }, "customer_activity_data": { "account_type": "VIP", "first_successful_order_date": "2019-09-18", "last_login_ip_address": "212.121.222.123", "last_modified_at": "2019-09-18T12:30:00Z", "linked_social_networks": [ { "email": "john.doe@airwallex.com", "name": "TWITTER", "profile_id": "johnd0e123" } ], "purchase_summaries": [ { "currency": "USD", "first_successful_purchase_date": "2019-01-01", "last_successful_purchase_date": "2019-01-01", "payment_method_type": "klarna", "successful_purchase_amount": 123.45, "successful_purchase_count": 1 } ], "registered_via_social_media": false, "registration_date": "2019-09-18", "registration_ip_address": "212.121.222.123" }, "enhanced_scheme_data": { "customer": { "first_name": "John", "last_name": "Doe", "reference": "CUST12345" }, "customer_tax_identifier": "DE123456789", "duty_amount": 10.01, "invoice_reference": "INV2023000123", "local_tax_amount": 5.01, "merchant_tax_identifier": "202312345K", "national_tax_amount": 8.01, "products": [ { "code": "3414314111", "commodity_code": "08081010", "description": "IPHONE 7.", "discount_amount": 10.01, "quantity": 5, "tax_percent": 10.55, "total_amount": 500.05, "total_tax_amount": 10.01, "unit": "EAC", "unit_price": 100.01 } ], "shipping": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date": "2024-09-29", "fee_amount": 1.5, "from_postcode": "100000" }, "summary_commodity_code": "08081000", "total_tax_amount": 13.02, "vat_invoice_reference": "INV2023000123" }, "online_ticket_agency_data": { "events": [ { "arena_location": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "arena_name": "Gelredome", "arena_seat_number": "11A", "company": "Ticketmaster", "customer_name": "John Doe", "customer_title": "mr", "ends_at": "2025-01-22T08:30:00Z", "name": "Lady Gaga, the Chromatica Ball", "starts_at": "2025-01-22T08:30:00Z", "type": "Music concert" } ] }, "online_travel_agency_data": { "accommodations": [ { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "check_in_date": "2016-09-09", "check_out_date": "2016-09-13", "early_checkin": true, "guest_email": "Alex@airwallex.com", "guest_name": "Alex D", "guest_nationality": "US", "guest_phone": "123456789", "late_checkout": true, "name": "Hilton Garden Inn", "pre_tax_amount": 123.45, "ratings": [ { "score": "4.99", "source": "Yelp", "type": "External" } ], "room_type": "Presidential Suite", "tax_amount": 234.56, "type": "Hotel" } ], "buses": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ], "car_rentals": [ { "agreement_number": "1234567890", "driver_email": "Alex@airwallex.com", "driver_name": "Alex D", "driver_nationality": "US", "driver_phone": "1267820876", "drop_off_address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "drop_off_at": "2025-01-23T08:30:00Z", "insurances": [], "pick_up_address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "pick_up_at": "2025-01-22T08:30:00Z", "pre_tax_amount": 123.45, "tax_amount": 234.56, "vehicle": { "condition": "GOOD", "license_plate": "ABC123", "manufacture_year": "2025", "manufacturer": "Toyota", "model": "Camry", "vin": "1HGCM82633A" } } ], "customer": { "loyalty_program_name": "Frequent Flyer Program", "loyalty_program_points": 1000, "loyalty_program_tier": "Platinum", "type": "GUEST" }, "ferries": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ], "flights": [ { "arrival_airport_code": "NRT", "arrival_city": "Tokyo", "arrival_country": "JP", "class_of_service": "Economy", "departure_airport_code": "SIN", "departure_city": "Singapore", "departure_country": "SG", "flight_number": "PY789", "insurances": [], "passenger_email": "Alex@airwallex.com", "passenger_name": "Alex D", "passenger_nationality": "US", "passenger_phone": "12345567", "pre_tax_amount": 123.45, "scheduled_arrival_at": "2025-01-22T09:18:21Z", "scheduled_departure_at": "2025-01-22T08:18:21Z", "seat_number": "41A", "tax_amount": 234.56, "type": "INTERNATIONAL" } ], "order": { "cancellable": true, "created_at": "2025-01-22T07:18:21Z", "prepayment_model": "FULL" }, "trains": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ] } }, "amount": 100, "cancellation_reason": "Order cancelled", "cancelled_at": "2019-09-18T03:11:00+00:00", "captured_amount": 100, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NTk0OTM1NzUsImV4cCI6MTY1OTQ5NzE3NSwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiU0ciLCJhY2NvdW50X2lkIjoiMGFjZTdkY2EtMzUzOC00NGUwLWI2OGEtYjQwYjY1MWIzMDE5IiwiaW50ZW50X2lkIjoiaW50X3Nnc3RiOXRic2djOG90bndlMGoiLCJidXNpbmVzc19uYW1lIjoiV2lzaGNvbSBTaGFuZ2hhaSJ9.rqKdwFjF4ba8h2hsbppBxkmAhCcPbSdl_YhC7J_i8so", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "conversion_quote_id": "cvq_hkpd5k6pgfub1fyurc86", "created_at": "2019-09-18T03:11:00+00:00", "currency": "USD", "customer": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "business_name": "Abc Trading Limited", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "merchant_customer_id": "", "phone_number": "13800000000" }, "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "descriptor": "Airwallex - T-shirt", "funds_split_data": [ { "amount": 12.3, "destination": "acct_s23lj4h1" } ], "id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "invoice_id": "", "latest_payment_attempt": { "acquirer_reference_number": "9.328788974770498e+22", "amount": 100.1, "authentication_data": { "authentication_type": "passkey", "avs_result": "pass", "cvc_result": "pass", "ds_data": { "cavv": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=", "challenge_cancellation_reason": "time out", "eci": "05", "enrolled": "Y", "frictionless": "Y", "liability_shift_indicator": "Y", "pa_res_status": "Y", "version": "2.1.0", "xid": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=" }, "fraud_data": { "action": "ACCEPT", "post_authorization_check": { "action": "ACCEPT", "risk_factors": [ { "description": "The transaction URL does not match the merchant's URL." } ], "score": "-1" }, "risk_factors": [ { "description": "The transaction URL does not match the merchant's URL." } ], "score": "-1" }, "passkey_setup_status": "SETUP_COMPLETED" }, "authorization_code": "525674", "captured_amount": 100.1, "created_at": "2019-09-18T03:11:00+00:00", "currency": "", "dcc_data": { "amount": 686.76, "currency": "USD" }, "failure_code": "authentication_failed", "failure_details": { "code": "", "details": {}, "message": "", "trace_id": "" }, "id": "att_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "merchant_advice_code": "01", "merchant_order_id": "", "payment_consent_id": "", "payment_intent_id": "", "payment_method": { "ach_direct_debit": { "aba_routing_number": "123456789", "account_number": "1234567890", "business_account": false, "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "airwallex_pay": { "payer_name": "John Doe" }, "alfamart": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "alipaycn": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "alipayhk": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "applepay": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "lifecycle_id": "", "payment_data_type": "encrypted_payment_token", "tokenized_card": { "authentication_method": { "emv": { "emv_data": "", "encrypted_pin_data": "" }, "three_ds": { "eci_indicator": "", "online_payment_cryptogram": "" }, "type": "" }, "bin": "411111", "brand": "visa", "device_manufacturer_identifier": "050110030222", "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "type": "debit" } }, "atome": { "shopper_phone": "+6587654321" }, "bacs_direct_debit": { "account_number": "12345678", "address": { "country_code": "GB", "line1": "777 Casino Drive", "line2": "Apartment 123", "postcode": "A11 B12", "state": "CA", "town": "LONDON" }, "bank_name": "revolut", "business_account": false, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe", "sort_code": "123456" }, "bancontact": { "shopper_name": "Alex Wang" }, "bank_transfer": { "bank_name": "bangkok", "country_code": "ID", "expires_at": "2025-09-18T12:30:00Z", "ga_mode": "PAYER_GA", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "becs_direct_debit": { "account_number": "1234567890", "bsb_number": "123456", "business_account": false, "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "bitpay": { "country_code": "US", "shopper_name": "Alex Wang" }, "blik": { "shopper_name": "Alex Wang" }, "boost": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "card": { "additional_info": { "merchant_verification_value": "A52BD7", "token_requestor_id": "50272768100" }, "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "bin": "411111", "brand": "visa", "card_type": "credit", "card_updater_info": { "expiry_updated": false, "number_updated": false }, "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "korean_card": { "business_number": "97XXXXXX11", "date_of_birth": "890630", "password_first2": "00" }, "last4": "1111", "lifecycle_id": "", "name": "John Doe", "number_type": "PAN" }, "card_present": { "aid": "", "bin": "411111", "brand": "visa", "card_sequence_number": "", "card_type": "credit", "cardholder_verification_method": "online_pin", "contactless_card_form_factor": "", "emv_tags": "", "expiry_month": "12", "expiry_year": "2030", "fallback": false, "fallback_reason": "", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "pan_entry_mode": "contactless_chip", "receipt": { "retrieval_reference_number": "", "system_trace_audit_number": "", "terminal_verification_results": "" }, "terminal_info": { "mobile_device": false, "pin_entry_capability": "supported", "support_single_tap_with_pin": false, "supported_pan_entry_modes": [], "terminal_identifier": "123", "terminal_type": "attended_pos", "use_embedded_reader": false } }, "created_at": "2019-09-18T03:11:00+00:00", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "dana": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "doku_ewallet": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "dragonpay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "duit_now": { "shopper_name": "Alex Wang" }, "eft_direct_debit": { "account_number": "1234567890", "business_account": false, "institution_number": "123", "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe", "transit_number": "12345-678" }, "eps": { "shopper_name": "Alex Wang" }, "esun": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "family_mart": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "fps": { "flow": "qrcode" }, "fpx": { "bank_name": "affin", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "gcash": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "go_pay": { "shopper_name": "Alex Wang" }, "googlepay": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "lifecycle_id": "", "payment_data_type": "encrypted_payment_token", "tokenized_card": { "authentication_method": { "emv": { "emv_data": "", "encrypted_pin_data": "" }, "three_ds": { "eci_indicator": "", "online_payment_cryptogram": "" }, "type": "" }, "bin": "411111", "brand": "visa", "device_manufacturer_identifier": "050110030222", "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "type": "debit" } }, "grabpay": { "shopper_name": "Alex Wang" }, "hi_life": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "id": "mtd_unun8upp2g4yc1lzax4", "ideal": { "bank_name": "rabobank", "shopper_name": "Alex Wang" }, "indomaret": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "jenius_pay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "kakaopay": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "klarna": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "country_code": "US", "language": "en" }, "konbini": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "04501582125" }, "linkaja": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "maxima": { "shopper_name": "Alex Wang" }, "metadata": { "id": "1" }, "multibanco": { "shopper_name": "Alex Wang" }, "mybank": { "shopper_name": "Alex Wang" }, "narvesen": { "shopper_name": "Alex Wang" }, "online_banking": { "bank_name": "krungsri_bank", "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "ovo": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "p24": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "pay_now": { "channel": "pos", "shopper_name": "Alex Wang" }, "paybybankapp": { "shopper_name": "Alex Wang" }, "payeasy": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "04501582125" }, "paypal": { "country_code": "US", "shopper_name": "Alex Wang" }, "paypost": { "shopper_name": "Alex Wang" }, "paysafecard": { "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "paysafecash": { "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "paysera": { "bank_name": "as_citadele_banka", "country_code": "US", "shopper_name": "Alex Wang" }, "payto": { "bsb": { "account_name": "John Doe", "account_number": "123456789", "bsb_number": "123456" }, "pay_id": { "australian_business_number": "12345678901", "organisation_id": "payid:airwallex.com/airwallex", "owner_email": "john.doe@airwallex.com", "phone_number": "+61 411111111" } }, "payu": { "shopper_name": "Alex Wang" }, "perlas_terminals": { "shopper_name": "Alex Wang" }, "prompt_pay": { "shopper_name": "Alex Wang" }, "rabbit_line_pay": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "satispay": { "country_code": "US", "shopper_name": "Alex Wang" }, "sepa_direct_debit": { "address": { "country_code": "DE", "postcode": "36199", "street": "456 White Finch St.", "town": "Rotenburg an der Fulda" }, "bank_name": "revolut", "business_account": false, "country_code": "DE", "iban": "DE1234567890234", "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "seven_eleven": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "shopee_pay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "skrill": { "country_code": "MY", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "status": "CREATED", "tabby": { "language": "ar", "shopper_email": "alex.wang@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "+971500000001" }, "tng": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "truemoney": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "trustly": { "country_code": "NL", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "type": "card", "updated_at": "2019-09-18T03:11:00+00:00", "verkkopankki": { "bank_name": "aktia", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "wechatpay": { "channel": "pos", "flow": "qrcode" }, "zip": { "shopper_name": "Alex Wang" } }, "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true } }, "payment_method_transaction_id": "", "provider_original_response_code": "00", "provider_transaction_id": "", "refunded_amount": 100.1, "settle_via": "", "status": "AUTHORIZED", "terminal_id": "ter_pdw6jk9h6ou84c89o", "updated_at": "2019-09-18T03:11:00+00:00" }, "merchant_order_id": "cc9bfc13-ba30-483b-a62c-ee925fc9bfea", "metadata": { "id": "1" }, "next_action": { "content_type": "POST", "data": {}, "dcc_data": { "amount": 144.72, "client_rate": 0.691, "currency": "AUD", "currency_pair": "AUDUSD", "rate_expiry": "2020-06-09T06:11:32+00:00", "rate_timestamp": "2020-06-09T06:01:32+00:00" }, "fallback_url": "https://www.airwallex.com", "method": "POST", "package_name": "id.dana", "qrcode": "weixin://wxpay/bizpayurl?pr=5xtGdR4", "type": "redirect", "url": "https://www.airwallex.com" }, "order": { "discount": { "coupon_code": "CD3243012" }, "foreign_retailer_amount": 0, "products": [ { "category": "Apparel and accessories", "code": "3414314111", "desc": "IPHONE 7", "effective_end_at": "2020-12-31T23:59:59Z", "effective_start_at": "2020-01-01T00:00:00Z", "image_url": "https://example.airwallex.com/product/12345.png", "name": "IPHONE7", "quantity": 5, "sku": "100004", "type": "physical", "unit_price": 100.01, "url": "https://example.airwallex.com/product/12345" } ], "sellers": [ { "additional_info": { "address_updated_at": "2023-01-01T00:00:00Z", "email_updated_at": "2023-01-01T00:00:00Z", "password_updated_at": "2023-01-01T00:00:00Z", "products_updated_at": "2023-01-01T00:00:00Z" }, "business_info": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "email": "john.doe@airwallex.com", "phone_number": "13800000000", "rating": 4.5, "registration_date": "2019-09-18" } } ], "shipping": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "fee_amount": 1.5, "first_name": "John", "last_name": "Doe", "phone_number": "13800000000", "shipping_company": "dhl US", "shipping_delayed_at": "2019-09-18T12:30:00Z", "shipping_method": "sameday", "tracking_number": "199473619321", "tracking_url": "https://www.example.com" }, "surcharge": { "amount": 10, "percent": 5 }, "tip": { "amount": 10 }, "type": "physical_goods" }, "payment_consent": { "merchant_trigger_reason": "unscheduled", "next_triggered_by": "merchant", "terms_of_use": { "billing_cycle_charge_day": 5, "end_date": "2025-09-22", "first_payment_amount": 105, "fixed_payment_amount": 100, "max_payment_amount": 500, "min_payment_amount": 500, "payment_amount_type": "FIXED", "payment_currency": "AUD", "payment_schedule": { "period": 1, "period_unit": "MONTH" }, "start_date": "2024-09-22", "total_billing_cycles": 12 } }, "payment_consent_id": "cst_u79lnfufjxxfdc0", "payment_link_id": "ee939540-3203-4a2c-9172-89a566485dd9", "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true, "card_input_via": "", "merchant_trigger_reason": "reauthorization", "three_ds_action": "FORCE_3DS" }, "wechatpay": { "enable_funds_split": false } }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "return_url": "", "risk_control_options": { "skip_risk_processing": false, "tra_applicable": false }, "status": "SUCCEEDED", "triggered_by": "merchant", "updated_at": "2019-09-18T03:11:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `operation_not_supported, `provider_unavailable`, `configuration_error`, `risk_declined`, `provider_declined`, `issuer_declined`." }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/payment_intent_id/increment_authorization", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 100, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "additional_info": { "account_funding_data": { "recipient": { "account_number": "1234567890", "address": { "city": "New York", "country_code": "US", "line1": "123 Main Street", "line2": "Apt 4B", "postcode": "10001", "state": "NY" }, "first_name": "Jane", "last_name": "Smith", "middle_name": "B" }, "sender": { "address": { "city": "New York", "country_code": "US", "line1": "123 Main Street", "line2": "Apt 4B", "postcode": "10001", "state": "NY" }, "date_of_birth": "1989-07-15", "first_name": "John", "last_name": "Doe", "middle_name": "A" }, "transfer_between_own_accounts": true, "type": "ACCOUNT_TO_ACCOUNT_TRANSFER" }, "customer_activity_data": { "account_type": "VIP", "first_successful_order_date": "2019-09-18", "last_login_ip_address": "212.121.222.123", "last_modified_at": "2019-09-18T12:30:00Z", "linked_social_networks": [ { "email": "john.doe@airwallex.com", "name": "TWITTER", "profile_id": "johnd0e123" } ], "purchase_summaries": [ { "currency": "USD", "first_successful_purchase_date": "2019-01-01", "last_successful_purchase_date": "2019-01-01", "payment_method_type": "klarna", "successful_purchase_amount": 123.45, "successful_purchase_count": 1 } ], "registered_via_social_media": false, "registration_date": "2019-09-18", "registration_ip_address": "212.121.222.123" }, "enhanced_scheme_data": { "customer": { "first_name": "John", "last_name": "Doe", "reference": "CUST12345" }, "customer_tax_identifier": "DE123456789", "duty_amount": 10.01, "invoice_reference": "INV2023000123", "local_tax_amount": 5.01, "merchant_tax_identifier": "202312345K", "national_tax_amount": 8.01, "products": [ { "code": "3414314111", "commodity_code": "08081010", "description": "IPHONE 7.", "discount_amount": 10.01, "quantity": 5, "tax_percent": 10.55, "total_amount": 500.05, "total_tax_amount": 10.01, "unit": "EAC", "unit_price": 100.01 } ], "shipping": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date": "2024-09-29", "fee_amount": 1.5, "from_postcode": "100000" }, "summary_commodity_code": "08081000", "total_tax_amount": 13.02, "vat_invoice_reference": "INV2023000123" }, "online_ticket_agency_data": { "events": [ { "arena_location": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "arena_name": "Gelredome", "arena_seat_number": "11A", "company": "Ticketmaster", "customer_name": "John Doe", "customer_title": "mr", "ends_at": "2025-01-22T08:30:00Z", "name": "Lady Gaga, the Chromatica Ball", "starts_at": "2025-01-22T08:30:00Z", "type": "Music concert" } ] }, "online_travel_agency_data": { "accommodations": [ { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "check_in_date": "2016-09-09", "check_out_date": "2016-09-13", "early_checkin": true, "guest_email": "Alex@airwallex.com", "guest_name": "Alex D", "guest_nationality": "US", "guest_phone": "123456789", "late_checkout": true, "name": "Hilton Garden Inn", "pre_tax_amount": 123.45, "ratings": [ { "score": "4.99", "source": "Yelp", "type": "External" } ], "room_type": "Presidential Suite", "tax_amount": 234.56, "type": "Hotel" } ], "buses": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ], "car_rentals": [ { "agreement_number": "1234567890", "driver_email": "Alex@airwallex.com", "driver_name": "Alex D", "driver_nationality": "US", "driver_phone": "1267820876", "drop_off_address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "drop_off_at": "2025-01-23T08:30:00Z", "insurances": [], "pick_up_address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "pick_up_at": "2025-01-22T08:30:00Z", "pre_tax_amount": 123.45, "tax_amount": 234.56, "vehicle": { "condition": "GOOD", "license_plate": "ABC123", "manufacture_year": "2025", "manufacturer": "Toyota", "model": "Camry", "vin": "1HGCM82633A" } } ], "customer": { "loyalty_program_name": "Frequent Flyer Program", "loyalty_program_points": 1000, "loyalty_program_tier": "Platinum", "type": "GUEST" }, "ferries": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ], "flights": [ { "arrival_airport_code": "NRT", "arrival_city": "Tokyo", "arrival_country": "JP", "class_of_service": "Economy", "departure_airport_code": "SIN", "departure_city": "Singapore", "departure_country": "SG", "flight_number": "PY789", "insurances": [], "passenger_email": "Alex@airwallex.com", "passenger_name": "Alex D", "passenger_nationality": "US", "passenger_phone": "12345567", "pre_tax_amount": 123.45, "scheduled_arrival_at": "2025-01-22T09:18:21Z", "scheduled_departure_at": "2025-01-22T08:18:21Z", "seat_number": "41A", "tax_amount": 234.56, "type": "INTERNATIONAL" } ], "order": { "cancellable": true, "created_at": "2025-01-22T07:18:21Z", "prepayment_model": "FULL" }, "trains": [ { "arrival_city": "Munich", "carrier": "Eurostar", "class_of_service": "first", "departure_city": "Munich", "insurances": [], "passenger_identifier": "ABcdEf123", "passenger_name": "John Doe", "passenger_title": "mr", "scheduled_arrival_at": "2025-01-22T08:30:00Z", "scheduled_departure_at": "2025-01-22T08:30:00Z" } ] } }, "amount": 100, "cancellation_reason": "Order cancelled", "cancelled_at": "2019-09-18T03:11:00+00:00", "captured_amount": 100, "client_secret": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NTk0OTM1NzUsImV4cCI6MTY1OTQ5NzE3NSwidHlwZSI6ImNsaWVudC1zZWNyZXQiLCJwYWRjIjoiU0ciLCJhY2NvdW50X2lkIjoiMGFjZTdkY2EtMzUzOC00NGUwLWI2OGEtYjQwYjY1MWIzMDE5IiwiaW50ZW50X2lkIjoiaW50X3Nnc3RiOXRic2djOG90bndlMGoiLCJidXNpbmVzc19uYW1lIjoiV2lzaGNvbSBTaGFuZ2hhaSJ9.rqKdwFjF4ba8h2hsbppBxkmAhCcPbSdl_YhC7J_i8so", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "conversion_quote_id": "cvq_hkpd5k6pgfub1fyurc86", "created_at": "2019-09-18T03:11:00+00:00", "currency": "USD", "customer": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "business_name": "Abc Trading Limited", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "merchant_customer_id": "", "phone_number": "13800000000" }, "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "descriptor": "Airwallex - T-shirt", "funds_split_data": [ { "amount": 12.3, "destination": "acct_s23lj4h1" } ], "id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "invoice_id": "", "latest_payment_attempt": { "acquirer_reference_number": "9.328788974770498e+22", "amount": 100.1, "authentication_data": { "authentication_type": "passkey", "avs_result": "pass", "cvc_result": "pass", "ds_data": { "cavv": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=", "challenge_cancellation_reason": "time out", "eci": "05", "enrolled": "Y", "frictionless": "Y", "liability_shift_indicator": "Y", "pa_res_status": "Y", "version": "2.1.0", "xid": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=" }, "fraud_data": { "action": "ACCEPT", "post_authorization_check": { "action": "ACCEPT", "risk_factors": [ { "description": "The transaction URL does not match the merchant's URL." } ], "score": "-1" }, "risk_factors": [ { "description": "The transaction URL does not match the merchant's URL." } ], "score": "-1" }, "passkey_setup_status": "SETUP_COMPLETED" }, "authorization_code": "525674", "captured_amount": 100.1, "created_at": "2019-09-18T03:11:00+00:00", "currency": "", "dcc_data": { "amount": 686.76, "currency": "USD" }, "failure_code": "authentication_failed", "failure_details": { "code": "", "details": {}, "message": "", "trace_id": "" }, "id": "att_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "merchant_advice_code": "01", "merchant_order_id": "", "payment_consent_id": "", "payment_intent_id": "", "payment_method": { "ach_direct_debit": { "aba_routing_number": "123456789", "account_number": "1234567890", "business_account": false, "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "airwallex_pay": { "payer_name": "John Doe" }, "alfamart": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "alipaycn": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "alipayhk": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "applepay": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "lifecycle_id": "", "payment_data_type": "encrypted_payment_token", "tokenized_card": { "authentication_method": { "emv": { "emv_data": "", "encrypted_pin_data": "" }, "three_ds": { "eci_indicator": "", "online_payment_cryptogram": "" }, "type": "" }, "bin": "411111", "brand": "visa", "device_manufacturer_identifier": "050110030222", "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "type": "debit" } }, "atome": { "shopper_phone": "+6587654321" }, "bacs_direct_debit": { "account_number": "12345678", "address": { "country_code": "GB", "line1": "777 Casino Drive", "line2": "Apartment 123", "postcode": "A11 B12", "state": "CA", "town": "LONDON" }, "bank_name": "revolut", "business_account": false, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe", "sort_code": "123456" }, "bancontact": { "shopper_name": "Alex Wang" }, "bank_transfer": { "bank_name": "bangkok", "country_code": "ID", "expires_at": "2025-09-18T12:30:00Z", "ga_mode": "PAYER_GA", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "becs_direct_debit": { "account_number": "1234567890", "bsb_number": "123456", "business_account": false, "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "bitpay": { "country_code": "US", "shopper_name": "Alex Wang" }, "blik": { "shopper_name": "Alex Wang" }, "boost": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "card": { "additional_info": { "merchant_verification_value": "A52BD7", "token_requestor_id": "50272768100" }, "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "bin": "411111", "brand": "visa", "card_type": "credit", "card_updater_info": { "expiry_updated": false, "number_updated": false }, "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "korean_card": { "business_number": "97XXXXXX11", "date_of_birth": "890630", "password_first2": "00" }, "last4": "1111", "lifecycle_id": "", "name": "John Doe", "number_type": "PAN" }, "card_present": { "aid": "", "bin": "411111", "brand": "visa", "card_sequence_number": "", "card_type": "credit", "cardholder_verification_method": "online_pin", "contactless_card_form_factor": "", "emv_tags": "", "expiry_month": "12", "expiry_year": "2030", "fallback": false, "fallback_reason": "", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "pan_entry_mode": "contactless_chip", "receipt": { "retrieval_reference_number": "", "system_trace_audit_number": "", "terminal_verification_results": "" }, "terminal_info": { "mobile_device": false, "pin_entry_capability": "supported", "support_single_tap_with_pin": false, "supported_pan_entry_modes": [], "terminal_identifier": "123", "terminal_type": "attended_pos", "use_embedded_reader": false } }, "created_at": "2019-09-18T03:11:00+00:00", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "dana": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "doku_ewallet": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "dragonpay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "duit_now": { "shopper_name": "Alex Wang" }, "eft_direct_debit": { "account_number": "1234567890", "business_account": false, "institution_number": "123", "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe", "transit_number": "12345-678" }, "eps": { "shopper_name": "Alex Wang" }, "esun": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "family_mart": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "fps": { "flow": "qrcode" }, "fpx": { "bank_name": "affin", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "gcash": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "go_pay": { "shopper_name": "Alex Wang" }, "googlepay": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "lifecycle_id": "", "payment_data_type": "encrypted_payment_token", "tokenized_card": { "authentication_method": { "emv": { "emv_data": "", "encrypted_pin_data": "" }, "three_ds": { "eci_indicator": "", "online_payment_cryptogram": "" }, "type": "" }, "bin": "411111", "brand": "visa", "device_manufacturer_identifier": "050110030222", "expiry_month": "12", "expiry_year": "2030", "fingerprint": "", "is_commercial": false, "issuer_country_code": "US", "issuer_name": "", "last4": "1111", "name": "John Doe", "type": "debit" } }, "grabpay": { "shopper_name": "Alex Wang" }, "hi_life": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "id": "mtd_unun8upp2g4yc1lzax4", "ideal": { "bank_name": "rabobank", "shopper_name": "Alex Wang" }, "indomaret": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "jenius_pay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "kakaopay": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "klarna": { "billing": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "date_of_birth": "2011-10-23", "email": "john.doe@airwallex.com", "first_name": "John", "last_name": "Doe", "phone_number": "13800000000" }, "country_code": "US", "language": "en" }, "konbini": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "04501582125" }, "linkaja": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "maxima": { "shopper_name": "Alex Wang" }, "metadata": { "id": "1" }, "multibanco": { "shopper_name": "Alex Wang" }, "mybank": { "shopper_name": "Alex Wang" }, "narvesen": { "shopper_name": "Alex Wang" }, "online_banking": { "bank_name": "krungsri_bank", "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "ovo": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "p24": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "pay_now": { "channel": "pos", "shopper_name": "Alex Wang" }, "paybybankapp": { "shopper_name": "Alex Wang" }, "payeasy": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "04501582125" }, "paypal": { "country_code": "US", "shopper_name": "Alex Wang" }, "paypost": { "shopper_name": "Alex Wang" }, "paysafecard": { "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "paysafecash": { "country_code": "US", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "paysera": { "bank_name": "as_citadele_banka", "country_code": "US", "shopper_name": "Alex Wang" }, "payto": { "bsb": { "account_name": "John Doe", "account_number": "123456789", "bsb_number": "123456" }, "pay_id": { "australian_business_number": "12345678901", "organisation_id": "payid:airwallex.com/airwallex", "owner_email": "john.doe@airwallex.com", "phone_number": "+61 411111111" } }, "payu": { "shopper_name": "Alex Wang" }, "perlas_terminals": { "shopper_name": "Alex Wang" }, "prompt_pay": { "shopper_name": "Alex Wang" }, "rabbit_line_pay": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "satispay": { "country_code": "US", "shopper_name": "Alex Wang" }, "sepa_direct_debit": { "address": { "country_code": "DE", "postcode": "36199", "street": "456 White Finch St.", "town": "Rotenburg an der Fulda" }, "bank_name": "revolut", "business_account": false, "country_code": "DE", "iban": "DE1234567890234", "micro_debit": { "status": "PENDING" }, "micro_deposit": { "status": "PENDING" }, "owner_email": "john.doe@gmail.com", "owner_name": "John Doe" }, "seven_eleven": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "shopee_pay": { "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "045015821254" }, "skrill": { "country_code": "MY", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "status": "CREATED", "tabby": { "language": "ar", "shopper_email": "alex.wang@airwallex.com", "shopper_name": "Alex Wang", "shopper_phone": "+971500000001" }, "tng": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "truemoney": { "flow": "qrcode", "os_type": "android", "shopper_login_id": "shopper.airwallex@hotmail.com", "user_id": "2102209000001455417D5" }, "trustly": { "country_code": "NL", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "type": "card", "updated_at": "2019-09-18T03:11:00+00:00", "verkkopankki": { "bank_name": "aktia", "shopper_email": "somebody@airwallex.com", "shopper_name": "Alex Wang" }, "wechatpay": { "channel": "pos", "flow": "qrcode" }, "zip": { "shopper_name": "Alex Wang" } }, "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true } }, "payment_method_transaction_id": "", "provider_original_response_code": "00", "provider_transaction_id": "", "refunded_amount": 100.1, "settle_via": "", "status": "AUTHORIZED", "terminal_id": "ter_pdw6jk9h6ou84c89o", "updated_at": "2019-09-18T03:11:00+00:00" }, "merchant_order_id": "cc9bfc13-ba30-483b-a62c-ee925fc9bfea", "metadata": { "id": "1" }, "next_action": { "content_type": "POST", "data": {}, "dcc_data": { "amount": 144.72, "client_rate": 0.691, "currency": "AUD", "currency_pair": "AUDUSD", "rate_expiry": "2020-06-09T06:11:32+00:00", "rate_timestamp": "2020-06-09T06:01:32+00:00" }, "fallback_url": "https://www.airwallex.com", "method": "POST", "package_name": "id.dana", "qrcode": "weixin://wxpay/bizpayurl?pr=5xtGdR4", "type": "redirect", "url": "https://www.airwallex.com" }, "order": { "discount": { "coupon_code": "CD3243012" }, "foreign_retailer_amount": 0, "products": [ { "category": "Apparel and accessories", "code": "3414314111", "desc": "IPHONE 7", "effective_end_at": "2020-12-31T23:59:59Z", "effective_start_at": "2020-01-01T00:00:00Z", "image_url": "https://example.airwallex.com/product/12345.png", "name": "IPHONE7", "quantity": 5, "sku": "100004", "type": "physical", "unit_price": 100.01, "url": "https://example.airwallex.com/product/12345" } ], "sellers": [ { "additional_info": { "address_updated_at": "2023-01-01T00:00:00Z", "email_updated_at": "2023-01-01T00:00:00Z", "password_updated_at": "2023-01-01T00:00:00Z", "products_updated_at": "2023-01-01T00:00:00Z" }, "business_info": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "email": "john.doe@airwallex.com", "phone_number": "13800000000", "rating": 4.5, "registration_date": "2019-09-18" } } ], "shipping": { "address": { "city": "Seattle", "country_code": "US", "postcode": "98104", "state": "Washington", "street": "412 5th Avenue" }, "fee_amount": 1.5, "first_name": "John", "last_name": "Doe", "phone_number": "13800000000", "shipping_company": "dhl US", "shipping_delayed_at": "2019-09-18T12:30:00Z", "shipping_method": "sameday", "tracking_number": "199473619321", "tracking_url": "https://www.example.com" }, "surcharge": { "amount": 10, "percent": 5 }, "tip": { "amount": 10 }, "type": "physical_goods" }, "payment_consent": { "merchant_trigger_reason": "unscheduled", "next_triggered_by": "merchant", "terms_of_use": { "billing_cycle_charge_day": 5, "end_date": "2025-09-22", "first_payment_amount": 105, "fixed_payment_amount": 100, "max_payment_amount": 500, "min_payment_amount": 500, "payment_amount_type": "FIXED", "payment_currency": "AUD", "payment_schedule": { "period": 1, "period_unit": "MONTH" }, "start_date": "2024-09-22", "total_billing_cycles": 12 } }, "payment_consent_id": "cst_u79lnfufjxxfdc0", "payment_link_id": "ee939540-3203-4a2c-9172-89a566485dd9", "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true, "card_input_via": "", "merchant_trigger_reason": "reauthorization", "three_ds_action": "FORCE_3DS" }, "wechatpay": { "enable_funds_split": false } }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9", "return_url": "", "risk_control_options": { "skip_risk_processing": false, "tra_applicable": false }, "status": "SUCCEEDED", "triggered_by": "merchant", "updated_at": "2019-09-18T03:11:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents": { "get": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "3|List all Payment Intents", "description": "List all Payment Intents.", "operationId": "listPaymentIntents", "parameters": [ { "name": "connected_account_id", "in": "query", "description": "Airwallex assigned account identifier of the connected entity. Only applicable for platforms.", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Payment Intent currency.", "required": false, "schema": { "type": "string", "default": "USD" } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" }, "examples": { "default": { "value": "2025-01-01T06:57:10+08:00" } } }, { "name": "merchant_order_id", "in": "query", "description": "Merchant Order unique identifier.", "required": false, "schema": { "type": "string" }, "examples": { "default": { "value": "D202503210001" } } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Payment Intents to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "payment_consent_id", "in": "query", "description": "Payment Consent unique identifier.", "required": false, "schema": { "type": "string", "default": "cst_u79lnfufjxxfdc0" } }, { "name": "status", "in": "query", "description": "Payment Intent status.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" }, "examples": { "default": { "value": "2025-01-31T17:57:10+08:00" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentIntentList" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj" }, "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "1cd461eb-cfa5-4215-a59d-fb1e2c3b2cd0", "amount": 100, "currency": "USD", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "status": "REQUIRES_PAYMENT_METHOD", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_intents", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "from_created_at": "2025-01-01T06:57:10+08:00", "merchant_order_id": "D202503210001", "page_num": 0, "page_size": 10, "to_created_at": "2025-01-31T17:57:10+08:00" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj" }, "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "1cd461eb-cfa5-4215-a59d-fb1e2c3b2cd0", "amount": 100, "currency": "USD", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "status": "REQUIRES_PAYMENT_METHOD", "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "2|Retrieve a Payment Intent", "description": "Retrieve a Payment Intent by unique identifier.", "operationId": "retrievePaymentIntent", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "0955e7df-0422-4766-b3b1-5aec5a0d6314", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "0955e7df-0422-4766-b3b1-5aec5a0d6314", "amount": 100, "currency": "USD", "status": "SUCCEEDED", "merchant_order_id": "D202503210001", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00", "latest_payment_attempt": { "id": "att_hkpdskz7vg1xc7uscdj", "amount": 100, "currency": "USD", "payment_method": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" } }, "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "status": "AUTHORIZED", "payment_method_transaction_id": "1234567890", "provider_original_response_code": "00", "authorization_code": "123456", "captured_amount": 0, "created_at": "2025-01-31T07:02:15+00:00", "updated_at": "2025-01-31T07:02:15+00:00", "settle_via": "airwallex", "authentication_data": { "ds_data": {}, "fraud_data": { "action": "ACCEPT", "score": "85", "risk_factors": [] }, "avs_result": "pass", "cvc_result": "pass" } } } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_intents/{id}/update": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "summary": "4|Update a Payment Intent", "description": "Update properties on a Payment Intent. \n \nSome 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 Payment Intent, you might need to confirm the Payment Intent again. For example, updating the `currency` and `amount` in `REQUIRES_CUSTOMER_ACTION` status always requires you to confirm the Payment Intent again. \n \nThe update behavior follows these principles: \n1\\. Omitted fields in the request payload will be ignored and have no impact on the existing value. \n2\\. Provided fields in the request payload will be merged to the existing data(except for array fields, it will be a full replacement). \n3\\. Conditional fields can be nullified by passing a null value or empty value(for string type only).", "operationId": "updatePaymentIntent", "parameters": [ { "name": "id", "in": "path", "description": "Payment Intent unique identifier.", "required": true, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" }, "examples": { "default": { "value": "int_hkpdskz7vg1xc7uscdj" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "additional_info": { "type": "object", "description": "Additional info for the transaction.", "properties": { "account_funding_data": { "type": "object", "required": [ "type" ], "description": "Additional info for account funding transactions to ensure compliance with card networks.", "properties": { "recipient": { "type": "object", "description": "Details of the recipient for this account funding transaction.", "properties": { "account_number": { "type": "string", "description": "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": { "type": "object", "required": [ "country_code" ], "description": "Address of the recipient.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "line1": { "type": "string", "description": "Address line1." }, "line2": { "type": "string", "description": "Address line2." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address." } } }, "first_name": { "type": "string", "description": "First name of the recipient." }, "last_name": { "type": "string", "description": "Last name of the recipient." }, "middle_name": { "type": "string", "description": "Middle name of the recipient." } } }, "sender": { "type": "object", "description": "Details of the sender for this account funding transaction.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the sender.", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "line1": { "type": "string", "description": "Address line1." }, "line2": { "type": "string", "description": "Address line2." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address." } } }, "date_of_birth": { "type": "string", "description": "The sender’s date of birth. Format: YYYY-MM-DD (e.g., \"1989-07-15\")." }, "first_name": { "type": "string", "description": "First name of the sender." }, "last_name": { "type": "string", "description": "Last name of the sender." }, "middle_name": { "type": "string", "description": "Middle name of the sender." } } }, "transfer_between_own_accounts": { "type": "boolean", "description": "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." }, "type": { "type": "string", "description": "Account funding transaction type. Possible values: \n\n- **ACCOUNT_TO_ACCOUNT_TRANSFER**: An account-to-account transfer, either within the same financial institution or to a different one.\n- **STORED_VALUE_DIGITAL_WALLET_TRANSFER**: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.\n- **STAGED_DIGITAL_WALLET_TRANSFER**: Funding a Staged Digital Wallet before the cardholder makes a purchase.\n- **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).\n- **LIQUID_ASSET_PURCHASE**: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).\n" } } }, "customer_activity_data": { "type": "object", "description": "(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.", "properties": { "account_type": { "type": "string", "description": "Customer account type. One of `GUEST`, `PRIVATE`, `BUSINESS`, `VIP`, `MERCHANT_OPERATED`, `TRIAL`, `MERCHANT_EMPLOYEE`, `PREMIUM_PAID`, `SMALL_BUSINESS`, `AGENT`." }, "first_successful_order_date": { "type": "string", "description": "Date at which the customer completes the first order on the merchant's site." }, "last_login_ip_address": { "type": "string", "description": "The public IP address used by the customer in the last login." }, "last_modified_at": { "type": "string", "description": "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`)." }, "linked_social_networks": { "type": "array", "description": "Social network data related to the customer.", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address on the social network." }, "name": { "type": "string", "description": "The social network used by the customer. Can be one of: `FACEBOOK`, `GOOGLE`, `TWITTER`, `REDDIT`, `PINTEREST`, `WECHAT`, `QQ`, `TWITCH`, `APPLE`, `DRIBBBLE`, `GITHUB`, `LINKEDIN`, `MAKER_STUDIOS`, `STACK_EXCHANGE`, `VIMEO`, `STEAM`, `OTHER`, `KAKAO`, `NAVER`, `GRAB`, `JKOPAY`, `LINE`, `OTHER`." }, "profile_id": { "type": "string", "description": "The customer's profile unique identifier on the social network." } } } }, "purchase_summaries": { "type": "array", "description": "The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis.", "items": { "type": "object", "required": [ "payment_method_type" ], "properties": { "currency": { "type": "string", "description": "The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "first_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their first purchase in the merchant's system with the specified payment method type." }, "last_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their last purchase in the merchant's system with the specified payment method type." }, "payment_method_type": { "type": "string", "description": "Payment method type, one of `affirm`, `afterpay`, `atome`, `klarna`, and `other`." }, "successful_purchase_amount": { "type": "number", "description": "Total volume of successful purchases. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "successful_purchase_count": { "type": "integer", "format": "int32", "description": "Total number of successful purchases." } } } }, "registered_via_social_media": { "type": "boolean", "description": "Whether the customer registers through social media. Default to `false`." }, "registration_date": { "type": "string", "description": "Date at which the customer registers on the merchant's site." }, "registration_ip_address": { "type": "string", "description": "The public IP address used by the customer when registering on the merchant's site." } } }, "enhanced_scheme_data": { "type": "object", "description": "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.", "properties": { "customer": { "type": "object", "description": "Details of the customer making a payment for this Payment Intent.", "properties": { "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "reference": { "type": "string", "description": "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." } } }, "customer_tax_identifier": { "type": "string", "description": "Tax identifier of the customer. Maximum of 13 characters." }, "duty_amount": { "type": "number", "description": "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": { "type": "string", "description": "Invoice reference number. Maximum of 17 characters." }, "local_tax_amount": { "type": "number", "description": "The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "merchant_tax_identifier": { "type": "string", "description": "Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters." }, "national_tax_amount": { "type": "number", "description": "The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "products": { "type": "array", "description": "Product list.", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 12 characters." }, "commodity_code": { "type": "string", "description": "The [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) for the product. Maximum of 12 characters." }, "description": { "type": "string", "description": "Product description. Maximum of 26 characters." }, "discount_amount": { "type": "number", "description": "The discount amount for the product. This amount must be expressed in the original currency of the transaction." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "tax_percent": { "type": "number", "description": "The tax rate percentage for the product. Should be less than 100, up to 2 decimal places." }, "total_amount": { "type": "number", "description": "The total amount for the product. This amount must be expressed in the original currency of the transaction." }, "total_tax_amount": { "type": "number", "description": "The total amount of tax for the product. This amount must be expressed in the original currency of the transaction." }, "unit": { "type": "string", "description": "The unit of measure code used for the product. Maximum of 12 characters." }, "unit_price": { "type": "number", "description": "Product unit price. This amount must be expressed in the original currency of the transaction." } } } }, "shipping": { "type": "object", "description": "Shipping information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Shipping address.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "date": { "type": "string", "description": "The date the goods were shipped to the destination, in YYYY-MM-DD format." }, "fee_amount": { "type": "number", "description": "Shipping fee amount. This amount must be expressed in the same currency as the transaction amount." }, "from_postcode": { "type": "string", "description": "The postcode of the location the goods are being shipped from. Maximum of 10 characters." } } }, "summary_commodity_code": { "type": "string", "description": "The first 2,4 or 6 digits of [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) 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." }, "total_tax_amount": { "type": "number", "description": "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." }, "vat_invoice_reference": { "type": "string", "description": "Value added tax invoice reference number. Maximum of 15 characters." } } } } }, "amount": { "type": "number", "description": "Payment amount. This is the order amount you would like to charge your customer. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "conversion_quote_id": { "type": "string", "description": "The unique identifier of the conversion quote to be applied to the intent." }, "currency": { "type": "string", "description": "Payment currency. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "customer": { "type": "object", "description": "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.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the customer.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "business_name": { "type": "string", "description": "Business name of the customer." }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of the customer in merchant's system. Maximum length is 64." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "customer_id": { "type": "string", "description": "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": { "type": "string", "description": "Descriptor that will display to the customer. Maximum length is 32." }, "merchant_order_id": { "type": "string", "description": "The order unique identifier created in merchant's order system that corresponds to this Payment Intent. Maximum length is 64." }, "merchant_website_url": { "type": "string", "description": "URL of the merchant's website where the customer is completing the transaction." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Intent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "order": { "type": "object", "description": "Purchase order related to the Payment Intent.", "properties": { "discount": { "type": "object", "description": "Discount used by the customer.", "properties": { "coupon_code": { "type": "string", "description": "Coupon code used." } } }, "foreign_retailer_amount": { "type": "number", "description": "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." }, "products": { "type": "array", "description": "Product list.", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories." }, "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 128 characters." }, "desc": { "type": "string", "description": "Product description. Maximum of 500 characters." }, "effective_end_at": { "type": "string", "description": "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`)." }, "effective_start_at": { "type": "string", "description": "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`)." }, "image_url": { "type": "string", "description": "The preview image url for this product, which is usually displayed as thumbnail in the order details." }, "name": { "type": "string", "description": "Name of the product. Maximum of 255 characters." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "seller": { "type": "object", "description": "Seller info of the purchase order.", "properties": { "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system." } } }, "sku": { "type": "string", "description": "Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters." }, "type": { "type": "string", "description": "Type of product, such as `physical_good`, `intangible_good`, or `service`. Maximum of 128 characters." }, "unit_price": { "type": "number", "description": "Product unit price." }, "url": { "type": "string", "description": "The url that links to the product page at merchant site." } } } }, "sellers": { "type": "array", "description": "Seller list.", "items": { "type": "object", "properties": { "additional_info": { "type": "object", "description": "The additional information of the seller in the merchant's system for risk analysis.", "properties": { "address_updated_at": { "type": "string", "description": "The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "email_updated_at": { "type": "string", "description": "The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "password_updated_at": { "type": "string", "description": "The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "products_updated_at": { "type": "string", "description": "The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "sales_summary": { "type": "object", "description": "The sales summary of this seller during the last period.", "properties": { "currency": { "type": "string", "description": "The currency of sales amount." }, "period": { "type": "string", "description": "The period of this sales summary. Default to 12M (last 12 months)." }, "sales_amount": { "type": "number", "description": "The volume of sales completed by the seller in the last period." }, "sales_count": { "type": "integer", "format": "int32", "description": "The number of sales completed by the seller in the last period." } } } } }, "business_info": { "type": "object", "description": "The business information of the seller in the merchant's system for risk analysis.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Address of the seller.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the seller." }, "phone_number": { "type": "string", "description": "Phone number of the seller." }, "rating": { "type": "number", "description": "The latest customer rating (out of 10) for this seller." }, "registration_date": { "type": "string", "description": "The date on which the seller registered in the merchant's system." } } }, "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system. Maximum length is 64." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system. Maximum length is 100." } } } }, "shipping": { "type": "object", "description": "Shipping information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "Shipping address.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "fee_amount": { "type": "number", "description": "Shipping fee amount. The currency is the same as transaction currency." }, "first_name": { "type": "string", "description": "First name of the recipient. Maximum of 128 characters." }, "last_name": { "type": "string", "description": "Last name of the recipient. Maximum of 128 characters." }, "phone_number": { "type": "string", "description": "Phone number of the recipient. Maximum of 50 characters." }, "shipping_company": { "type": "string", "description": "Name of the shipping company. Maximum of 100 characters." }, "shipping_delayed_at": { "type": "string", "description": "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": { "type": "string", "description": "Shipping method for the product. Maximum of 128 characters." }, "tracking_number": { "type": "string", "description": "Tracking number of the shipment. Maximum of 100 characters." }, "tracking_url": { "type": "string", "description": "URL where the customer can track the shipment. Maximum of 1024 characters." } } }, "surcharge": { "type": "object", "description": "Surcharge Information.", "properties": { "amount": { "type": "number", "description": "The surcharge amount. This amount is included in the Payment Intent's total `amount`." } } }, "tip": { "type": "object", "description": "Tip information.", "properties": { "amount": { "type": "number", "description": "The tip amount. This amount is included in the total `amount`." } } }, "type": { "type": "string", "description": "Industry category of the order. Maximum of 128 characters." } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after payment authentication." } } }, "examples": { "default": { "value": { "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" } } } } } } }, "description": "Payment Intent update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentSingle" }, "examples": { "default": { "value": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "28f0a16f-4e97-4d77-a310-3cf7be2ba6ed", "amount": 100, "currency": "USD", "status": "REQUIRES_PAYMENT_METHOD", "merchant_order_id": "D202503210001", "order": { "shipping": { "shipping_company": "Shipping Company", "tracking_number": "1234567890", "tracking_url": "https://www.example.com/tracking?id=1234567890" } }, "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_intents/int_hkpdskz7vg1xc7uscdj/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "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" } } }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "int_hkpdskz7vg1xc7uscdj", "request_id": "28f0a16f-4e97-4d77-a310-3cf7be2ba6ed", "amount": 100, "currency": "USD", "status": "REQUIRES_PAYMENT_METHOD", "merchant_order_id": "D202503210001", "order": { "shipping": { "shipping_company": "Shipping Company", "tracking_number": "1234567890", "tracking_url": "https://www.example.com/tracking?id=1234567890" } }, "return_url": "https://www.airwallex.com", "descriptor": "Airwallex - Test Descriptor", "metadata": { "foo": "bar" }, "created_at": "2025-01-31T06:57:10+00:00", "updated_at": "2025-01-31T07:01:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/{id}/activate": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "6|Activate a Payment Link", "description": "Activates an inactive payment link.", "operationId": "paymentLinks_activate", "parameters": [ { "name": "id", "in": "path", "description": "Payment link unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "475dc845-bc7c-47eb-b2b0-52782b9d078d" }, "examples": { "default": { "value": "payment_link_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLink" }, "examples": { "default": { "value": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `configuration_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_links/payment_link_id/activate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:write", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/create": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "1|Create a Payment Link", "description": "Create a new payment link.", "operationId": "createPaymentLink", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reusable", "title" ], "properties": { "amount": { "type": "number", "description": "The payment amount. For Fixed pricing only." }, "collectable_shopper_info": { "type": "object", "description": "Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link.", "properties": { "billing_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their billing address." }, "message": { "type": "boolean", "description": "Defaults to `true`. This is an optional field for the shopper to leave a message with their payment." }, "phone_number": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their phone number." }, "reference": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input a reference." }, "shipping_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their shipping address." } } }, "connected_account_id": { "type": "string", "description": "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." }, "currency": { "type": "string", "description": "The payment currency. For Fixed pricing only." }, "customer_id": { "type": "string", "description": "The Customer who is paying for this Payment Link. Only applicable for links with `reusable` equals to `false`. This field is required if you want the payer to see the payment methods saved in the previous checkouts." }, "default_currency": { "type": "string", "description": "The default payment currency from the list of `supported_currencies`. The shopper can change the payment currency during checkout. For Flexible pricing only." }, "description": { "type": "string", "description": "The additional description text that appears under the title in the payment checkout page.", "minLength": 0, "maxLength": 500 }, "expires_at": { "type": "string", "format": "date-time", "description": "Payment link expiry timestamp in ISO 8601 format." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Link for storing additional information.", "additionalProperties": { "type": "string" } }, "reference": { "type": "string", "description": "A reference only visible to the merchant.", "minLength": 0, "maxLength": 200 }, "reusable": { "type": "boolean", "description": "Specifies whether the payment link can be used once or multiple times." }, "supported_currencies": { "type": "array", "description": "List of supported currencies the shopper may choose from. For Flexible pricing only.", "items": { "type": "string" } }, "ui_options": { "type": "object", "description": "UI configuration for the payment checkout page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this payment link, overriding the theme configured for its account. You can find the theme ID in the Airwallex web app under Settings > Themes." } } }, "title": { "type": "string", "description": "The title of the payment link that is displayed in the payment checkout page.", "minLength": 0, "maxLength": 200 } } }, "examples": { "default": { "value": { "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "connected_account_id": "acct_4lnVokTfP3ulKDlzLDJdjg", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00Z", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": false, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529" } } } } }, "description": "Request to create a new payment link.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLink" }, "examples": { "default": { "value": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `configuration_error`, `resource_not_found`(invalid `customer_id`)" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_links/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "connected_account_id": "acct_4lnVokTfP3ulKDlzLDJdjg", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00Z", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": false, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529" }, "response_body": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:write", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/{id}/deactivate": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "7|Deactivate a Payment Link", "description": "Deactivates an active payment link.", "operationId": "paymentLinks_deactivate", "parameters": [ { "name": "id", "in": "path", "description": "Payment link unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "475dc845-bc7c-47eb-b2b0-52782b9d078d" }, "examples": { "default": { "value": "payment_link_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLink" }, "examples": { "default": { "value": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_links/payment_link_id/deactivate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:write", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links": { "get": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "3|List all Payment Links", "description": "Retrieves a list of payment links that a merchant has created previously.", "operationId": "listPaymentLinks", "parameters": [ { "name": "active", "in": "query", "description": "The payment link's active status, either `true` or `false`.", "required": false, "schema": { "type": "boolean" } }, { "name": "from_created_at", "in": "query", "description": "Specifies start time (inclusive) in ISO 8601 for a range query by created timestamp.", "required": false, "schema": { "type": "string", "format": "date-time", "default": "2021-08-01T00:00:00Z" } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0, "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of payment links to be listed per page.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "reusable", "in": "query", "description": "Specifies whether the payment link can be used once or multiple times.", "required": false, "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Status of the payment link, one of `UNPAID` or `PAID`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "Specifies end time (exclusive) in ISO 8601 for a range query by created timestamp.", "required": false, "schema": { "type": "string", "format": "date-time", "default": "2021-08-17T11:00:00Z" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentLink" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_links", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "title": "Order #1529", "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:read", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/{id}/notify_shopper": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "5|Send a Payment Link", "description": "Send an email notification to shopper with a payment link.", "operationId": "notifyShopper", "parameters": [ { "name": "id", "in": "path", "description": "Payment link unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "475dc845-bc7c-47eb-b2b0-52782b9d078d" }, "examples": { "default": { "value": "payment_link_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shopper_email" ], "properties": { "shopper_email": { "type": "string", "description": "Shopper email address.", "minLength": 0, "maxLength": 100 } } }, "examples": { "default": { "value": { "shopper_email": "jane.miller@email.com" } } } } }, "description": "Request with the shopper email address and the payment link.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "default": { "value": "" } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `configuration_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_links/payment_link_id/notify_shopper", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "shopper_email": "jane.miller@email.com" }, "response_body": "" } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:write", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "2|Retrieve a Payment Link", "description": "Retrieve information about an existing payment link.", "operationId": "retrievePaymentLink", "parameters": [ { "name": "id", "in": "path", "description": "Payment link unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "475dc845-bc7c-47eb-b2b0-52782b9d078d" }, "examples": { "default": { "value": "payment_link_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLink" }, "examples": { "default": { "value": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_links/payment_link_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:read", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_links/{id}/update": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "summary": "4|Update a Payment Link", "description": "Update attributes of an existing payment link.", "operationId": "updatePaymentLink", "parameters": [ { "name": "id", "in": "path", "description": "Payment link unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "475dc845-bc7c-47eb-b2b0-52782b9d078d" }, "examples": { "default": { "value": "payment_link_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "description": "The payment amount. For Fixed pricing only." }, "collectable_shopper_info": { "type": "object", "description": "Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link.", "properties": { "billing_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their billing address." }, "message": { "type": "boolean", "description": "Defaults to `true`. This is an optional field for the shopper to leave a message with their payment." }, "phone_number": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their phone number." }, "reference": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input a reference." }, "shipping_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their shipping address." } } }, "currency": { "type": "string", "description": "The payment currency. For Fixed pricing only." }, "default_currency": { "type": "string", "description": "The default payment currency from the list of `supported_currencies`. The shopper can change the payment currency during checkout. For Flexible pricing only." }, "description": { "type": "string", "description": "The additional description text that appears under the title in the payment checkout page.", "minLength": 0, "maxLength": 500 }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Link for storing additional information.", "additionalProperties": { "type": "string" } }, "reference": { "type": "string", "description": "A reference only visible to the merchant.", "minLength": 0, "maxLength": 200 }, "supported_currencies": { "type": "array", "description": "List of supported currencies the shopper may choose from. For Flexible pricing only.", "items": { "type": "string" } }, "ui_options": { "type": "object", "description": "UI configuration for the payment checkout page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this payment link, overriding the theme configured for its account. You can find the theme ID in the Airwallex web app under Settings > Themes." } } }, "title": { "type": "string", "description": "The title of the payment link that is displayed in the payment checkout page.", "minLength": 0, "maxLength": 200 } } }, "examples": { "default": { "value": { "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "currency": "EUR", "default_currency": "EUR", "description": "shoes and dress.", "metadata": { "customer_id": "12345678" }, "reference": "1529", "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529" } } } } }, "description": "Request to update the payment link.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLink" }, "examples": { "default": { "value": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `configuration_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_links/payment_link_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "currency": "EUR", "default_currency": "EUR", "description": "shoes and dress.", "metadata": { "customer_id": "12345678" }, "reference": "1529", "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529" }, "response_body": { "active": true, "amount": 165.15, "collectable_shopper_info": { "billing_address": false, "message": true, "phone_number": false, "reference": false, "shipping_address": false }, "created_at": "2021-08-17T11:00:00+00:00", "currency": "EUR", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "default_currency": "EUR", "description": "shoes and dress.", "expires_at": "2021-11-04T16:00:00+00:00", "id": "475dc845-bc7c-47eb-b2b0-52782b9d078d", "latest_successful_payment_intent_id": "int_e65tkXCSzJrsMpTrzoFrjaau53", "metadata": { "customer_id": "12345678" }, "reference": "1529", "reusable": true, "status": "PAID", "successful_payment_intent_count": 1, "supported_currencies": [ "EUR", "AUD" ], "ui_options": { "theme_id": "tm_sgpdvff8whip0bfgzzt" }, "title": "Order #1529", "updated_at": "2021-08-17T11:05:00+00:00", "url": "https://pay.airwallex.com/hkdab0d955b5" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true }, { "scope": "payment_link:write", "group": "Payment Acceptance", "resource_name": "Payment Links", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_methods/create": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "summary": "1|Create a Payment Method", "description": "Create a Payment Method which can be referenced by Payment Consent. \n \nAlternatively you can directly provide entire payload of new Payment Method when [verifying](/docs/api/payments/payment_consents/verify) the Payment Consent, and then a Payment Method will be generated for you automatically during the process, which can be re-used for other Payment Consent later.", "operationId": "createPaymentMethod", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customer_id", "request_id", "type" ], "properties": { "applepay": { "type": "object", "description": "Apple pay information. This must be provided if `type` is set to `applepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "Payment data from Apple Pay Payment Token." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "card": { "type": "object", "description": "Card information. This must be provided if `type` is set to `card`.", "properties": { "additional_info": { "type": "object", "description": "Additional information of external network token requestor. Should be provided when number_type is `EXTERNAL_NETWORK_TOKEN`.", "properties": { "merchant_verification_value": { "type": "string", "description": "Merchant Verification Value (Provided by VISA during onboarding)\nor\nMasterCard Assigned ID (Provided by MasterCard during onboarding)." }, "token_requestor_id": { "type": "string", "description": "Token requestor unique identifier (Provided by card schemes during onboarding)." } } }, "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Card holder name. Maximum length is 128." }, "number": { "type": "string", "description": "Card number." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`. Default: `PAN`." } } }, "customer_id": { "type": "string", "description": "The Customer this Payment Method belongs to. This Payment Method is automatically added to the Customer as one of the available Payment Methods. See [Customers API](/docs/api/payments/customers) for further details." }, "googlepay": { "type": "object", "description": "Google pay information. This must be provided if `type` is set to `googlepay`.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "encrypted_payment_token": { "type": "string", "description": "A UTF-8 encoded, serialized JSON object with the keys specified." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "type": "object", "required": [ "expiry_month", "expiry_year", "number" ], "description": "Payment data with the tokenized card details.", "properties": { "authentication_method": { "type": "object", "required": [ "type" ], "description": "Authentication method.", "properties": { "emv": { "type": "object", "required": [ "emv_data" ], "description": "EMV data.", "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } } }, "three_ds": { "type": "object", "required": [ "online_payment_cryptogram" ], "description": "3D-Secure authentication data.", "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } } }, "type": { "type": "string", "description": "The authentication method type. One of `emv` or `three_ds`." } } }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "name": { "type": "string", "description": "Cardholder name." }, "number": { "type": "string", "description": "Card number." } } } } }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." }, "type": { "type": "string", "description": "Type of the Payment Method.", "enum": [ "card", "applepay", "googlepay" ] } } }, "examples": { "default": { "value": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "number": "4035501000000008", "name": "John Doe", "number_type": "PAN", "billing": { "email": "john.doe@example.com", "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" } } }, "customer_id": "cus_hkpd1dsaklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e" } } } } }, "description": "Payment Method creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "examples": { "default": { "value": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `resource_not_found`(invalid `customer_id`)" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_methods/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "number": "4035501000000008", "name": "John Doe", "number_type": "PAN", "billing": { "email": "john.doe@example.com", "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" } } }, "customer_id": "cus_hkpd1dsaklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_methods/{id}/disable": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "summary": "5|Disable a Payment Method", "description": "Disable Payment Method by unique identifier. The Payment Method status would become `DISABLED`.", "operationId": "paymentMethods_disable", "parameters": [ { "name": "id", "in": "path", "description": "Payment Method unique identifier.", "required": true, "schema": { "type": "string", "default": "mtd_unun8upp2g4yc1lzax4" }, "examples": { "default": { "value": "att_hkpd12a3456hi7" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." } } }, "examples": { "default": { "value": { "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7" } } } } }, "description": "Payment Method disable request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "examples": { "default": { "value": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "DISABLED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_methods/att_hkpd12a3456hi7/disable", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "ebd6f3f2-d489-4c2c-9548-8d2a742dc4f7", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "DISABLED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_methods": { "get": { "tags": [ "Payment Acceptance > Payment Methods" ], "summary": "3|List all Payment Methods", "description": "List all Payment Methods.", "operationId": "listPaymentMethods", "parameters": [ { "name": "customer_id", "in": "query", "description": "Customer unique identifier of the Payment Methods.", "required": false, "schema": { "type": "string", "default": "cus_2019091803110002010199020012_0378811980855892" }, "examples": { "default": { "value": "cus_hkpd1dsaklad5sa" } } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-03-01T03:52:34+00:00" } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Payment Methods to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "status", "in": "query", "description": "Payment Method status. One of `CREATED`, `DISABLED`.", "required": false, "schema": { "type": "string", "default": "CREATED" } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" } }, { "name": "type", "in": "query", "description": "Payment Method type, can be `card`, `ach_direct_debit`.", "required": false, "schema": { "type": "string", "default": "card" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_methods", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "customer_id": "cus_hkpd1dsaklad5sa", "page_num": 0, "page_size": 10 }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_methods/{id}": { "get": { "tags": [ "Payment Acceptance > Payment Methods" ], "summary": "2|Retrieve a Payment Method", "description": "Retrieve Payment Method by unique identifier.", "operationId": "retrievePaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Payment Method unique identifier.", "required": true, "schema": { "type": "string", "default": "mtd_unun8upp2g4yc1lzax4" }, "examples": { "default": { "value": "att_hkpd12a3456hi7" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "examples": { "default": { "value": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/payment_methods/att_hkpd12a3456hi7", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2030", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/payment_methods/{id}/update": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "summary": "4|Update a Payment Method", "description": "Depending on the `payment_method_type`, you may update some of the details contained within.", "operationId": "updatePaymentMethod", "parameters": [ { "name": "id", "in": "path", "description": "Payment Method to update.", "required": true, "schema": { "type": "string", "default": "mtd_unun8upp2g4yc1lzax4" }, "examples": { "default": { "value": "mtd_hkpd1dsjklad5sa" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "card", "request_id" ], "properties": { "card": { "type": "object", "description": "Card information. This must be provided.", "properties": { "billing": { "type": "object", "description": "Billing information.", "properties": { "address": { "type": "object", "required": [ "country_code" ], "description": "The billing address as it appears on the credit card issuer’s records.", "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } } }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer. Maximum length is 128." }, "last_name": { "type": "string", "description": "Last name of the customer. Maximum length is 128." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } } }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." } } }, "examples": { "default": { "value": { "card": { "expiry_month": "03", "expiry_year": "2035", "billing": { "email": "john.doe@example.com", "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" } } }, "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e" } } } } }, "description": "Payment Method update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "examples": { "default": { "value": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "ff59b8e3-ea26-4d69-8a2c-a072c02e5235", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2035", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } } } } }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/payment_methods/mtd_hkpd1dsjklad5sa/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "card": { "expiry_month": "03", "expiry_year": "2035", "billing": { "email": "john.doe@example.com", "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" } } }, "request_id": "9dbaecc9-24da-41e8-9d48-7f4ef4d1057e" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "mtd_hkpd1dsjklad5sa", "request_id": "ff59b8e3-ea26-4d69-8a2c-a072c02e5235", "customer_id": "cus_hkpd1dsaklad5sa", "type": "card", "card": { "expiry_month": "03", "expiry_year": "2035", "name": "John Doe", "bin": "403550", "last4": "0008", "brand": "visa", "issuer_country_code": "US", "card_type": "CREDIT", "fingerprint": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "billing": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1 1234567890", "address": { "country_code": "US", "state": "CA", "city": "San Francisco", "street": "1460 Mission St.#02W101", "postcode": "94103" } }, "issuer_name": "JPMorgan Chase", "is_commercial": false, "number_type": "PAN" }, "status": "CREATED", "created_at": "2023-10-01T12:00:00+00:00", "updated_at": "2023-10-01T12:00:00+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/reference/bin/lookup": { "get": { "tags": [ "Payment Acceptance > Reference Data" ], "summary": "1|Retrieve the BIN Info", "description": "Retrieve the BIN info using the PAN passed via header param called `x-pan`.", "operationId": "lookupBin", "x-oboSupported": false, "parameters": [ { "name": "x-pan", "in": "header", "description": "pan.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "4111111111111111" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssuerAccountRangeForMerchant" } }, "examples": { "default": { "value": [ { "card_brand": "visa", "card_type": "credit", "commercial_card": false, "issuer_country_code": "US", "issuer_name": "An Issuer Name", "product_code": "G", "product_description": "Visa Business", "product_subtype_code": "MS", "product_subtype_description": "Multicurrency Solution" } ] } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/reference/bin/lookup", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json", "x-pan": "4111111111111111" }, "status_code": 200, "reason_phrase": "OK", "response_body": [ { "card_brand": "visa", "card_type": "credit", "commercial_card": false, "issuer_country_code": "US", "issuer_name": "An Issuer Name", "product_code": "G", "product_description": "Visa Business", "product_subtype_code": "MS", "product_subtype_description": "Multicurrency Solution" } ] } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/refunds/create": { "post": { "tags": [ "Payment Acceptance > Refunds" ], "summary": "1|Create a Refund", "description": "Create a Refund against a Payment Intent/Payment Attempt.", "operationId": "createRefund", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "amount": { "type": "number", "description": "Amount of the Refund. If not specified, it will be same as the remaining amount that has been captured but not yet refunded. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Refund. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "payment_attempt_id": { "type": "string", "description": "Payment Attempt unique identifier against which this Refund is created. Either this or the `payment_intent_id` must be provided." }, "payment_intent_id": { "type": "string", "description": "Payment Intent unique identifier against which this Refund is created. Either this or the `payment_attempt_id` must be provided." }, "reason": { "type": "string", "description": "Reason of the Refund. Maximum length is 128." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "reason": "Return goods", "amount": 10, "request_id": "962dbd83-5e7b-4185-b668-596834395c12" } } } } }, "description": "Refund creation request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" }, "examples": { "default": { "value": { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "RECEIVED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `duplicate_request`, `invalid_status_for_operation`, `amount_above_limit`, `operation_not_supported`, `resource_not_found`(invalid `payment_attempt_id` or `payment_intent_id`)" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/refunds/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "reason": "Return goods", "amount": 10, "request_id": "962dbd83-5e7b-4185-b668-596834395c12" }, "status_code": 201, "reason_phrase": "Created", "response_body": { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "RECEIVED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:write", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/refunds": { "get": { "tags": [ "Payment Acceptance > Refunds" ], "summary": "3|List all Refunds", "description": "List all Refunds.", "operationId": "listRefunds", "parameters": [ { "name": "connected_account_id", "in": "query", "description": "Optional Airwallex-assigned identifier of the connected account to filter by. Only applicable to platforms.", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Refund currency.", "required": false, "schema": { "type": "string", "default": "USD" } }, { "name": "from_created_at", "in": "query", "description": "The start time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-03-01T03:52:34+00:00" } }, { "name": "page_num", "in": "query", "description": "Page number starting from 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "default": { "value": 0 } } }, { "name": "page_size", "in": "query", "description": "Number of Refunds to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 }, "examples": { "default": { "value": 10 } } }, { "name": "payment_attempt_id", "in": "query", "description": "Payment Attempt unique identifier of the Refunds.", "required": false, "schema": { "type": "string", "default": "att_e65tkXCSzJrsMpTrzoFrjaau53" } }, { "name": "payment_intent_id", "in": "query", "description": "Payment Intent unique identifier of the Refunds.", "required": false, "schema": { "type": "string", "default": "int_e65tkXCSzJrsMpTrzoFrjaau53" } }, { "name": "status", "in": "query", "description": "Refund status.", "required": false, "schema": { "type": "string", "default": "SETTLED" }, "examples": { "default": { "value": "SETTLED,ACCEPTED" } } }, { "name": "to_created_at", "in": "query", "description": "The end time of `created_at` in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`).", "required": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+00:00" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/Refund" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "SETTLED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } ] } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url)" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/refunds", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "query_params": { "page_num": 0, "page_size": 10, "status": "SETTLED,ACCEPTED" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "SETTLED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } ] } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/refunds/{id}": { "get": { "tags": [ "Payment Acceptance > Refunds" ], "summary": "2|Retrieve a Refund", "description": "Retrieve a Refund by unique identifier.", "operationId": "retrieveRefund", "parameters": [ { "name": "id", "in": "path", "description": "Refund unique identifier.", "required": true, "schema": { "type": "string", "default": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" }, "examples": { "default": { "value": "rfd_hkpdbybkch3ovunwjy1_1raukh" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" }, "examples": { "default": { "value": { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "ACCEPTED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `not_found`(invalid url), `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/refunds/rfd_hkpdbybkch3ovunwjy1_1raukh", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "rfd_hkpdbybkch3ovunwjy1_1raukh", "request_id": "962dbd83-5e7b-4185-b668-596834395c12", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "payment_attempt_id": "att_hkpdskz7vg1xc7uscdj", "amount": 10, "currency": "USD", "reason": "Return goods", "status": "ACCEPTED", "created_at": "2021-01-31T06:57:10+00:00", "updated_at": "2021-01-31T07:01:10+00:00" } } ], "x-scope": [ { "scope": "payment_acceptance:read", "group": "Payment Acceptance", "resource_name": "Payment Acceptance", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/settlement_records": { "get": { "tags": [ "Payment Acceptance > Settlement Records" ], "summary": "1|List all Settlement Records", "description": "Get Settlement Records by specifying the settlement (batch) unique identifier or payment intent unique identifier.", "operationId": "listSettlementRecords", "parameters": [ { "name": "page", "in": "query", "description": "Value from page_after.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items requested by page (default and max is 50).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "payment_intent_id", "in": "query", "description": "The payment intent unique identifier of the settlement records.", "required": false, "schema": { "type": "string" } }, { "name": "settlement_id", "in": "query", "description": "The settlement(batch) unique identifier of the settlement records.", "required": false, "schema": { "type": "string" }, "examples": { "default": { "value": "bat_20250305_AUD_1" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/SettlementRecord" } }, "page_after": { "type": "string", "description": "Page after." } } }, "examples": { "default": { "value": { "has_more": true, "items": [ { "account_id": "acct_NmdN7NpxM_KucIpNwui7GQ", "card_category": "Consumer", "card_funding": "Credit", "card_issuing_or_shopper_country": "AUS", "card_transaction_region": "Asia", "created_at": "2025-03-05T20:10:00Z", "customer_email": "customer123@airwallex.com", "customer_id": "cus_sgstf9vlwh571d5ws2z", "customer_name": "Danny Jones", "customer_phone": "123456789", "descriptor": "vip8888", "exchange_rate": 1, "fee_details_list": [ { "exchange_rate": 1, "fee_currency": "AUD", "fee_subtotal_amount": 3, "fee_type": "Payment method fee", "incurred_at": "2025-03-27T03:27:34-0600", "payment_method_number_or_id": "abc****abc", "settlement_currency": "AUD", "settlement_subtotal_amount": 3, "settlement_tax_amount": 1, "settlement_total_amount": 4, "source_status": "Paid" } ], "fees": -3, "gross_amount": 5000, "issuing_or_originating_bank": "National Australia Bank", "merchant_customer_id": "a336bb7a-1ce6-437a-b800-723851896038", "metadata": { "foo": "bar" }, "net_amount": 4996, "order_id": "46e06c0a-26ec-419c-8f42-0c33212bb13f", "payment_attempt_ids": [ "att_sgstfl9zth571d6cvhq_d61cd3" ], "payment_created_time": "2025-03-05T20:05:35Z", "payment_intent_id": "int_sgstfl9zth571d61cd3", "payment_method": "ApplePay", "payment_method_type": "Visa", "request_id": "a7c419e1-e43a-4681-8951-02981f3150e0", "settled_at": "2025-03-05T23:20:00Z", "settlement_batch_id": "bat_20250305_AUD_1", "settlement_currency": "AUD", "shipping_address": "123 Baker Street", "shipping_city": "London", "shipping_country": "ENG", "shipping_name": "violet client", "shipping_postal_code": "100234", "shipping_state": "London area", "source_entity": "Payment Attempt", "source_id": "att_sgstfl9zth571d6cvhq_d61cd3", "taxes_on_fees": -1, "transaction_amount": 5000, "transaction_currency": "AUD", "transaction_id": "ftx_ymUW4ZTiPJSyOxfYBFkXfg", "transaction_type": "Payment" } ], "page_after": "" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `resource_not_found` (`settlement_id` or `payment_intent_id` not found), `validation_error` (e.g. invalid `page_size`), `configuration_error` (Invalid request against merchant configuration. Please contact your account manager.)" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/settlement_records?settlement_id=bat_20250305_AUD_1", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": true, "items": [ { "account_id": "acct_NmdN7NpxM_KucIpNwui7GQ", "card_category": "Consumer", "card_funding": "Credit", "card_issuing_or_shopper_country": "AUS", "card_transaction_region": "Asia", "created_at": "2025-03-05T20:10:00Z", "customer_email": "customer123@airwallex.com", "customer_id": "cus_sgstf9vlwh571d5ws2z", "customer_name": "Danny Jones", "customer_phone": "123456789", "descriptor": "vip8888", "exchange_rate": 1, "fee_details_list": [ { "exchange_rate": 1, "fee_currency": "AUD", "fee_subtotal_amount": 3, "fee_type": "Payment method fee", "incurred_at": "2025-03-27T03:27:34-0600", "payment_method_number_or_id": "abc****abc", "settlement_currency": "AUD", "settlement_subtotal_amount": 3, "settlement_tax_amount": 1, "settlement_total_amount": 4, "source_status": "Paid" } ], "fees": -3, "gross_amount": 5000, "issuing_or_originating_bank": "National Australia Bank", "merchant_customer_id": "a336bb7a-1ce6-437a-b800-723851896038", "metadata": { "foo": "bar" }, "net_amount": 4996, "order_id": "46e06c0a-26ec-419c-8f42-0c33212bb13f", "payment_attempt_ids": [ "att_sgstfl9zth571d6cvhq_d61cd3" ], "payment_created_time": "2025-03-05T20:05:35Z", "payment_intent_id": "int_sgstfl9zth571d61cd3", "payment_method": "ApplePay", "payment_method_type": "Visa", "request_id": "a7c419e1-e43a-4681-8951-02981f3150e0", "settled_at": "2025-03-05T23:20:00Z", "settlement_batch_id": "bat_20250305_AUD_1", "settlement_currency": "AUD", "shipping_address": "123 Baker Street", "shipping_city": "London", "shipping_country": "ENG", "shipping_name": "violet client", "shipping_postal_code": "100234", "shipping_state": "London area", "source_entity": "Payment Attempt", "source_id": "att_sgstfl9zth571d6cvhq_d61cd3", "taxes_on_fees": -1, "transaction_amount": 5000, "transaction_currency": "AUD", "transaction_id": "ftx_ymUW4ZTiPJSyOxfYBFkXfg", "transaction_type": "Payment" } ], "page_after": "" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/activate": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "5|Activate a Terminal", "description": "Activate a Terminal.", "operationId": "terminals_activate", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "terminal_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "description": "Activate request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/terminal_id/activate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/cancel_current_operation": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "10|Cancel Current Operation on a Terminal", "description": "Cancel current operation on a Terminal if possible.", "operationId": "cancelCurrentOperation", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "terminal_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `terminal_busy`, `terminal_unavailable`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/terminal_id/cancel_current_operation", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/create": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "1|Create a Terminal", "description": "Create a new Terminal. The `activation_code` must be provided in the request body. The `nickname` is optional and can be used to identify the terminal.", "operationId": "createTerminal", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "activation_code", "request_id" ], "properties": { "activation_code": { "type": "string", "description": "The activation code read from the terminal." }, "connected_account_id": { "type": "string", "description": "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." }, "nickname": { "type": "string", "description": "Nickname of the Terminal." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "activation_code": "MEFCMSBC", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "nickname": "cloth store", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "description": "Create request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "activation_code": "MEFCMSBC", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "nickname": "cloth store", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/deactivate": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "8|Deactivate a Terminal", "description": "Deactivate a Terminal.", "operationId": "terminals_deactivate", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "{id}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "962dbd83-5e7b-4185-b668-596834395c12" } } } } }, "description": "Deactivate request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "INACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/{id}/deactivate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "962dbd83-5e7b-4185-b668-596834395c12" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "INACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals": { "get": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "3|List all Terminals", "description": "List all Terminals.", "operationId": "listTerminals", "x-oboSupported": false, "parameters": [ { "name": "connected_account_id", "in": "query", "description": "Optional Airwallex-assigned connected account identifier to filter by. Only applicable to platforms.", "required": false, "schema": { "type": "string" } }, { "name": "device_model", "in": "query", "description": "Optional device model filter.", "required": false, "schema": { "type": "string" } }, { "name": "nickname", "in": "query", "description": "Optional nickname filter of the Terminal.", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page for pagination.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of Terminals to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "serial_number", "in": "query", "description": "Optional serial number of the Terminal.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Optional operational status filter of the Terminal.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfTerminal" }, "examples": { "default": { "value": { "items": [ { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } ], "page_after": "eyJrIjpbeyJuIjoiYXd4VGVybWluYWxJZCIsInYiOiJ0ZXJfc3Q4dnZmN2g0dGh0ZGVpcmQiLCJvIjoiYSIsInQiOiJqYXZhLmxhbmcuU3RyaW5nIn1dLCJkIjoiYWZ0ZXIiLCJmIjoibiIsInYiOjF9", "page_before": "eyJrIjpbeyJuIjoiYXd4VGVybWluYWxJZCIsInYiOiJ0ZXJfc3RoYjd0aGgycnEydHNvcnUiLCJvIjoiYSIsInQiOiJqYXZhLmxhbmcuU3RyaW5nIn1dLCJkIjoiYmVmb3JlIiwiZiI6Im4iLCJ2IjoxfQ==" } } } } } }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/pos/terminals", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } ], "page_after": "eyJrIjpbeyJuIjoiYXd4VGVybWluYWxJZCIsInYiOiJ0ZXJfc3Q4dnZmN2g0dGh0ZGVpcmQiLCJvIjoiYSIsInQiOiJqYXZhLmxhbmcuU3RyaW5nIn1dLCJkIjoiYWZ0ZXIiLCJmIjoibiIsInYiOjF9", "page_before": "eyJrIjpbeyJuIjoiYXd4VGVybWluYWxJZCIsInYiOiJ0ZXJfc3RoYjd0aGgycnEydHNvcnUiLCJvIjoiYSIsInQiOiJqYXZhLmxhbmcuU3RyaW5nIn1dLCJkIjoiYmVmb3JlIiwiZiI6Im4iLCJ2IjoxfQ==" } } ], "x-scope": [ { "scope": "pos_terminal:read", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/process_payment_intent": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "6|Process a Payment Intent in a Terminal", "description": "Process a Payment Intent In a Terminal.", "operationId": "processPaymentIntent", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "terminal_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payment_intent_id", "request_id" ], "properties": { "payment_intent_id": { "type": "string", "description": "Unique identifier of Payment Intent." }, "payment_method": { "type": "object", "required": [ "type" ], "description": "The Payment Method to use for the Payment Intent. If unfilled, the default payment method set on the terminal will be used.", "properties": { "type": { "type": "string", "description": "Type of the Payment Method (e.g. card_present, pay_now, wechatpay)." } } }, "payment_method_options": { "type": "object", "description": "Options for Payment Method.", "properties": { "card": { "type": "object", "description": "The Payment Method options for card.", "properties": { "authorization_type": { "type": "string", "description": "The authorization type of the card payment. One of `final_auth`, `pre_auth`. Default to `final_auth`. Set it to `pre_auth` if you want to place a hold on your customer’s card for more than 7 days. Currently only available when the card brand is visa or mastercard. You must also set `auto_capture` to be `false` if you want to do pre-auth." }, "auto_capture": { "type": "boolean", "description": "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." } } } } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "payment_intent_id": "int_hkstskz7vg1xc7uscdj", "payment_method": { "type": "card_present" }, "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true } }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "description": "Terminal process payment intent request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`, `terminal_busy`, `terminal_unavailable`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/terminal_id/process_payment_intent", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "payment_intent_id": "int_hkstskz7vg1xc7uscdj", "payment_method": { "type": "card_present" }, "payment_method_options": { "card": { "authorization_type": "final_auth", "auto_capture": true } }, "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/reset_password": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "7|Reset a Terminal Password", "description": "Reset a Terminal password.", "operationId": "resetPassword", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "{id}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "password_type": { "type": "string", "description": "Terminal password type \n\n**admin**\n- The terminal admin password.\n**refund**\n- The terminal refund password.\n" }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "password_type": "admin", "request_id": "962dbd83-5e7b-4185-b668-596834395c12" } } } } }, "description": "Update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "RESET_REQUESTED", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/{id}/reset_password", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "password_type": "admin", "request_id": "962dbd83-5e7b-4185-b668-596834395c12" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "admin_password_status": "RESET_REQUESTED", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}": { "get": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "2|Retrieve a Terminal", "description": "Retrieve a Terminal by unique identifier.", "operationId": "retrieveTerminal", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "terminal_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/pa/pos/terminals/terminal_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:read", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/terminate": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "9|Terminate a Terminal", "description": "Terminate a Terminal.", "operationId": "terminate", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "{id}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "request_id": "962dbd83-5e7b-4185-b668-596834395c12" } } } } }, "description": "Terminate request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "TERMINATED" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `invalid_status_for_operation`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/{id}/terminate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "request_body": { "request_id": "962dbd83-5e7b-4185-b668-596834395c12" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "TERMINATED" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/pa/pos/terminals/{id}/update": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "summary": "4|Update a Terminal", "description": "Update a Terminal.", "operationId": "updateTerminal", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Terminal unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "terminal_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "nickname": { "type": "string", "description": "Nickname of the Terminal." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant. Maximum length is 64." } } }, "examples": { "default": { "value": { "nickname": "cloth store", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" } } } } }, "description": "Update request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "default": { "value": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } } } } }, "201": { "description": "Created" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`" }, "401": { "description": "Unauthorized. Possible error codes: `unauthorized`" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found. Possible error codes: `resource_not_found`" }, "500": { "description": "Server Error. Possible error codes: `internal_error`" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/pa/pos/terminals/terminal_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "nickname": "cloth store", "request_id": "ee939540-3203-4a2c-9172-89a566485dd9" }, "response_body": { "admin_password_status": "ACTIVE", "connected_account_id": "acct_dk_FmEGnOSeoCCg3RpmJBA", "id": "ter_st8szlkh4z0nbfikx", "model": "morefun_m90", "nickname": "cloth store", "refund_password_status": "ACTIVE", "serial_number": "19250220790001", "status": "ACTIVE" } } ], "x-scope": [ { "scope": "pos_terminal:write", "group": "Payment Acceptance", "resource_name": "POS Terminals", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/add_items": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "4|Add Items To a Batch", "description": "Add transfer items to a batch by specifying the batch transfer `id`. You may add 100 items at a time and add up to a maximum of 1000 items per batch transfer. Please note that you can only add items to a batch when its status is `DRAFTING`.", "operationId": "addItems", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to add batch transfer items.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "A list of batch items to be added, you may add 100 items at a time and add up to a maximum of 1000 items per batch transfer.", "items": { "type": "object", "required": [ "reason", "reference", "request_id", "source_currency", "transfer_currency", "transfer_method" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transfer.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } } }, "beneficiary": { "type": "object", "description": "Details for the beneficiary in the transfer request. If beneficiary_id provided in the transfer request then beneficiary should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds." } } }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "An Airwallex beneficiary_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the beneficiary section and should be empty if the beneficiary fields are provided." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER`/`BENEFICIARY` will be liable for the transfer fees, and it affects the actual amount the beneficiary receives." }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details for the payer in the transfer request. If payer_id provided in the transfer request then payer should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } }, "payer_id": { "type": "string", "format": "uuid", "description": "An Airwallex `payer_id` previously generated by utilising the Airwallex Contact API. This may be provided in place of the payer section and should be empty if the `payer` fields are provided." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the beneficiary on the transfer transaction with their bank." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client. payout requests with the same request_id will be ignored. This allows requests to be replayed if client is unsure of the outcome, e.g. due to network issues, system failures, etc. Note: Can be non-UUID as long as it is unique between requests." }, "source_amount": { "type": "number", "description": "Source amount in `source_currency`." }, "source_currency": { "type": "string", "description": "Source currency, i.e. the currency that the Payer uses to fund the transfer (3-letter ISO-4217 code)." }, "swift_charge_option": { "type": "string", "description": "(For SWIFT transfers only), specify who should bear SWIFT charges, either `SHARED` (default) or `PAYER`." }, "transfer_amount": { "type": "number", "description": "Transfer amount in `transfer_currency`." }, "transfer_currency": { "type": "string", "description": "Transfer currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e. SWIFT, LOCAL." } }, "description": "Draft batch item request." } } } }, "examples": { "default": { "value": { "items": [ { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "fee_paid_by": "PAYER", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": 10000, "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_method": "SWIFT" } ] } } } } }, "description": "addBatchItemsDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/batch_transfer_id/add_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "items": [ { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "fee_paid_by": "PAYER", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": 10000, "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_method": "SWIFT" } ] }, "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/create": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "1|Create a Batch Transfer", "description": "Create a new batch transfer.", "operationId": "createBatchTransfer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "funding_source": { "type": "object", "description": "Specify funding source for the batch. If not set, default is wallet.", "properties": { "deposit_type": { "type": "string", "description": "The type of deposit you would like to create, either DIRECT_DEBIT or FASTER_DIRECT_DEBIT. If not specified, it will default to DIRECT_DEBIT." }, "id": { "type": "string", "format": "uuid", "description": "The funding source unique identifier only supports Linked Accounts. Please provide the unique identifier of your Linked Account as returned in [Create a Linked Account](/docs/api/core_resources/linked_accounts/create). Note that if not specified, the funding source will default to your Wallet." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the Direct Debit bank account owner on the bank statement." } } }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the batch transfer.", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "The name of the batch transfer." }, "remarks": { "type": "string", "description": "Additional information about this batch transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique batch payout reference specified by the client. Batch payout create requests with the same request_id will be rejected." }, "transfer_date": { "type": "string", "description": "If you are using your Wallet as the funding source, you can specify a current or future date (ISO 8601 format) for when the batch transfer items should be processed. If left blank, the transfer date will default to the earliest possible date." } } }, "examples": { "default": { "value": { "funding_source": { "deposit_type": "DIRECT_DEBIT", "id": "8365ea88-2946-4877-abe1-e02a1015288d", "reference": "DD for batch transfer 12345" }, "metadata": { "order_id": "0123456789" }, "name": "batch-name", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "transfer_date": "2024-01-24" } } } } }, "description": "createBatchDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "funding_source": { "deposit_type": "DIRECT_DEBIT", "id": "8365ea88-2946-4877-abe1-e02a1015288d", "reference": "DD for batch transfer 12345" }, "metadata": { "order_id": "0123456789" }, "name": "batch-name", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "transfer_date": "2024-01-24" }, "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/delete": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "7|Delete a Batch Transfer", "description": "Before submitting a batch transfer, you can delete a batch by specifying the batch transfer `id`. Please note that you can only delete a batch transfer when its status is `DRAFTING`.", "operationId": "deleteBatchTransfer", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to be deleted.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/batch_transfer_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/delete_items": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "8|Delete Items Within a Batch", "description": "Before submitting a batch transfer, you can delete invalid or wrong items in the batch by specifying the batch transfer `id` and `item_ids`. Please note that you can only delete items when the batch transfer status is `DRAFTING`.", "operationId": "deleteItems", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to delete batch transfer items.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "item_ids" ], "properties": { "item_ids": { "type": "array", "description": "A list of batch item ids to be deleted.", "items": { "type": "string", "format": "uuid" } } } }, "examples": { "default": { "value": { "item_ids": [] } } } } }, "description": "deleteBatchItemsDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/batch_transfer_id/delete_items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "item_ids": [] }, "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers": { "get": { "tags": [ "Payouts > Batch Transfers" ], "summary": "3|List all Batch Transfers", "description": "Retrieve batch transfers with optional filters on request id, status, or pagination parameters (page, page_size).", "operationId": "listBatchTransfers", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default and max value is 50.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "request_id", "in": "query", "description": "Batch transfer `request_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "short_reference_id", "in": "query", "description": "Batch transfer `short_reference_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The batch transfer status.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorBasedPagedQueryResultDtoOfBatchTransfer" }, "examples": { "default": { "value": { "items": [ { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ] }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/batch_transfers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ] }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/items": { "get": { "tags": [ "Payouts > Batch Transfers" ], "summary": "9|List all Items Within a Batch", "description": "Retrieve all items added to the batch transfer by specifying the batch transfer `id`.", "operationId": "batchTransfers_listItems", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to retrieve items.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page, default and max value is 1000.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 1000 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorBasedPagedQueryResultDtoOfBatchTransferItem" }, "examples": { "default": { "value": { "items": [ { "errors": [ { "code": "002", "params": { "length_min": "5", "length_max": "200" }, "source": "beneficiary.address.street_address" } ], "id": "aaaaaaaa-a6a1-4d45-aae7-6858fceeeeee", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "status": "VALIDATED", "transfer_draft": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "reason": "travel", "reference": "PMT1936398", "remarks": "string", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2021-01-24", "transfer_method": "SWIFT" }, "transfer_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "updated_at": "2021-01-24T18:00:02+1100" } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/batch_transfers/batch_transfer_id/items", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "errors": [ { "code": "002", "params": { "length_min": "5", "length_max": "200" }, "source": "beneficiary.address.street_address" } ], "id": "aaaaaaaa-a6a1-4d45-aae7-6858fceeeeee", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "status": "VALIDATED", "transfer_draft": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "reason": "travel", "reference": "PMT1936398", "remarks": "string", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2021-01-24", "transfer_method": "SWIFT" }, "transfer_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "updated_at": "2021-01-24T18:00:02+1100" } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/quote": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "5|Quote a Batch Transfer", "description": "After adding valid transfer items to the batch, you can quote/lock FX rates by specifying the batch transfer `id`. Please note that only valid items in the batch will be quoted; you can only quote a batch transfer when its status is `DRAFTING` or `IN_APPROVAL`.", "operationId": "batchTransfers_quote", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to quote.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validity": { "type": "string", "description": "Quote validity period.. The value will default to MIN_1 if not specified.", "enum": [ "MIN_1", "MIN_15", "MIN_30", "HR_1", "HR_4", "HR_8", "HR_24" ] } } }, "examples": { "default": { "value": { "validity": "HR_24" } } } } }, "description": "batchQuoteRequestDto." }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/batch_transfer_id/quote", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "validity": "HR_24" }, "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}": { "get": { "tags": [ "Payouts > Batch Transfers" ], "summary": "2|Retrieve a Batch Transfer", "description": "Retrieve details of a batch transfer by specifying the batch transfer `id`.", "operationId": "retrieveBatchTransfer", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/batch_transfers/batch_transfer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/batch_transfers/{id}/submit": { "post": { "tags": [ "Payouts > Batch Transfers" ], "summary": "6|Submit a Batch Transfer", "description": "Submit a batch transfer by specifying the batch transfer `id`. Please note that only valid items in the batch will be submitted. If no approval is required, this batch will transition to `SCHEDULED` status and will be processed by Airwallex accordingly. If approval is required, this batch will transition to `IN_APPROVAL` status.", "operationId": "batchTransfers_submit", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the batch transfer to submit.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "batch_transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchTransfer" }, "examples": { "default": { "value": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/batch_transfers/batch_transfer_id/submit", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "funding": { "deposit_type": "DIRECT_DEBIT", "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "reference": "DD for batch transfer 12345", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "name": "batch-name", "quote_summary": { "expires_at": "2024-01-24T18:03:02+1100", "last_quoted_at": "2024-01-24T18:00:02+1100", "quotes": [ { "amount_beneficiary_receives": 200, "amount_payer_pays": 1005, "client_rate": 5, "currency_pair": "AUDUSD", "fee_amount": 5, "fee_currency": "USD", "source_currency": "USD", "transfer_currency": "AUD" } ], "validity": "MIN_1" }, "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d911", "short_reference_id": "B231018-TMA1RTC", "status": "SCHEDULED", "total_item_count": 100, "transfer_date": "2024-01-24", "updated_at": "2024-01-24T18:00:02+1100", "valid_item_count": 99 } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/create": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "1|Create a Beneficiary", "description": "> [!INFORMATIONAL: Transfer to card is available for early access]\n> Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [support@airwallex.com](mailto:support@airwallex.com) if you would like to use this feature. [Learn more about early access](https://www.airwallex.com/docs/developer-tools/release-phases).\n\nCreate a new beneficiary to be stored on the Airwallex platform.", "operationId": "createBeneficiary", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "beneficiary", "transfer_methods" ], "properties": { "beneficiary": { "type": "object", "description": "Details of the beneficiary.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "stablecoin_wallet": { "type": "object", "required": [ "asset", "network", "address" ], "properties": { "asset": { "type": "string", "description": "Stablecoin asset type, e.g., `USDC`." }, "network": { "type": "string", "description": "Blockchain network, e.g., `ETHEREUM`." }, "address": { "type": "string", "description": "Blockchain wallet address of the beneficiary. Sending stablecoins to an incorrect wallet address or unsupported network will result in the irreversible loss of funds. Always verify the recipient wallet address and network before initiating a transfer." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds. Possible values: `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`." } } }, "nickname": { "type": "string", "description": "Nickname of the beneficiary." }, "payer_entity_type": { "type": "string", "description": "The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to `COMPANY`." }, "sca_exemptible": { "type": "boolean", "description": "Whether the beneficiary can be exempted from SCA when applicable." }, "transfer_methods": { "type": "array", "description": "Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: `SWIFT`, `LOCAL`.", "items": { "type": "string" } }, "transfer_reason": { "type": "string", "description": "Reason for the transfer instruction being made to this beneficiary." } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" } } } } }, "description": "beneficiaryContactRequest.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryContact" }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } } } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "code": "validation_failed", "details": { "errors": [ { "code": "008", "source": "beneficiary.bank_details.account_number" }, { "code": "018", "params": { "length_max": 12, "length_min": 7 }, "source": "beneficiary.bank_details.account_number" }, { "code": "002", "source": "beneficiary.bank_details.account_name" } ] }, "message": "This is not valid." } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/beneficiaries/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" }, "response_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } }, { "key": "validation_failed", "name": "Validation Failed", "method": "POST", "uri": "/api/v1/beneficiaries/create", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "validation_failed", "details": { "errors": [ { "code": "008", "source": "beneficiary.bank_details.account_number" }, { "code": "018", "params": { "length_max": 12, "length_min": 7 }, "source": "beneficiary.bank_details.account_number" }, { "code": "002", "source": "beneficiary.bank_details.account_name" } ] }, "message": "This is not valid." } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/{id}/delete": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "7|Delete an Existing Beneficiary", "description": "Delete an existing beneficiary stored on the Airwallex platform.", "operationId": "deleteBeneficiary", "parameters": [ { "name": "id", "in": "path", "description": "id of the beneficiary contact to delete.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "8365ea88-2946-4877-abe1-e02a1015288d" }, "examples": { "default": { "value": "beneficiarie_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Returns `true` if the beneficiary was successfully deleted, or `false` if the deletion did not take place." }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/beneficiaries/beneficiarie_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiary_api_schemas/generate": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "8|Retrieve the API Schema", "description": "> [!INFORMATIONAL: Transfer to card is available for early access]\n> Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [support@airwallex.com](mailto:support@airwallex.com) if you would like to use this feature. [Learn more about early access](https://www.airwallex.com/docs/developer-tools/release-phases).\n\nAPI schema specifies the required fields and the corresponding field validation rules for each transfer scenario. A payment scenario is defined as a combination of the following parameters: beneficiary entity_type, bank_country_code. account_currency, and your preferred transfer_method, local_clearing_system (if applicable).", "operationId": "generateApiSchemas", "requestBody": { "content": { "application/json": { "schema": { "title": "Beneficiary type", "description": "Condition map specified in the request defines the schema. The set of parameters depends on the beneficiary `type`.", "oneOf": [ { "title": "Bank account", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "BANK_ACCOUNT" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "account_currency": { "type": "string", "description": "Account currency (3-letter ISO 4217 currency code)." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e., `SWIFT`, `LOCAL`." }, "local_clearing_system": { "type": "string", "description": "Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: [https://www.airwallex.com/guides/payout](https://www.airwallex.com/guides/payout)." } } }, { "title": "Digital wallet", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "DIGITAL_WALLET" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, { "title": "Card", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "CARD" ] } } }, { "title": "Stablecoin wallet", "type": "object", "description": "Select the stablecoin wallet schema using type and entity_type. The account must have stablecoin beneficiary capability enabled. Asset and network rules depend on the available configuration.", "required": [ "type", "entity_type" ], "example": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" }, "properties": { "type": { "type": "string", "description": "Set to `STABLECOIN_WALLET` to retrieve the stablecoin wallet beneficiary API schema.", "enum": [ "STABLECOIN_WALLET" ], "x-enumDescriptions": { "STABLECOIN_WALLET": "Stablecoin wallet beneficiary type." } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." } } } ] }, "examples": { "default": { "value": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" } }, "newDigitalRecipient": { "value": { "type": "DIGITAL_WALLET", "entity_type": "PERSONAL", "provider": "AIRWALLEX" } }, "newCardRecipient": { "value": { "type": "CARD" } }, "newStablecoinWalletRecipient": { "value": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" } } } } }, "description": "request." }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Beneficiary type", "oneOf": [ { "title": "Bank account", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the API schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "BANK_ACCOUNT" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "account_currency": { "type": "string", "description": "Account currency (3-letter ISO 4217 currency code)." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e., `SWIFT`, `LOCAL`." }, "local_clearing_system": { "type": "string", "description": "Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: [https://www.airwallex.com/guides/payout](https://www.airwallex.com/guides/payout)." } } }, "fields": { "type": "array", "description": "List of fields in the API schema defined by the condition map.", "items": { "$ref": "#/components/schemas/ApiSchemaField" } }, "key": { "type": "string", "description": "Identifier of the API schema." } } }, { "title": "Digital wallet", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the API schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "DIGITAL_WALLET" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "fields": { "type": "array", "description": "List of fields in the API schema defined by the condition map.", "items": { "$ref": "#/components/schemas/ApiSchemaField" } }, "key": { "type": "string", "description": "Identifier of the API schema." } } }, { "title": "Card", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the API schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`.", "enum": [ "CARD" ] } } }, "fields": { "type": "array", "description": "List of fields in the API schema defined by the condition map.", "items": { "$ref": "#/components/schemas/ApiSchemaField" } }, "key": { "type": "string", "description": "Identifier of the API schema." } } }, { "title": "Stablecoin wallet", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the API schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary. For a stablecoin wallet, this is `STABLECOIN_WALLET`.", "enum": [ "STABLECOIN_WALLET" ], "x-enumDescriptions": { "STABLECOIN_WALLET": "Stablecoin wallet beneficiary type." } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." } } }, "fields": { "type": "array", "description": "List of fields in the API schema defined by the condition map. Stablecoin wallet fields use the `beneficiary.stablecoin_wallet` path.", "items": { "$ref": "#/components/schemas/ApiSchemaField" } }, "key": { "type": "string", "description": "Identifier of the API schema. For a stablecoin wallet beneficiary, this is `newStablecoinWalletRecipient`." } } } ] }, "examples": { "default": { "value": { "condition": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "fields": [ { "key": "entity_type", "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "key": "bank_country_code", "path": "beneficiary.bank_details.bank_country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BG|BH|BO|BR|BZ|CA|CH|CL|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FR|GB|GD|GE|GG|GI|GQ|GR|GT|GY|HK|HN|HR|HU|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LI|LK|LT|LU|LV|MA|MC|MD|ME|MK|MO|MQ|MT|MU|MV|MX|MY|NA|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PT|PY|QA|RO|RS|RU|SA|SC|SE|SG|SI|SK|SM|SV|TH|TJ|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VN|VU|YT|ZA|ZM" } }, { "key": "account_currency", "path": "beneficiary.bank_details.account_currency", "required": true, "rule": { "type": "string", "pattern": "AUD|BDT|CAD|CHF|CNY|EUR|GBP|HKD|IDR|INR|JPY|KRW|LKR|MYR|NPR|NZD|PHP|PKR|SGD|THB|TRY|USD|VND" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL|SWIFT" } }, { "key": "local_clearing_system", "path": "beneficiary.bank_details.local_clearing_system", "required": false, "rule": { "type": "string", "pattern": "ACH|FEDWIRE" } }, { "key": "first_name", "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "last_name", "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "date_of_birth", "path": "beneficiary.date_of_birth", "required": false, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "key": "account_routing_type1", "path": "beneficiary.bank_details.account_routing_type1", "required": true, "rule": { "pattern": "^aba$", "type": "string" } }, { "key": "account_routing_value1", "path": "beneficiary.bank_details.account_routing_value1", "required": true, "rule": { "pattern": "^[0-9]{9}$", "type": "string" } }, { "key": "bank_name", "path": "beneficiary.bank_details.bank_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,200}$" } }, { "key": "account_number", "path": "beneficiary.bank_details.account_number", "required": true, "rule": { "pattern": "^[0-9]{1,17}$", "type": "string" } }, { "key": "account_name", "path": "beneficiary.bank_details.account_name", "required": true, "rule": { "type": "string", "pattern": "^.{2,100}$" } }, { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|YT|ZA|ZM" } }, { "key": "postcode", "path": "beneficiary.address.postcode", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "street_address", "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "^.{1,200}$" } }, { "key": "city", "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "state", "path": "beneficiary.address.state", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "nickname", "path": "nickname", "required": false }, { "key": "personal_email", "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newRecipient" } }, "newDigitalRecipient": { "value": { "condition": { "provider": "AIRWALLEX", "entity_type": "PERSONAL", "type": "DIGITAL_WALLET" }, "fields": [ { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "key": "provider", "path": "beneficiary.digital_wallet.provider", "required": true, "rule": { "type": "string", "pattern": "AIRWALLEX" } }, { "key": "id_type", "path": "beneficiary.digital_wallet.id_type", "required": true, "rule": { "type": "string", "pattern": "account_number" } }, { "key": "id_value", "path": "beneficiary.digital_wallet.id_value", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,70}$" } }, { "key": "account_name", "path": "beneficiary.digital_wallet.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "nickname", "path": "nickname", "required": false } ], "key": "newDigitalRecipient" } }, "newCardRecipient": { "value": { "condition": { "type": "CARD" }, "fields": [ { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "key": "token", "path": "beneficiary.card.token", "required": true }, { "key": "expiry_year", "path": "beneficiary.card.expiry_year", "required": true }, { "key": "expiry_month", "path": "beneficiary.card.expiry_month", "required": true }, { "key": "cardholder_name", "path": "beneficiary.card.cardholder_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "key": "street_address", "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "key": "city", "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "key": "nickname", "path": "nickname", "required": false }, { "key": "personal_email", "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newCardRecipient" } }, "newStablecoinWalletRecipient": { "value": { "condition": { "entity_type": "PERSONAL", "type": "STABLECOIN_WALLET" }, "fields": [ { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "key": "entity_type", "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "key": "first_name", "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "last_name", "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "date_of_birth", "path": "beneficiary.date_of_birth", "required": true, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "key": "asset", "path": "beneficiary.stablecoin_wallet.asset", "required": true, "rule": { "type": "string", "pattern": "USDC" } }, { "key": "network", "path": "beneficiary.stablecoin_wallet.network", "required": true, "rule": { "type": "string", "pattern": "ETHEREUM" } }, { "key": "address", "path": "beneficiary.stablecoin_wallet.address", "required": true, "rule": { "type": "string", "pattern": "^(0x)?[0-9a-fA-F]{40}$" } }, { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD|STABLECOIN_WALLET" } }, { "key": "nickname", "path": "nickname", "required": false } ], "key": "newStablecoinWalletRecipient" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "Bank account", "method": "POST", "uri": "/api/v1/beneficiary_api_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "response_body": { "condition": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "fields": [ { "key": "entity_type", "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "key": "bank_country_code", "path": "beneficiary.bank_details.bank_country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BG|BH|BO|BR|BZ|CA|CH|CL|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FR|GB|GD|GE|GG|GI|GQ|GR|GT|GY|HK|HN|HR|HU|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LI|LK|LT|LU|LV|MA|MC|MD|ME|MK|MO|MQ|MT|MU|MV|MX|MY|NA|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PT|PY|QA|RO|RS|RU|SA|SC|SE|SG|SI|SK|SM|SV|TH|TJ|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VN|VU|YT|ZA|ZM" } }, { "key": "account_currency", "path": "beneficiary.bank_details.account_currency", "required": true, "rule": { "type": "string", "pattern": "AUD|BDT|CAD|CHF|CNY|EUR|GBP|HKD|IDR|INR|JPY|KRW|LKR|MYR|NPR|NZD|PHP|PKR|SGD|THB|TRY|USD|VND" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL|SWIFT" } }, { "key": "local_clearing_system", "path": "beneficiary.bank_details.local_clearing_system", "required": false, "rule": { "type": "string", "pattern": "ACH|FEDWIRE" } }, { "key": "first_name", "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "last_name", "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "date_of_birth", "path": "beneficiary.date_of_birth", "required": false, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "key": "account_routing_type1", "path": "beneficiary.bank_details.account_routing_type1", "required": true, "rule": { "pattern": "^aba$", "type": "string" } }, { "key": "account_routing_value1", "path": "beneficiary.bank_details.account_routing_value1", "required": true, "rule": { "pattern": "^[0-9]{9}$", "type": "string" } }, { "key": "bank_name", "path": "beneficiary.bank_details.bank_name", "required": true, "rule": { "type": "string", "pattern": "^.{1,200}$" } }, { "key": "account_number", "path": "beneficiary.bank_details.account_number", "required": true, "rule": { "pattern": "^[0-9]{1,17}$", "type": "string" } }, { "key": "account_name", "path": "beneficiary.bank_details.account_name", "required": true, "rule": { "type": "string", "pattern": "^.{2,100}$" } }, { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RU|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|YT|ZA|ZM" } }, { "key": "postcode", "path": "beneficiary.address.postcode", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "street_address", "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "^.{1,200}$" } }, { "key": "city", "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "state", "path": "beneficiary.address.state", "required": true, "rule": { "type": "string", "pattern": "^.{1,50}$" } }, { "key": "nickname", "path": "nickname", "required": false }, { "key": "personal_email", "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newRecipient" } }, { "key": "newDigitalRecipient", "name": "Digital wallet", "method": "POST", "uri": "/api/v1/beneficiary_api_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "DIGITAL_WALLET", "entity_type": "PERSONAL", "provider": "AIRWALLEX" }, "response_body": { "condition": { "provider": "AIRWALLEX", "entity_type": "PERSONAL", "type": "DIGITAL_WALLET" }, "fields": [ { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "key": "provider", "path": "beneficiary.digital_wallet.provider", "required": true, "rule": { "type": "string", "pattern": "AIRWALLEX" } }, { "key": "id_type", "path": "beneficiary.digital_wallet.id_type", "required": true, "rule": { "type": "string", "pattern": "account_number" } }, { "key": "id_value", "path": "beneficiary.digital_wallet.id_value", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,70}$" } }, { "key": "account_name", "path": "beneficiary.digital_wallet.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "nickname", "path": "nickname", "required": false } ], "key": "newDigitalRecipient" } }, { "key": "newCardRecipient", "name": "Card", "method": "POST", "uri": "/api/v1/beneficiary_api_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "CARD" }, "response_body": { "condition": { "type": "CARD" }, "fields": [ { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD" } }, { "key": "transfer_method", "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "key": "token", "path": "beneficiary.card.token", "required": true }, { "key": "expiry_year", "path": "beneficiary.card.expiry_year", "required": true }, { "key": "expiry_month", "path": "beneficiary.card.expiry_month", "required": true }, { "key": "cardholder_name", "path": "beneficiary.card.cardholder_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "key": "street_address", "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "key": "city", "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "key": "nickname", "path": "nickname", "required": false }, { "key": "personal_email", "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newCardRecipient" } }, { "key": "newStablecoinWalletRecipient", "name": "Stablecoin wallet (personal)", "method": "POST", "uri": "https://api.airwallex.com/api/v1/beneficiary_api_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json", "x-api-version": "2026-06-30" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" }, "response_body": { "condition": { "entity_type": "PERSONAL", "type": "STABLECOIN_WALLET" }, "fields": [ { "key": "country_code", "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "key": "entity_type", "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "key": "first_name", "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "last_name", "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "key": "date_of_birth", "path": "beneficiary.date_of_birth", "required": true, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "key": "asset", "path": "beneficiary.stablecoin_wallet.asset", "required": true, "rule": { "type": "string", "pattern": "USDC" } }, { "key": "network", "path": "beneficiary.stablecoin_wallet.network", "required": true, "rule": { "type": "string", "pattern": "ETHEREUM" } }, { "key": "address", "path": "beneficiary.stablecoin_wallet.address", "required": true, "rule": { "type": "string", "pattern": "^(0x)?[0-9a-fA-F]{40}$" } }, { "key": "type", "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD|STABLECOIN_WALLET" } }, { "key": "nickname", "path": "nickname", "required": false } ], "key": "newStablecoinWalletRecipient" } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiary_form_schemas/generate": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "9|Retrieve the Form Schema", "description": "> [!INFORMATIONAL: Transfer to card is available for early access]\n> Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [support@airwallex.com](mailto:support@airwallex.com) if you would like to use this feature. [Learn more about early access](https://www.airwallex.com/docs/developer-tools/release-phases).\n\nForm Schema can be used to build your own user interface to collect beneficiaries’ bank account and contact information. It specifies what UI component should be used to render a field along with the corresponding field validation rules. As all schema and field validation rules are maintained by Airwallex, no code changes will be needed on your end when there are updates.", "operationId": "generateFormSchemas", "requestBody": { "content": { "application/json": { "schema": { "title": "Beneficiary type", "description": "Condition map specified in the request defines the schema. If `type` is omitted, the bank account form schema is returned. Set `type` to select a digital wallet, card, or stablecoin wallet form schema. For stablecoin wallets, `entity_type` is also required. Other parameters can be supplied as the form is completed to retrieve the matching fields.", "oneOf": [ { "title": "Bank account", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "BANK_ACCOUNT" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "account_currency": { "type": "string", "description": "Account currency (3-letter ISO 4217 currency code)." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e., `SWIFT`, `LOCAL`." }, "local_clearing_system": { "type": "string", "description": "Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: [https://www.airwallex.com/guides/payout](https://www.airwallex.com/guides/payout)." } } }, { "title": "Digital wallet", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "DIGITAL_WALLET" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, { "title": "Card", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "CARD" ] } } }, { "title": "Stablecoin wallet", "type": "object", "required": [ "type", "entity_type" ], "example": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" }, "properties": { "type": { "type": "string", "description": "Set to `STABLECOIN_WALLET` to retrieve the stablecoin wallet beneficiary form schema.", "enum": [ "STABLECOIN_WALLET" ], "x-enumDescriptions": { "STABLECOIN_WALLET": "Stablecoin wallet beneficiary type." } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." } } } ] }, "examples": { "newStablecoinWalletRecipient": { "value": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" } }, "default": { "value": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" } }, "newDigitalRecipient": { "value": { "type": "DIGITAL_WALLET", "entity_type": "PERSONAL", "provider": "AIRWALLEX" } }, "newCardRecipient": { "value": { "type": "CARD" } } } } }, "description": "request." }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Beneficiary type", "oneOf": [ { "title": "Bank account", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the form schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "BANK_ACCOUNT" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "account_currency": { "type": "string", "description": "Account currency (3-letter ISO 4217 currency code)." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e., `SWIFT`, `LOCAL`." }, "local_clearing_system": { "type": "string", "description": "Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: [https://www.airwallex.com/guides/payout](https://www.airwallex.com/guides/payout)." } } }, "fields": { "type": "array", "description": "List of fields in the form schema defined by the condition map.", "items": { "$ref": "#/components/schemas/FormSchemaField" } }, "key": { "type": "string", "description": "Identifier of the form schema." } } }, { "title": "Digital wallet", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the form schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "DIGITAL_WALLET" ] }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "fields": { "type": "array", "description": "List of fields in the form schema defined by the condition map.", "items": { "$ref": "#/components/schemas/FormSchemaField" } }, "key": { "type": "string", "description": "Identifier of the form schema." } } }, { "title": "Card", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the form schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`.", "enum": [ "CARD" ] } } }, "fields": { "type": "array", "description": "List of fields in the form schema defined by the condition map.", "items": { "$ref": "#/components/schemas/FormSchemaField" } }, "key": { "type": "string", "description": "Identifier of the form schema." } } }, { "title": "Stablecoin wallet", "type": "object", "properties": { "condition": { "type": "object", "description": "Condition map specified in the request defines the form schema.", "properties": { "type": { "type": "string", "description": "Type of the beneficiary. For a stablecoin wallet, this is `STABLECOIN_WALLET`.", "enum": [ "STABLECOIN_WALLET" ], "x-enumDescriptions": { "STABLECOIN_WALLET": "Stablecoin wallet beneficiary type." } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., `COMPANY`, `PERSONAL`." } } }, "fields": { "type": "array", "description": "List of fields in the form schema defined by the condition map. Stablecoin wallet fields use the `beneficiary.stablecoin_wallet` path.", "items": { "$ref": "#/components/schemas/FormSchemaField" } }, "key": { "type": "string", "description": "Identifier of the form schema. For a stablecoin wallet beneficiary, this is `newStablecoinWalletRecipient`." } } } ] }, "examples": { "newStablecoinWalletRecipient": { "value": { "condition": { "entity_type": "PERSONAL", "type": "STABLECOIN_WALLET" }, "fields": [ { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Afghanistan", "value": "AF" }, { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Eswatini", "value": "SZ" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Haiti", "value": "HT" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See (Vatican City)", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Iraq", "value": "IQ" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Mali", "value": "ML" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Mozambique", "value": "MZ" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Republic of the Congo", "value": "CG" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "Somalia", "value": "SO" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "South Sudan", "value": "SS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sudan", "value": "SD" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "The Democratic Republic Of The Congo", "value": "CD" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Yemen", "value": "YE" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "", "description": "", "example": "AU", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "entity_type", "options": [ { "label": "Business", "value": "COMPANY" }, { "label": "Personal", "value": "PERSONAL" } ], "default": "PERSONAL", "description": "", "example": "PERSONAL", "label": "Type of account holder", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "enabled": true, "field": { "key": "first_name", "default": "", "description": "", "example": "John", "label": "First name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "last_name", "default": "", "description": "", "example": "Walker", "label": "Last name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "date_of_birth", "default": "", "description": "", "example": "2000-01-01", "label": "Date of birth", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.date_of_birth", "required": true, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "enabled": true, "field": { "key": "asset", "options": [ { "label": "USDC", "value": "USDC" } ], "default": "", "description": "", "example": "", "label": "Token symbol", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.stablecoin_wallet.asset", "required": true, "rule": { "type": "string", "pattern": "USDC" } }, { "enabled": true, "field": { "key": "network", "options": [ { "label": "ETHEREUM", "value": "ETHEREUM" } ], "default": "", "description": "", "example": "", "label": "Network", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.stablecoin_wallet.network", "required": true, "rule": { "type": "string", "pattern": "ETHEREUM" } }, { "enabled": true, "field": { "key": "address", "default": "", "description": "Address", "example": "", "label": "Address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.stablecoin_wallet.address", "required": true, "rule": { "type": "string", "pattern": "^(0x)?[0-9a-fA-F]{40}$" } }, { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" }, { "label": "STABLECOIN_WALLET", "value": "STABLECOIN_WALLET" } ], "default": "STABLECOIN_WALLET", "description": "", "example": "", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|STABLECOIN_WALLET" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For reference only. Not sent to the recipient.", "example": "John Walker", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false } ], "key": "newStablecoinWalletRecipient" } }, "default": { "value": { "condition": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "fields": [ { "enabled": true, "field": { "key": "entity_type", "options": [ { "label": "Business", "value": "COMPANY" }, { "label": "Personal", "value": "PERSONAL" } ], "default": "PERSONAL", "description": "", "example": "PERSONAL", "label": "Recipient account type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "enabled": true, "field": { "key": "bank_country_code", "options": [ { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Brazil", "value": "BR" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Colombia", "value": "CO" }, { "label": "Congo", "value": "CG" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Estonia", "value": "EE" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Latvia", "value": "LV" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Malta", "value": "MT" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Montenegro", "value": "ME" }, { "label": "Morocco", "value": "MA" }, { "label": "Namibia", "value": "NA" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "San Marino", "value": "SM" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Singapore", "value": "SG" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "South Africa", "value": "ZA" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Zambia", "value": "ZM" } ], "default": "US", "description": "The recipient's bank country / region.", "example": "US", "label": "Bank country / region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.bank_details.bank_country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BF|BG|BH|BJ|BL|BO|BR|BW|BZ|CA|CF|CG|CH|CI|CL|CM|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FO|FR|GA|GB|GD|GE|GF|GG|GI|GL|GM|GQ|GR|GT|GW|GY|HK|HN|HR|HU|IC|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MK|MO|MQ|MR|MT|MU|MV|MW|MX|MY|NA|NC|NE|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PS|PT|PY|QA|RE|RO|RS|RW|SA|SC|SE|SG|SI|SK|SM|SN|SV|TD|TF|TG|TH|TJ|TL|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VG|VN|VU|WF|XK|YT|ZA|ZM" } }, { "enabled": true, "field": { "key": "account_currency", "options": [ { "label": "AED - UAE Dirham", "value": "AED" }, { "label": "AOA - Angolan Kwanza", "value": "AOA" }, { "label": "ARS - Argentine Peso", "value": "ARS" }, { "label": "AUD - Australian Dollar", "value": "AUD" }, { "label": "BDT - Bangladeshi Taka", "value": "BDT" }, { "label": "BGN - Bulgarian Lev", "value": "BGN" }, { "label": "BOB - Bolivian Boliviano", "value": "BOB" }, { "label": "BRL - Brazilian Real", "value": "BRL" }, { "label": "BWP - Botswanan Pula", "value": "BWP" }, { "label": "CAD - Canadian Dollar", "value": "CAD" }, { "label": "CHF - Swiss Franc", "value": "CHF" }, { "label": "CLP - Chilean Peso", "value": "CLP" }, { "label": "CNY - Chinese Yuan", "value": "CNY" }, { "label": "COP - Colombian Peso", "value": "COP" }, { "label": "CZK - Czech Koruna", "value": "CZK" }, { "label": "DKK - Danish Krone", "value": "DKK" }, { "label": "EGP - Egyptian Pound", "value": "EGP" }, { "label": "EUR - Euro", "value": "EUR" }, { "label": "GBP - Great Britain Pound", "value": "GBP" }, { "label": "GMD - Gambian Dalasi", "value": "GMD" }, { "label": "HKD - Hong Kong Dollar", "value": "HKD" }, { "label": "HUF - Hungarian Forint", "value": "HUF" }, { "label": "IDR - Indonesian Rupiah", "value": "IDR" }, { "label": "ILS - Israeli New Shekel", "value": "ILS" }, { "label": "INR - Indian Rupee", "value": "INR" }, { "label": "JPY - Japanese Yen", "value": "JPY" }, { "label": "KES - Kenyan Shilling", "value": "KES" }, { "label": "KRW - Korean Won", "value": "KRW" }, { "label": "LKR - Sri Lankan Rupee", "value": "LKR" }, { "label": "LSL - Lesotho Loti", "value": "LSL" }, { "label": "MAD - Moroccan Dirham", "value": "MAD" }, { "label": "MGA - Malagasy Ariary", "value": "MGA" }, { "label": "MWK - Malawian Kwacha", "value": "MWK" }, { "label": "MXN - Mexican Peso", "value": "MXN" }, { "label": "MYR - Malaysian Ringgit", "value": "MYR" }, { "label": "NAD - Namibian Dollar", "value": "NAD" }, { "label": "NGN - Nigerian Naira", "value": "NGN" }, { "label": "NOK - Norwegian Krone", "value": "NOK" }, { "label": "NPR - Nepalese Rupee", "value": "NPR" }, { "label": "NZD - New Zealand Dollar", "value": "NZD" }, { "label": "PEN - Peruvian Sol", "value": "PEN" }, { "label": "PHP - Philippine Peso", "value": "PHP" }, { "label": "PKR - Pakistani Rupee", "value": "PKR" }, { "label": "PLN - Polish Zloty", "value": "PLN" }, { "label": "PYG - Paraguayan Guarani", "value": "PYG" }, { "label": "RON - Romanian Leu", "value": "RON" }, { "label": "RWF - Rwandan Franc", "value": "RWF" }, { "label": "SAR - Saudi Riyal", "value": "SAR" }, { "label": "SEK - Swedish Krona", "value": "SEK" }, { "label": "SGD - Singapore Dollar", "value": "SGD" }, { "label": "THB - Thai Baht", "value": "THB" }, { "label": "TRY - Turkish Lira", "value": "TRY" }, { "label": "USD - United States Dollar", "value": "USD" }, { "label": "UYU - Uruguayan Peso", "value": "UYU" }, { "label": "VND - Vietnamese Dong", "value": "VND" }, { "label": "XAF - Central African CFA Franc", "value": "XAF" }, { "label": "XOF - West African CFA Franc", "value": "XOF" }, { "label": "ZAR - South African Rand", "value": "ZAR" }, { "label": "ZMW - Zambian Kwacha", "value": "ZMW" } ], "default": "USD", "description": "The recipient’s bank account currency.", "example": "USD", "label": "Account currency", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.bank_details.account_currency", "required": true, "rule": { "type": "string", "pattern": "AED|AOA|ARS|AUD|BDT|BGN|BOB|BRL|BWP|CAD|CHF|CLP|CNY|COP|CZK|DKK|EGP|EUR|GBP|GMD|HKD|HUF|IDR|ILS|INR|JPY|KES|KRW|LKR|LSL|MAD|MGA|MWK|MXN|MYR|NAD|NGN|NOK|NPR|NZD|PEN|PHP|PKR|PLN|PYG|RON|RWF|SAR|SEK|SGD|THB|TRY|USD|UYU|VND|XAF|XOF|ZAR|ZMW" } }, { "enabled": true, "field": { "key": "transfer_method", "options": [ { "description": "Domestic bank transfer in the destination country, which needs:\n• Account routing number (or SWIFT code)\n• Account number.", "label": "LOCAL", "value": "LOCAL" }, { "description": "International bank transfer, which needs:\n• SWIFT code\n• Account number.", "flight_time": { "max": "P1D", "min": "P0D" }, "label": "SWIFT", "transfer_limit": { "min": { "amount": 0, "currency": "USD" } }, "value": "SWIFT" } ], "default": "LOCAL", "description": "", "example": "LOCAL", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL|SWIFT" } }, { "enabled": true, "field": { "key": "local_clearing_system", "options": [ { "description": "Local bank transfer with maximum transfer limit, which needs:\n• ACH routing number\n• Account number.", "flight_time": { "max": "P2D", "min": "P0D" }, "label": "ACH", "transfer_limit": { "max": { "amount": 15000000, "currency": "USD" }, "min": { "amount": 0, "currency": "USD" } }, "value": "ACH" }, { "description": "Real-time bank transfer, which needs:\n• Fedwire ABA routing number\n• Account number.", "flight_time": { "max": "P1D", "min": "P0D" }, "label": "Fedwire", "transfer_limit": { "min": { "amount": 0, "currency": "USD" } }, "value": "FEDWIRE" }, { "description": "Transfer by issuing a paper check, which needs:\n• Recipient’s address\n• Recipient’s name.", "flight_time": { "max": "P6D", "min": "P2D" }, "label": "Paper Check", "transfer_limit": { "max": { "amount": 99999999.99, "currency": "USD" }, "min": { "amount": 0, "currency": "USD" } }, "value": "PAPER_CHECK" } ], "default": "ACH", "description": "", "example": "ACH", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "beneficiary.bank_details.local_clearing_system", "required": false, "rule": { "type": "string", "pattern": "ACH|FEDWIRE|PAPER_CHECK" } }, { "enabled": true, "field": { "key": "date_of_birth", "default": "", "description": "", "example": "2000-01-01", "label": "Date of birth", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.date_of_birth", "required": false, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "enabled": false, "field": { "key": "account_routing_type1", "default": "aba", "description": "", "example": "aba", "label": "Routing code type", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_routing_type1", "required": true, "rule": { "pattern": "^aba$", "type": "string" } }, { "enabled": true, "field": { "key": "account_routing_value1", "default": "", "description": "9-digit number to identify a bank in the US.", "example": "021000021", "label": "ACH routing number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_routing_value1", "required": true, "rule": { "pattern": "^[0-9]{9}$", "type": "string" } }, { "enabled": true, "field": { "key": "account_number", "default": "", "description": "", "example": "50001121", "label": "Account number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_number", "required": true, "rule": { "pattern": "^[0-9]{1,17}$", "type": "string" } }, { "enabled": true, "field": { "key": "account_name", "default": "", "description": "Enter the account holder's full name as registered with the bank.", "example": "John Walker", "label": "Account name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Congo", "value": "CG" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Libya", "value": "LY" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Swaziland", "value": "SZ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "US", "description": "", "example": "US", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HU|IC|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "postcode", "default": "", "description": "", "example": "98104", "label": "ZIP code", "placeholder": "", "refresh": true, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.postcode", "required": true, "rule": { "pattern": "^[0-9]{5}(?:-[0-9]{4})?$", "type": "string" } }, { "enabled": true, "field": { "key": "street_address", "default": "", "description": "Recipient's address (Should not be a PO or GPO box address).", "example": "412 5th Avenue", "label": "Address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "enabled": true, "field": { "key": "city", "default": "", "description": "", "example": "Seattle", "label": "City", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "enabled": true, "field": { "key": "state", "options": [ { "label": "Alabama", "value": "US-AL" }, { "label": "Alaska", "value": "US-AK" }, { "label": "American Samoa", "value": "US-AS" }, { "label": "Arizona", "value": "US-AZ" }, { "label": "Arkansas", "value": "US-AR" }, { "label": "California", "value": "US-CA" }, { "label": "Colorado", "value": "US-CO" }, { "label": "Connecticut", "value": "US-CT" }, { "label": "Delaware", "value": "US-DE" }, { "label": "District of Columbia", "value": "US-DC" }, { "label": "Florida", "value": "US-FL" }, { "label": "Georgia", "value": "US-GA" }, { "label": "Guam", "value": "US-GU" }, { "label": "Hawaii", "value": "US-HI" }, { "label": "Idaho", "value": "US-ID" }, { "label": "Illinois", "value": "US-IL" }, { "label": "Indiana", "value": "US-IN" }, { "label": "Iowa", "value": "US-IA" }, { "label": "Kansas", "value": "US-KS" }, { "label": "Kentucky", "value": "US-KY" }, { "label": "Louisiana", "value": "US-LA" }, { "label": "Maine", "value": "US-ME" }, { "label": "Maryland", "value": "US-MD" }, { "label": "Massachusetts", "value": "US-MA" }, { "label": "Michigan", "value": "US-MI" }, { "label": "Minnesota", "value": "US-MN" }, { "label": "Mississippi", "value": "US-MS" }, { "label": "Missouri", "value": "US-MO" }, { "label": "Montana", "value": "US-MT" }, { "label": "Nebraska", "value": "US-NE" }, { "label": "Nevada", "value": "US-NV" }, { "label": "New Hampshire", "value": "US-NH" }, { "label": "New Jersey", "value": "US-NJ" }, { "label": "New Mexico", "value": "US-NM" }, { "label": "New York", "value": "US-NY" }, { "label": "North Carolina", "value": "US-NC" }, { "label": "North Dakota", "value": "US-ND" }, { "label": "Northern Mariana Islands", "value": "US-MP" }, { "label": "Ohio", "value": "US-OH" }, { "label": "Oklahoma", "value": "US-OK" }, { "label": "Oregon", "value": "US-OR" }, { "label": "Pennsylvania", "value": "US-PA" }, { "label": "Puerto Rico", "value": "US-PR" }, { "label": "Rhode Island", "value": "US-RI" }, { "label": "South Carolina", "value": "US-SC" }, { "label": "South Dakota", "value": "US-SD" }, { "label": "Tennessee", "value": "US-TN" }, { "label": "Texas", "value": "US-TX" }, { "label": "United States Minor Outlying Islands", "value": "US-UM" }, { "label": "Utah", "value": "US-UT" }, { "label": "Vermont", "value": "US-VT" }, { "label": "Virgin Islands, U.S.", "value": "US-VI" }, { "label": "Virginia", "value": "US-VA" }, { "label": "Washington", "value": "US-WA" }, { "label": "West Virginia", "value": "US-WV" }, { "label": "Wisconsin", "value": "US-WI" }, { "label": "Wyoming", "value": "US-WY" } ], "default": "", "description": "", "example": "Washington", "label": "State", "placeholder": "", "refresh": false, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.state", "required": true, "rule": { "type": "string", "pattern": "US-AK|US-AL|US-AR|US-AS|US-AZ|US-CA|US-CO|US-CT|US-DC|US-DE|US-FL|US-GA|US-GU|US-HI|US-IA|US-ID|US-IL|US-IN|US-KS|US-KY|US-LA|US-MA|US-MD|US-ME|US-MI|US-MN|US-MO|US-MP|US-MS|US-MT|US-NC|US-ND|US-NE|US-NH|US-NJ|US-NM|US-NV|US-NY|US-OH|US-OK|US-OR|US-PA|US-PR|US-RI|US-SC|US-SD|US-TN|US-TX|US-UM|US-UT|US-VA|US-VI|US-VT|US-WA|US-WI|US-WV|US-WY" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For your reference only. Nicknames are only visible to you and will not be sent to the recipient.", "example": "Complete Concrete Pty Ltd", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false }, { "enabled": true, "field": { "key": "personal_email", "default": "", "description": "", "example": "john.walker@gmail.com", "label": "Email address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newRecipient" } }, "newDigitalRecipient": { "value": { "condition": { "provider": "AIRWALLEX", "entity_type": "PERSONAL", "type": "DIGITAL_WALLET" }, "fields": [ { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" } ], "default": "DIGITAL_WALLET", "description": "Beneficiary type.", "example": "DIGITAL_WALLET", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET" } }, { "enabled": false, "field": { "key": "transfer_method", "options": [ { "description": "", "label": "LOCAL", "value": "LOCAL" } ], "default": "LOCAL", "description": "Transfer methods.", "example": "", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "enabled": true, "field": { "key": "provider", "options": [ { "description": "Instant transfer to another Airwallex account, which needs:\n• Account number\n• Account name.", "flight_time": { "max": "P0D", "min": "P0D" }, "label": "AIRWALLEX", "value": "AIRWALLEX" } ], "default": "AIRWALLEX", "description": "Transfer method.", "example": "AIRWALLEX", "label": "Transfer method", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "beneficiary.digital_wallet.provider", "required": true, "rule": { "type": "string", "pattern": "AIRWALLEX" } }, { "enabled": false, "field": { "key": "id_type", "options": [ { "label": "Account number", "value": "account_number" } ], "default": "account_number", "description": "Account identifier type.", "example": "account_number", "label": "Account identifier type", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.digital_wallet.id_type", "required": true, "rule": { "type": "string", "pattern": "account_number" } }, { "enabled": true, "field": { "key": "id_value", "default": "", "description": "Account number.", "example": "1234567890123456", "label": "Account number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.digital_wallet.id_value", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,70}$" } }, { "enabled": true, "field": { "key": "account_name", "default": "", "description": "Account name.", "example": "John Wallker", "label": "Account name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.digital_wallet.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "Nickname", "example": "", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false } ], "key": "newDigitalRecipient" } }, "newCardRecipient": { "value": { "condition": { "type": "CARD" }, "fields": [ { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" }, { "label": "CARD", "value": "CARD" } ], "default": "CARD", "description": "", "example": "", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD" } }, { "enabled": false, "field": { "key": "transfer_method", "options": [ { "description": "", "label": "LOCAL", "value": "LOCAL" } ], "default": "LOCAL", "description": "", "example": "", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "enabled": true, "field": { "key": "token", "default": "", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component.", "example": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "label": "Tokenised card number", "placeholder": "1234 1234 1234 1234", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.token", "required": true }, { "enabled": true, "field": { "key": "expiry_year", "default": "", "description": "Expiry year.", "example": "2033", "label": "Expiry year", "placeholder": "YYYY", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.expiry_year", "required": true }, { "enabled": true, "field": { "key": "expiry_month", "default": "", "description": "Expiry month.", "example": "10", "label": "Expiry month", "placeholder": "MM", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.expiry_month", "required": true }, { "enabled": true, "field": { "key": "cardholder_name", "default": "", "description": "Cardholder name.", "example": "", "label": "Cardholder name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.cardholder_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Afghanistan", "value": "AF" }, { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Eswatini", "value": "SZ" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Haiti", "value": "HT" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See (Vatican City)", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Iraq", "value": "IQ" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Mali", "value": "ML" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Mozambique", "value": "MZ" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Republic of the Congo", "value": "CG" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "Somalia", "value": "SO" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "South Sudan", "value": "SS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sudan", "value": "SD" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "The Democratic Republic Of The Congo", "value": "CD" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Yemen", "value": "YE" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "NL", "description": "", "example": "AU", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "street_address", "default": "", "description": "Card billing address (should not be a PO or GPO box address).", "example": "", "label": "Street address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "enabled": true, "field": { "key": "city", "default": "", "description": "", "example": "Melbourne", "label": "City", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For reference only. Not sent to the recipient.", "example": "", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false }, { "enabled": true, "field": { "key": "personal_email", "default": "", "description": "", "example": "john.walker@google.com", "label": "Email address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newCardRecipient" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "newStablecoinWalletRecipient", "name": "Stablecoin wallet", "method": "POST", "uri": "/api/v1/beneficiary_form_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json", "x-api-version": "2026-06-30" }, "request_body": { "type": "STABLECOIN_WALLET", "entity_type": "PERSONAL" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "condition": { "entity_type": "PERSONAL", "type": "STABLECOIN_WALLET" }, "fields": [ { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Afghanistan", "value": "AF" }, { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Eswatini", "value": "SZ" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Haiti", "value": "HT" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See (Vatican City)", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Iraq", "value": "IQ" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Mali", "value": "ML" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Mozambique", "value": "MZ" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Republic of the Congo", "value": "CG" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "Somalia", "value": "SO" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "South Sudan", "value": "SS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sudan", "value": "SD" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "The Democratic Republic Of The Congo", "value": "CD" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Yemen", "value": "YE" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "", "description": "", "example": "AU", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "entity_type", "options": [ { "label": "Business", "value": "COMPANY" }, { "label": "Personal", "value": "PERSONAL" } ], "default": "PERSONAL", "description": "", "example": "PERSONAL", "label": "Type of account holder", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "enabled": true, "field": { "key": "first_name", "default": "", "description": "", "example": "John", "label": "First name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.first_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "last_name", "default": "", "description": "", "example": "Walker", "label": "Last name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.last_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "date_of_birth", "default": "", "description": "", "example": "2000-01-01", "label": "Date of birth", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.date_of_birth", "required": true, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "enabled": true, "field": { "key": "asset", "options": [ { "label": "USDC", "value": "USDC" } ], "default": "", "description": "", "example": "", "label": "Token symbol", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.stablecoin_wallet.asset", "required": true, "rule": { "type": "string", "pattern": "USDC" } }, { "enabled": true, "field": { "key": "network", "options": [ { "label": "ETHEREUM", "value": "ETHEREUM" } ], "default": "", "description": "", "example": "", "label": "Network", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.stablecoin_wallet.network", "required": true, "rule": { "type": "string", "pattern": "ETHEREUM" } }, { "enabled": true, "field": { "key": "address", "default": "", "description": "Address", "example": "", "label": "Address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.stablecoin_wallet.address", "required": true, "rule": { "type": "string", "pattern": "^(0x)?[0-9a-fA-F]{40}$" } }, { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" }, { "label": "STABLECOIN_WALLET", "value": "STABLECOIN_WALLET" } ], "default": "STABLECOIN_WALLET", "description": "", "example": "", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|STABLECOIN_WALLET" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For reference only. Not sent to the recipient.", "example": "John Walker", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false } ], "key": "newStablecoinWalletRecipient" } }, { "key": "default", "name": "Bank account", "method": "POST", "uri": "/api/v1/beneficiary_form_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "response_body": { "condition": { "bank_country_code": "US", "account_currency": "USD", "transfer_method": "LOCAL", "local_clearing_system": "ACH", "entity_type": "PERSONAL", "type": "BANK_ACCOUNT" }, "fields": [ { "enabled": true, "field": { "key": "entity_type", "options": [ { "label": "Business", "value": "COMPANY" }, { "label": "Personal", "value": "PERSONAL" } ], "default": "PERSONAL", "description": "", "example": "PERSONAL", "label": "Recipient account type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.entity_type", "required": true, "rule": { "type": "string", "pattern": "COMPANY|PERSONAL" } }, { "enabled": true, "field": { "key": "bank_country_code", "options": [ { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Brazil", "value": "BR" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Colombia", "value": "CO" }, { "label": "Congo", "value": "CG" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Estonia", "value": "EE" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Latvia", "value": "LV" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Malta", "value": "MT" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Montenegro", "value": "ME" }, { "label": "Morocco", "value": "MA" }, { "label": "Namibia", "value": "NA" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "San Marino", "value": "SM" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Singapore", "value": "SG" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "South Africa", "value": "ZA" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Zambia", "value": "ZM" } ], "default": "US", "description": "The recipient's bank country / region.", "example": "US", "label": "Bank country / region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.bank_details.bank_country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AR|AT|AU|AW|AZ|BA|BD|BE|BF|BG|BH|BJ|BL|BO|BR|BW|BZ|CA|CF|CG|CH|CI|CL|CM|CN|CO|CR|CW|CY|CZ|DE|DK|DM|DO|DZ|EC|EE|EG|ES|FI|FJ|FO|FR|GA|GB|GD|GE|GF|GG|GI|GL|GM|GQ|GR|GT|GW|GY|HK|HN|HR|HU|IC|ID|IE|IL|IM|IN|IS|IT|JE|JM|JO|JP|KE|KG|KH|KR|KW|KZ|LC|LI|LK|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MK|MO|MQ|MR|MT|MU|MV|MW|MX|MY|NA|NC|NE|NG|NL|NO|NP|NZ|OM|PA|PE|PF|PH|PK|PL|PM|PR|PS|PT|PY|QA|RE|RO|RS|RW|SA|SC|SE|SG|SI|SK|SM|SN|SV|TD|TF|TG|TH|TJ|TL|TN|TR|TW|TZ|UA|UG|US|UY|UZ|VG|VN|VU|WF|XK|YT|ZA|ZM" } }, { "enabled": true, "field": { "key": "account_currency", "options": [ { "label": "AED - UAE Dirham", "value": "AED" }, { "label": "AOA - Angolan Kwanza", "value": "AOA" }, { "label": "ARS - Argentine Peso", "value": "ARS" }, { "label": "AUD - Australian Dollar", "value": "AUD" }, { "label": "BDT - Bangladeshi Taka", "value": "BDT" }, { "label": "BGN - Bulgarian Lev", "value": "BGN" }, { "label": "BOB - Bolivian Boliviano", "value": "BOB" }, { "label": "BRL - Brazilian Real", "value": "BRL" }, { "label": "BWP - Botswanan Pula", "value": "BWP" }, { "label": "CAD - Canadian Dollar", "value": "CAD" }, { "label": "CHF - Swiss Franc", "value": "CHF" }, { "label": "CLP - Chilean Peso", "value": "CLP" }, { "label": "CNY - Chinese Yuan", "value": "CNY" }, { "label": "COP - Colombian Peso", "value": "COP" }, { "label": "CZK - Czech Koruna", "value": "CZK" }, { "label": "DKK - Danish Krone", "value": "DKK" }, { "label": "EGP - Egyptian Pound", "value": "EGP" }, { "label": "EUR - Euro", "value": "EUR" }, { "label": "GBP - Great Britain Pound", "value": "GBP" }, { "label": "GMD - Gambian Dalasi", "value": "GMD" }, { "label": "HKD - Hong Kong Dollar", "value": "HKD" }, { "label": "HUF - Hungarian Forint", "value": "HUF" }, { "label": "IDR - Indonesian Rupiah", "value": "IDR" }, { "label": "ILS - Israeli New Shekel", "value": "ILS" }, { "label": "INR - Indian Rupee", "value": "INR" }, { "label": "JPY - Japanese Yen", "value": "JPY" }, { "label": "KES - Kenyan Shilling", "value": "KES" }, { "label": "KRW - Korean Won", "value": "KRW" }, { "label": "LKR - Sri Lankan Rupee", "value": "LKR" }, { "label": "LSL - Lesotho Loti", "value": "LSL" }, { "label": "MAD - Moroccan Dirham", "value": "MAD" }, { "label": "MGA - Malagasy Ariary", "value": "MGA" }, { "label": "MWK - Malawian Kwacha", "value": "MWK" }, { "label": "MXN - Mexican Peso", "value": "MXN" }, { "label": "MYR - Malaysian Ringgit", "value": "MYR" }, { "label": "NAD - Namibian Dollar", "value": "NAD" }, { "label": "NGN - Nigerian Naira", "value": "NGN" }, { "label": "NOK - Norwegian Krone", "value": "NOK" }, { "label": "NPR - Nepalese Rupee", "value": "NPR" }, { "label": "NZD - New Zealand Dollar", "value": "NZD" }, { "label": "PEN - Peruvian Sol", "value": "PEN" }, { "label": "PHP - Philippine Peso", "value": "PHP" }, { "label": "PKR - Pakistani Rupee", "value": "PKR" }, { "label": "PLN - Polish Zloty", "value": "PLN" }, { "label": "PYG - Paraguayan Guarani", "value": "PYG" }, { "label": "RON - Romanian Leu", "value": "RON" }, { "label": "RWF - Rwandan Franc", "value": "RWF" }, { "label": "SAR - Saudi Riyal", "value": "SAR" }, { "label": "SEK - Swedish Krona", "value": "SEK" }, { "label": "SGD - Singapore Dollar", "value": "SGD" }, { "label": "THB - Thai Baht", "value": "THB" }, { "label": "TRY - Turkish Lira", "value": "TRY" }, { "label": "USD - United States Dollar", "value": "USD" }, { "label": "UYU - Uruguayan Peso", "value": "UYU" }, { "label": "VND - Vietnamese Dong", "value": "VND" }, { "label": "XAF - Central African CFA Franc", "value": "XAF" }, { "label": "XOF - West African CFA Franc", "value": "XOF" }, { "label": "ZAR - South African Rand", "value": "ZAR" }, { "label": "ZMW - Zambian Kwacha", "value": "ZMW" } ], "default": "USD", "description": "The recipient’s bank account currency.", "example": "USD", "label": "Account currency", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.bank_details.account_currency", "required": true, "rule": { "type": "string", "pattern": "AED|AOA|ARS|AUD|BDT|BGN|BOB|BRL|BWP|CAD|CHF|CLP|CNY|COP|CZK|DKK|EGP|EUR|GBP|GMD|HKD|HUF|IDR|ILS|INR|JPY|KES|KRW|LKR|LSL|MAD|MGA|MWK|MXN|MYR|NAD|NGN|NOK|NPR|NZD|PEN|PHP|PKR|PLN|PYG|RON|RWF|SAR|SEK|SGD|THB|TRY|USD|UYU|VND|XAF|XOF|ZAR|ZMW" } }, { "enabled": true, "field": { "key": "transfer_method", "options": [ { "description": "Domestic bank transfer in the destination country, which needs:\n• Account routing number (or SWIFT code)\n• Account number.", "label": "LOCAL", "value": "LOCAL" }, { "description": "International bank transfer, which needs:\n• SWIFT code\n• Account number.", "flight_time": { "max": "P1D", "min": "P0D" }, "label": "SWIFT", "transfer_limit": { "min": { "amount": 0, "currency": "USD" } }, "value": "SWIFT" } ], "default": "LOCAL", "description": "", "example": "LOCAL", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL|SWIFT" } }, { "enabled": true, "field": { "key": "local_clearing_system", "options": [ { "description": "Local bank transfer with maximum transfer limit, which needs:\n• ACH routing number\n• Account number.", "flight_time": { "max": "P2D", "min": "P0D" }, "label": "ACH", "transfer_limit": { "max": { "amount": 15000000, "currency": "USD" }, "min": { "amount": 0, "currency": "USD" } }, "value": "ACH" }, { "description": "Real-time bank transfer, which needs:\n• Fedwire ABA routing number\n• Account number.", "flight_time": { "max": "P1D", "min": "P0D" }, "label": "Fedwire", "transfer_limit": { "min": { "amount": 0, "currency": "USD" } }, "value": "FEDWIRE" }, { "description": "Transfer by issuing a paper check, which needs:\n• Recipient’s address\n• Recipient’s name.", "flight_time": { "max": "P6D", "min": "P2D" }, "label": "Paper Check", "transfer_limit": { "max": { "amount": 99999999.99, "currency": "USD" }, "min": { "amount": 0, "currency": "USD" } }, "value": "PAPER_CHECK" } ], "default": "ACH", "description": "", "example": "ACH", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "beneficiary.bank_details.local_clearing_system", "required": false, "rule": { "type": "string", "pattern": "ACH|FEDWIRE|PAPER_CHECK" } }, { "enabled": true, "field": { "key": "date_of_birth", "default": "", "description": "", "example": "2000-01-01", "label": "Date of birth", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.date_of_birth", "required": false, "rule": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "enabled": false, "field": { "key": "account_routing_type1", "default": "aba", "description": "", "example": "aba", "label": "Routing code type", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_routing_type1", "required": true, "rule": { "pattern": "^aba$", "type": "string" } }, { "enabled": true, "field": { "key": "account_routing_value1", "default": "", "description": "9-digit number to identify a bank in the US.", "example": "021000021", "label": "ACH routing number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_routing_value1", "required": true, "rule": { "pattern": "^[0-9]{9}$", "type": "string" } }, { "enabled": true, "field": { "key": "account_number", "default": "", "description": "", "example": "50001121", "label": "Account number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_number", "required": true, "rule": { "pattern": "^[0-9]{1,17}$", "type": "string" } }, { "enabled": true, "field": { "key": "account_name", "default": "", "description": "Enter the account holder's full name as registered with the bank.", "example": "John Walker", "label": "Account name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.bank_details.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Congo", "value": "CG" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Libya", "value": "LY" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Swaziland", "value": "SZ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "US", "description": "", "example": "US", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HU|IC|ID|IE|IL|IM|IN|IO|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MF|MG|MH|MK|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SR|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "postcode", "default": "", "description": "", "example": "98104", "label": "ZIP code", "placeholder": "", "refresh": true, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.postcode", "required": true, "rule": { "pattern": "^[0-9]{5}(?:-[0-9]{4})?$", "type": "string" } }, { "enabled": true, "field": { "key": "street_address", "default": "", "description": "Recipient's address (Should not be a PO or GPO box address).", "example": "412 5th Avenue", "label": "Address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "enabled": true, "field": { "key": "city", "default": "", "description": "", "example": "Seattle", "label": "City", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "enabled": true, "field": { "key": "state", "options": [ { "label": "Alabama", "value": "US-AL" }, { "label": "Alaska", "value": "US-AK" }, { "label": "American Samoa", "value": "US-AS" }, { "label": "Arizona", "value": "US-AZ" }, { "label": "Arkansas", "value": "US-AR" }, { "label": "California", "value": "US-CA" }, { "label": "Colorado", "value": "US-CO" }, { "label": "Connecticut", "value": "US-CT" }, { "label": "Delaware", "value": "US-DE" }, { "label": "District of Columbia", "value": "US-DC" }, { "label": "Florida", "value": "US-FL" }, { "label": "Georgia", "value": "US-GA" }, { "label": "Guam", "value": "US-GU" }, { "label": "Hawaii", "value": "US-HI" }, { "label": "Idaho", "value": "US-ID" }, { "label": "Illinois", "value": "US-IL" }, { "label": "Indiana", "value": "US-IN" }, { "label": "Iowa", "value": "US-IA" }, { "label": "Kansas", "value": "US-KS" }, { "label": "Kentucky", "value": "US-KY" }, { "label": "Louisiana", "value": "US-LA" }, { "label": "Maine", "value": "US-ME" }, { "label": "Maryland", "value": "US-MD" }, { "label": "Massachusetts", "value": "US-MA" }, { "label": "Michigan", "value": "US-MI" }, { "label": "Minnesota", "value": "US-MN" }, { "label": "Mississippi", "value": "US-MS" }, { "label": "Missouri", "value": "US-MO" }, { "label": "Montana", "value": "US-MT" }, { "label": "Nebraska", "value": "US-NE" }, { "label": "Nevada", "value": "US-NV" }, { "label": "New Hampshire", "value": "US-NH" }, { "label": "New Jersey", "value": "US-NJ" }, { "label": "New Mexico", "value": "US-NM" }, { "label": "New York", "value": "US-NY" }, { "label": "North Carolina", "value": "US-NC" }, { "label": "North Dakota", "value": "US-ND" }, { "label": "Northern Mariana Islands", "value": "US-MP" }, { "label": "Ohio", "value": "US-OH" }, { "label": "Oklahoma", "value": "US-OK" }, { "label": "Oregon", "value": "US-OR" }, { "label": "Pennsylvania", "value": "US-PA" }, { "label": "Puerto Rico", "value": "US-PR" }, { "label": "Rhode Island", "value": "US-RI" }, { "label": "South Carolina", "value": "US-SC" }, { "label": "South Dakota", "value": "US-SD" }, { "label": "Tennessee", "value": "US-TN" }, { "label": "Texas", "value": "US-TX" }, { "label": "United States Minor Outlying Islands", "value": "US-UM" }, { "label": "Utah", "value": "US-UT" }, { "label": "Vermont", "value": "US-VT" }, { "label": "Virgin Islands, U.S.", "value": "US-VI" }, { "label": "Virginia", "value": "US-VA" }, { "label": "Washington", "value": "US-WA" }, { "label": "West Virginia", "value": "US-WV" }, { "label": "Wisconsin", "value": "US-WI" }, { "label": "Wyoming", "value": "US-WY" } ], "default": "", "description": "", "example": "Washington", "label": "State", "placeholder": "", "refresh": false, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.state", "required": true, "rule": { "type": "string", "pattern": "US-AK|US-AL|US-AR|US-AS|US-AZ|US-CA|US-CO|US-CT|US-DC|US-DE|US-FL|US-GA|US-GU|US-HI|US-IA|US-ID|US-IL|US-IN|US-KS|US-KY|US-LA|US-MA|US-MD|US-ME|US-MI|US-MN|US-MO|US-MP|US-MS|US-MT|US-NC|US-ND|US-NE|US-NH|US-NJ|US-NM|US-NV|US-NY|US-OH|US-OK|US-OR|US-PA|US-PR|US-RI|US-SC|US-SD|US-TN|US-TX|US-UM|US-UT|US-VA|US-VI|US-VT|US-WA|US-WI|US-WV|US-WY" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For your reference only. Nicknames are only visible to you and will not be sent to the recipient.", "example": "Complete Concrete Pty Ltd", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false }, { "enabled": true, "field": { "key": "personal_email", "default": "", "description": "", "example": "john.walker@gmail.com", "label": "Email address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newRecipient" } }, { "key": "newDigitalRecipient", "name": "Digital wallet", "method": "POST", "uri": "/api/v1/beneficiary_form_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "DIGITAL_WALLET", "entity_type": "PERSONAL", "provider": "AIRWALLEX" }, "response_body": { "condition": { "provider": "AIRWALLEX", "entity_type": "PERSONAL", "type": "DIGITAL_WALLET" }, "fields": [ { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" } ], "default": "DIGITAL_WALLET", "description": "Beneficiary type.", "example": "DIGITAL_WALLET", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET" } }, { "enabled": false, "field": { "key": "transfer_method", "options": [ { "description": "", "label": "LOCAL", "value": "LOCAL" } ], "default": "LOCAL", "description": "Transfer methods.", "example": "", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "enabled": true, "field": { "key": "provider", "options": [ { "description": "Instant transfer to another Airwallex account, which needs:\n• Account number\n• Account name.", "flight_time": { "max": "P0D", "min": "P0D" }, "label": "AIRWALLEX", "value": "AIRWALLEX" } ], "default": "AIRWALLEX", "description": "Transfer method.", "example": "AIRWALLEX", "label": "Transfer method", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "beneficiary.digital_wallet.provider", "required": true, "rule": { "type": "string", "pattern": "AIRWALLEX" } }, { "enabled": false, "field": { "key": "id_type", "options": [ { "label": "Account number", "value": "account_number" } ], "default": "account_number", "description": "Account identifier type.", "example": "account_number", "label": "Account identifier type", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.digital_wallet.id_type", "required": true, "rule": { "type": "string", "pattern": "account_number" } }, { "enabled": true, "field": { "key": "id_value", "default": "", "description": "Account number.", "example": "1234567890123456", "label": "Account number", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.digital_wallet.id_value", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,70}$" } }, { "enabled": true, "field": { "key": "account_name", "default": "", "description": "Account name.", "example": "John Wallker", "label": "Account name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.digital_wallet.account_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,100}$" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "Nickname", "example": "", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false } ], "key": "newDigitalRecipient" } }, { "key": "newCardRecipient", "name": "Card", "method": "POST", "uri": "/api/v1/beneficiary_form_schemas/generate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "type": "CARD" }, "response_body": { "condition": { "type": "CARD" }, "fields": [ { "enabled": false, "field": { "key": "type", "options": [ { "label": "BANK_ACCOUNT", "value": "BANK_ACCOUNT" }, { "label": "DIGITAL_WALLET", "value": "DIGITAL_WALLET" }, { "label": "CARD", "value": "CARD" } ], "default": "CARD", "description": "", "example": "", "label": "Beneficiary type", "placeholder": "", "refresh": true, "tip": "", "type": "RADIO" }, "path": "beneficiary.type", "required": true, "rule": { "type": "string", "pattern": "BANK_ACCOUNT|DIGITAL_WALLET|CARD" } }, { "enabled": false, "field": { "key": "transfer_method", "options": [ { "description": "", "label": "LOCAL", "value": "LOCAL" } ], "default": "LOCAL", "description": "", "example": "", "label": "Transfer methods", "placeholder": "", "refresh": true, "tip": "", "type": "TRANSFER_METHOD" }, "path": "transfer_method", "required": true, "rule": { "type": "string", "pattern": "LOCAL" } }, { "enabled": true, "field": { "key": "token", "default": "", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component.", "example": "AKvN4TqxI04SNFZ+oYRXaECtDA==", "label": "Tokenised card number", "placeholder": "1234 1234 1234 1234", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.token", "required": true }, { "enabled": true, "field": { "key": "expiry_year", "default": "", "description": "Expiry year.", "example": "2033", "label": "Expiry year", "placeholder": "YYYY", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.expiry_year", "required": true }, { "enabled": true, "field": { "key": "expiry_month", "default": "", "description": "Expiry month.", "example": "10", "label": "Expiry month", "placeholder": "MM", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.expiry_month", "required": true }, { "enabled": true, "field": { "key": "cardholder_name", "default": "", "description": "Cardholder name.", "example": "", "label": "Cardholder name", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.card.cardholder_name", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{2,200}$" } }, { "enabled": true, "field": { "key": "country_code", "options": [ { "label": "Afghanistan", "value": "AF" }, { "label": "Albania", "value": "AL" }, { "label": "Algeria", "value": "DZ" }, { "label": "American Samoa", "value": "AS" }, { "label": "Andorra", "value": "AD" }, { "label": "Angola", "value": "AO" }, { "label": "Anguilla", "value": "AI" }, { "label": "Antarctica", "value": "AQ" }, { "label": "Antigua and Barbuda", "value": "AG" }, { "label": "Argentina", "value": "AR" }, { "label": "Armenia", "value": "AM" }, { "label": "Aruba", "value": "AW" }, { "label": "Australia", "value": "AU" }, { "label": "Austria", "value": "AT" }, { "label": "Azerbaijan", "value": "AZ" }, { "label": "Bahamas", "value": "BS" }, { "label": "Bahrain", "value": "BH" }, { "label": "Bangladesh", "value": "BD" }, { "label": "Barbados", "value": "BB" }, { "label": "Belgium", "value": "BE" }, { "label": "Belize", "value": "BZ" }, { "label": "Benin", "value": "BJ" }, { "label": "Bermuda", "value": "BM" }, { "label": "Bhutan", "value": "BT" }, { "label": "Bolivia (Plurinational State of)", "value": "BO" }, { "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }, { "label": "Bosnia and Herzegovina", "value": "BA" }, { "label": "Botswana", "value": "BW" }, { "label": "Bouvet Island", "value": "BV" }, { "label": "Brazil", "value": "BR" }, { "label": "British Indian Ocean Territory", "value": "IO" }, { "label": "Brunei Darussalam", "value": "BN" }, { "label": "Bulgaria", "value": "BG" }, { "label": "Burkina Faso", "value": "BF" }, { "label": "Burundi", "value": "BI" }, { "label": "Cabo Verde", "value": "CV" }, { "label": "Cambodia", "value": "KH" }, { "label": "Cameroon", "value": "CM" }, { "label": "Canada", "value": "CA" }, { "label": "Canary Islands", "value": "IC" }, { "label": "Cayman Islands", "value": "KY" }, { "label": "Central African Republic", "value": "CF" }, { "label": "Chad", "value": "TD" }, { "label": "Chile", "value": "CL" }, { "label": "China", "value": "CN" }, { "label": "Christmas Island", "value": "CX" }, { "label": "Cocos (Keeling) Islands", "value": "CC" }, { "label": "Colombia", "value": "CO" }, { "label": "Comoros", "value": "KM" }, { "label": "Cook Islands", "value": "CK" }, { "label": "Costa Rica", "value": "CR" }, { "label": "Croatia", "value": "HR" }, { "label": "Curaçao", "value": "CW" }, { "label": "Cyprus", "value": "CY" }, { "label": "Czech Republic", "value": "CZ" }, { "label": "Côte d'Ivoire", "value": "CI" }, { "label": "Denmark", "value": "DK" }, { "label": "Djibouti", "value": "DJ" }, { "label": "Dominica", "value": "DM" }, { "label": "Dominican Republic", "value": "DO" }, { "label": "Ecuador", "value": "EC" }, { "label": "Egypt", "value": "EG" }, { "label": "El Salvador", "value": "SV" }, { "label": "Equatorial Guinea", "value": "GQ" }, { "label": "Eritrea", "value": "ER" }, { "label": "Estonia", "value": "EE" }, { "label": "Eswatini", "value": "SZ" }, { "label": "Ethiopia", "value": "ET" }, { "label": "Falkland Islands (Malvinas)", "value": "FK" }, { "label": "Faroe Islands", "value": "FO" }, { "label": "Fiji", "value": "FJ" }, { "label": "Finland", "value": "FI" }, { "label": "France", "value": "FR" }, { "label": "French Guiana", "value": "GF" }, { "label": "French Polynesia", "value": "PF" }, { "label": "French Southern Territories", "value": "TF" }, { "label": "Gabon", "value": "GA" }, { "label": "Gambia", "value": "GM" }, { "label": "Georgia", "value": "GE" }, { "label": "Germany", "value": "DE" }, { "label": "Ghana", "value": "GH" }, { "label": "Gibraltar", "value": "GI" }, { "label": "Greece", "value": "GR" }, { "label": "Greenland", "value": "GL" }, { "label": "Grenada", "value": "GD" }, { "label": "Guadeloupe", "value": "GP" }, { "label": "Guam", "value": "GU" }, { "label": "Guatemala", "value": "GT" }, { "label": "Guernsey", "value": "GG" }, { "label": "Guinea", "value": "GN" }, { "label": "Guinea Bissau", "value": "GW" }, { "label": "Guyana", "value": "GY" }, { "label": "Haiti", "value": "HT" }, { "label": "Heard Island and McDonald Islands", "value": "HM" }, { "label": "Holy See (Vatican City)", "value": "VA" }, { "label": "Honduras", "value": "HN" }, { "label": "Hong Kong (China)", "value": "HK" }, { "label": "Hungary", "value": "HU" }, { "label": "Iceland", "value": "IS" }, { "label": "India", "value": "IN" }, { "label": "Indonesia", "value": "ID" }, { "label": "Iraq", "value": "IQ" }, { "label": "Ireland", "value": "IE" }, { "label": "Isle of Man", "value": "IM" }, { "label": "Israel", "value": "IL" }, { "label": "Italy", "value": "IT" }, { "label": "Jamaica", "value": "JM" }, { "label": "Japan", "value": "JP" }, { "label": "Jersey", "value": "JE" }, { "label": "Jordan", "value": "JO" }, { "label": "Kazakhstan", "value": "KZ" }, { "label": "Kenya", "value": "KE" }, { "label": "Kiribati", "value": "KI" }, { "label": "Korea, Republic of", "value": "KR" }, { "label": "Kosovo", "value": "XK" }, { "label": "Kuwait", "value": "KW" }, { "label": "Kyrgyzstan", "value": "KG" }, { "label": "Lao People's Democratic Republic", "value": "LA" }, { "label": "Latvia", "value": "LV" }, { "label": "Lebanon", "value": "LB" }, { "label": "Lesotho", "value": "LS" }, { "label": "Liberia", "value": "LR" }, { "label": "Liechtenstein", "value": "LI" }, { "label": "Lithuania", "value": "LT" }, { "label": "Luxembourg", "value": "LU" }, { "label": "Macao (China)", "value": "MO" }, { "label": "Macedonia, the former Yugoslav Republic of", "value": "MK" }, { "label": "Madagascar", "value": "MG" }, { "label": "Malawi", "value": "MW" }, { "label": "Malaysia", "value": "MY" }, { "label": "Maldives", "value": "MV" }, { "label": "Mali", "value": "ML" }, { "label": "Malta", "value": "MT" }, { "label": "Marshall Islands", "value": "MH" }, { "label": "Martinique", "value": "MQ" }, { "label": "Mauritania", "value": "MR" }, { "label": "Mauritius", "value": "MU" }, { "label": "Mayotte", "value": "YT" }, { "label": "Mexico", "value": "MX" }, { "label": "Micronesia", "value": "FM" }, { "label": "Moldova", "value": "MD" }, { "label": "Monaco", "value": "MC" }, { "label": "Mongolia", "value": "MN" }, { "label": "Montenegro", "value": "ME" }, { "label": "Montserrat", "value": "MS" }, { "label": "Morocco", "value": "MA" }, { "label": "Mozambique", "value": "MZ" }, { "label": "Namibia", "value": "NA" }, { "label": "Nauru", "value": "NR" }, { "label": "Nepal", "value": "NP" }, { "label": "Netherlands", "value": "NL" }, { "label": "Netherlands Antilles", "value": "AN" }, { "label": "New Caledonia", "value": "NC" }, { "label": "New Zealand", "value": "NZ" }, { "label": "Nicaragua", "value": "NI" }, { "label": "Niger", "value": "NE" }, { "label": "Nigeria", "value": "NG" }, { "label": "Niue", "value": "NU" }, { "label": "Norfolk Island", "value": "NF" }, { "label": "Northern Mariana Islands", "value": "MP" }, { "label": "Norway", "value": "NO" }, { "label": "Oman", "value": "OM" }, { "label": "Pakistan", "value": "PK" }, { "label": "Palau", "value": "PW" }, { "label": "Palestine, State of", "value": "PS" }, { "label": "Panama", "value": "PA" }, { "label": "Papua New Guinea", "value": "PG" }, { "label": "Paraguay", "value": "PY" }, { "label": "Peru", "value": "PE" }, { "label": "Philippines", "value": "PH" }, { "label": "Pitcairn", "value": "PN" }, { "label": "Poland", "value": "PL" }, { "label": "Portugal", "value": "PT" }, { "label": "Puerto Rico", "value": "PR" }, { "label": "Qatar", "value": "QA" }, { "label": "Republic of the Congo", "value": "CG" }, { "label": "Romania", "value": "RO" }, { "label": "Rwanda", "value": "RW" }, { "label": "Réunion", "value": "RE" }, { "label": "Saint Barthélemy", "value": "BL" }, { "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }, { "label": "Saint Kitts and Nevis", "value": "KN" }, { "label": "Saint Lucia", "value": "LC" }, { "label": "Saint Martin (French part)", "value": "MF" }, { "label": "Saint Pierre and Miquelon", "value": "PM" }, { "label": "Saint Vincent and the Grenadines", "value": "VC" }, { "label": "Samoa", "value": "WS" }, { "label": "San Marino", "value": "SM" }, { "label": "Sao Tome and Principe", "value": "ST" }, { "label": "Saudi Arabia", "value": "SA" }, { "label": "Senegal", "value": "SN" }, { "label": "Serbia", "value": "RS" }, { "label": "Seychelles", "value": "SC" }, { "label": "Sierra Leone", "value": "SL" }, { "label": "Singapore", "value": "SG" }, { "label": "Sint Maarten (Dutch part)", "value": "SX" }, { "label": "Slovakia", "value": "SK" }, { "label": "Slovenia", "value": "SI" }, { "label": "Solomon Islands", "value": "SB" }, { "label": "Somalia", "value": "SO" }, { "label": "South Africa", "value": "ZA" }, { "label": "South Georgia and the South Sandwich Islands", "value": "GS" }, { "label": "South Sudan", "value": "SS" }, { "label": "Spain", "value": "ES" }, { "label": "Sri Lanka", "value": "LK" }, { "label": "Sudan", "value": "SD" }, { "label": "Suriname", "value": "SR" }, { "label": "Svalbard and Jan Mayen", "value": "SJ" }, { "label": "Sweden", "value": "SE" }, { "label": "Switzerland", "value": "CH" }, { "label": "Taiwan (China)", "value": "TW" }, { "label": "Tajikistan", "value": "TJ" }, { "label": "Tanzania, United Republic of", "value": "TZ" }, { "label": "Thailand", "value": "TH" }, { "label": "The Democratic Republic Of The Congo", "value": "CD" }, { "label": "Timor-Leste", "value": "TL" }, { "label": "Togo", "value": "TG" }, { "label": "Tokelau", "value": "TK" }, { "label": "Tonga", "value": "TO" }, { "label": "Trinidad and Tobago", "value": "TT" }, { "label": "Tunisia", "value": "TN" }, { "label": "Turkey", "value": "TR" }, { "label": "Turkmenistan", "value": "TM" }, { "label": "Turks and Caicos Islands", "value": "TC" }, { "label": "Tuvalu", "value": "TV" }, { "label": "Uganda", "value": "UG" }, { "label": "Ukraine", "value": "UA" }, { "label": "United Arab Emirates", "value": "AE" }, { "label": "United Kingdom", "value": "GB" }, { "label": "United States Minor Outlying Islands", "value": "UM" }, { "label": "United States of America", "value": "US" }, { "label": "Uruguay", "value": "UY" }, { "label": "Uzbekistan", "value": "UZ" }, { "label": "Vanuatu", "value": "VU" }, { "label": "Viet Nam", "value": "VN" }, { "label": "Virgin Islands (British)", "value": "VG" }, { "label": "Virgin Islands (U.S.)", "value": "VI" }, { "label": "Wallis and Futuna", "value": "WF" }, { "label": "Western Sahara", "value": "EH" }, { "label": "Yemen", "value": "YE" }, { "label": "Zambia", "value": "ZM" }, { "label": "Zimbabwe", "value": "ZW" }, { "label": "Åland Islands", "value": "AX" } ], "default": "NL", "description": "", "example": "AU", "label": "Country or region", "placeholder": "", "refresh": true, "tip": "", "type": "SELECT" }, "path": "beneficiary.address.country_code", "required": true, "rule": { "type": "string", "pattern": "AD|AE|AF|AG|AI|AL|AM|AN|AO|AQ|AR|AS|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BJ|BL|BM|BN|BO|BQ|BR|BS|BT|BV|BW|BZ|CA|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|CR|CV|CW|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EE|EG|EH|ER|ES|ET|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|IC|ID|IE|IL|IM|IN|IO|IQ|IS|IT|JE|JM|JO|JP|KE|KG|KH|KI|KM|KN|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|MA|MC|MD|ME|MF|MG|MH|MK|ML|MN|MO|MP|MQ|MR|MS|MT|MU|MV|MW|MX|MY|MZ|NA|NC|NE|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PS|PT|PW|PY|QA|RE|RO|RS|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|SS|ST|SV|SX|SZ|TC|TD|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TR|TT|TV|TW|TZ|UA|UG|UM|US|UY|UZ|VA|VC|VG|VI|VN|VU|WF|WS|XK|YE|YT|ZA|ZM|ZW" } }, { "enabled": true, "field": { "key": "street_address", "default": "", "description": "Card billing address (should not be a PO or GPO box address).", "example": "", "label": "Street address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.street_address", "required": true, "rule": { "type": "string", "pattern": "(^(?!\\d+$))^[\\s\\S]{5,200}$" } }, { "enabled": true, "field": { "key": "city", "default": "", "description": "", "example": "Melbourne", "label": "City", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.address.city", "required": true, "rule": { "type": "string", "pattern": "^[\\s\\S]{1,50}$" } }, { "enabled": true, "field": { "key": "nickname", "default": "", "description": "For reference only. Not sent to the recipient.", "example": "", "label": "Nickname", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "nickname", "required": false }, { "enabled": true, "field": { "key": "personal_email", "default": "", "description": "", "example": "john.walker@google.com", "label": "Email address", "placeholder": "", "refresh": false, "tip": "", "type": "INPUT" }, "path": "beneficiary.additional_info.personal_email", "required": false, "rule": { "type": "string", "pattern": "^(\\S+@\\S+)$" } } ], "key": "newCardRecipient" } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries": { "get": { "tags": [ "Payouts > Beneficiaries" ], "summary": "3|List all Beneficiaries", "description": "Get list of beneficiaries with optional filters on from date/time, to date/time, names and entity type. Results are paginated, with default list limit of 50 results.", "operationId": "listBeneficiaries", "parameters": [ { "name": "bank_account_number", "in": "query", "description": "Filter on bank account number of beneficiary.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "company_name", "in": "query", "description": "Filter on company name of beneficiary.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "Swift concrete services" } }, { "name": "entity_type", "in": "query", "description": "Filter on entity type of COMPANY or PERSONAL.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "COMPANY" } }, { "name": "from_date", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time", "default": "2017-04-01" } }, { "name": "name", "in": "query", "description": "Filter on name of beneficiary.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "Adam" } }, { "name": "nick_name", "in": "query", "description": "Filter on nickname of beneficiary.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "sca_exemptible", "in": "query", "description": "Filter on SCA exemptible beneficiaries.", "required": false, "allowEmptyValue": false, "schema": { "type": "boolean", "default": false } }, { "name": "to_date", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time", "default": "2030-01-01T00:00:00+0000" } }, { "name": "type", "in": "query", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds, i.e., BANK_ACCOUNT, DIGITAL_WALLET, CARD, STABLECOIN_WALLET.", "required": false, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" }, "default": "BANK_ACCOUNT" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/BeneficiaryContact" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/beneficiaries", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } ] } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiary_form_schemas/supported_financial_institutions": { "get": { "tags": [ "Payouts > Beneficiaries" ], "summary": "11|List all Supported Financial Institutions", "description": "Retrieve an array of Airwallex’s supported financial institutions for beneficiaries, which can be used to build your own interface. Specify the beneficiaries' attributes in your request, and use keyword to search and narrow down your results.", "operationId": "listSupportedFinancialInstitutions", "parameters": [ { "name": "account_currency", "in": "query", "description": "Account currency (3-letter ISO 4217 currency code).", "required": true, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "bank_country_code", "in": "query", "description": "Bank country code (2-letter ISO 3166-2 country code).", "required": true, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "bank_identifier", "in": "query", "description": "A valid bank code. When specified, this bank’s branches will be returned instead of a list of banks. Note that this is available only in regions where branch-level information is supported.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "description": "Entity type of the beneficiary, i.e., COMPANY, PERSONAL.", "required": true, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "A substring to filter the financial institutions with. When a keyword is specified, financial institutions will only be returned in the response if this substring is contained in their label (bank name) or value (bank code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "local_clearing_system", "in": "query", "description": "Local clearing systems are available for selection when making local transfers to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value. To learn more, please visit: https://www.airwallex.com/guides/payout.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "transfer_method", "in": "query", "description": "Transfer method, i.e., SWIFT, LOCAL.", "required": true, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialInstitution" }, "examples": { "default": { "value": { "items": [ { "label": "Bank of America, NA", "value": "021202162" }, { "label": "PNC Bank National Association", "value": "021202191" }, { "label": "PNC Bank National Association", "value": "021202311" }, { "label": "JPMorgan Chase Bank, NA", "value": "021202337" }, { "label": "PNC Bank National Association", "value": "021202447" }, { "label": "Bank of America, NA", "value": "021202609" }, { "label": "JPMorgan Chase Bank, NA", "value": "021202719" } ], "truncated": false } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/beneficiary_form_schemas/supported_financial_institutions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "label": "Bank of America, NA", "value": "021202162" }, { "label": "PNC Bank National Association", "value": "021202191" }, { "label": "PNC Bank National Association", "value": "021202311" }, { "label": "JPMorgan Chase Bank, NA", "value": "021202337" }, { "label": "PNC Bank National Association", "value": "021202447" }, { "label": "Bank of America, NA", "value": "021202609" }, { "label": "JPMorgan Chase Bank, NA", "value": "021202719" } ], "truncated": false } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/{id}": { "get": { "tags": [ "Payouts > Beneficiaries" ], "summary": "2|Retrieve a Beneficiary", "description": "Get a specific beneficiary by specifying the Airwallex `id`.", "operationId": "retrieveBeneficiary", "parameters": [ { "name": "id", "in": "path", "description": "id of the beneficiary contact to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "8365ea88-2946-4877-abe1-e02a1015288d" }, "examples": { "default": { "value": "beneficiarie_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryContact" }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/beneficiaries/beneficiarie_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/{id}/update": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "4|Update an Existing Beneficiary", "description": "Edit an existing beneficiary stored on the Airwallex platform.", "operationId": "updateBeneficiary", "parameters": [ { "name": "id", "in": "path", "description": "id of the beneficiary contact to update.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "8365ea88-2946-4877-abe1-e02a1015288d" }, "examples": { "default": { "value": "beneficiarie_id" }, "validation_failed": { "value": "{id}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "beneficiary", "transfer_methods" ], "properties": { "beneficiary": { "type": "object", "description": "Details of the beneficiary.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "stablecoin_wallet": { "type": "object", "required": [ "asset", "network", "address" ], "properties": { "asset": { "type": "string", "description": "Stablecoin asset type, e.g., `USDC`." }, "network": { "type": "string", "description": "Blockchain network, e.g., `ETHEREUM`." }, "address": { "type": "string", "description": "Blockchain wallet address of the beneficiary. Sending stablecoins to an incorrect wallet address or unsupported network will result in the irreversible loss of funds. Always verify the recipient wallet address and network before initiating a transfer." } } }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds. Possible values: `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`." } } }, "nickname": { "type": "string", "description": "Nickname of the beneficiary." }, "payer_entity_type": { "type": "string", "description": "The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to `COMPANY`." }, "sca_exemptible": { "type": "boolean", "description": "Whether the beneficiary can be exempted from SCA when applicable." }, "transfer_methods": { "type": "array", "description": "Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: `SWIFT`, `LOCAL`.", "items": { "type": "string" } }, "transfer_reason": { "type": "string", "description": "Reason for the transfer instruction being made to this beneficiary." } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" } } } } }, "description": "beneficiaryContactRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryContact" }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } } } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "code": "validation_failed", "details": { "errors": [ { "code": "008", "source": "beneficiary.bank_details.account_number" }, { "code": "018", "params": { "length_max": 17, "length_min": 8 }, "source": "beneficiary.bank_details.account_number" } ] }, "message": "This is not valid." } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/beneficiaries/beneficiarie_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" }, "response_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "id": "8365ea88-2946-4877-abe1-e02a1015288d", "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ] } }, { "key": "validation_failed", "name": "Validation Failed", "method": "POST", "uri": "/api/v1/beneficiaries/{id}/update", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "validation_failed", "details": { "errors": [ { "code": "008", "source": "beneficiary.bank_details.account_number" }, { "code": "018", "params": { "length_max": 17, "length_min": 8 }, "source": "beneficiary.bank_details.account_number" } ] }, "message": "This is not valid." } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/validate": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "5|Validate a Beneficiary", "description": "Given a beneficiary request, validate it and return all failed fields as a 400 response. No errors will be `\"OK\"` as a 200 response.", "operationId": "beneficiaries_validate", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "beneficiary", "transfer_methods" ], "properties": { "beneficiary": { "type": "object", "description": "Details of the beneficiary.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "stablecoin_wallet": { "type": "object", "required": [ "asset", "network", "address" ], "properties": { "asset": { "type": "string", "description": "Stablecoin asset type, e.g., `USDC`." }, "network": { "type": "string", "description": "Blockchain network, e.g., `ETHEREUM`." }, "address": { "type": "string", "description": "Blockchain wallet address of the beneficiary. Sending stablecoins to an incorrect wallet address or unsupported network will result in the irreversible loss of funds. Always verify the recipient wallet address and network before initiating a transfer." } } }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds. Possible values: `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`." } } }, "nickname": { "type": "string", "description": "Nickname of the beneficiary." }, "payer_entity_type": { "type": "string", "description": "The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to `COMPANY`." }, "sca_exemptible": { "type": "boolean", "description": "Whether the beneficiary can be exempted from SCA when applicable." }, "transfer_methods": { "type": "array", "description": "Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: `SWIFT`, `LOCAL`.", "items": { "type": "string" } }, "transfer_reason": { "type": "string", "description": "Reason for the transfer instruction being made to this beneficiary." } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" } } } } }, "description": "beneficiaryContactRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "code": "validation_failed", "details": { "errors": [ { "code": "011", "source": "transfer_methods" } ] }, "message": "This is not valid." } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/beneficiaries/validate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "nickname": "Complete Concrete Pty Ltd", "payer_entity_type": "COMPANY", "sca_exemptible": false, "transfer_methods": [ "SWIFT" ], "transfer_reason": "travel" } }, { "key": "validation_failed", "name": "Validation Failed", "method": "POST", "uri": "/api/v1/beneficiaries/validate", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "validation_failed", "details": { "errors": [ { "code": "011", "source": "transfer_methods" } ] }, "message": "This is not valid." } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/beneficiaries/verify_account": { "post": { "tags": [ "Payouts > Beneficiaries" ], "summary": "6|Verify a Beneficiary Account", "description": "Submit beneficiary account details to verify its existance and retreive name-matching result (where supported) across supported regions and transfer methods (see [Product Docs](/docs/payouts/beneficiaries/verify-a-beneficiary-account)). The results can be used to mitigate fraud and prevent failures before creating a transfer.", "operationId": "verifyAccount", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "entity_type", "transfer_method" ], "properties": { "bank_details": { "type": "object", "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary, i.e., COMPANY, PERSONAL." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e., SWIFT, LOCAL." } } }, "examples": { "default": { "value": { "bank_details": { "account_name": "Betty Morris", "account_number": "10006132", "account_routing_type1": "sort_code", "account_routing_value1": "040568", "bank_country_code": "GB", "iban": "", "local_clearing_system": "", "swift_code": "" }, "entity_type": "PERSONAL", "transfer_method": "LOCAL" } } } } }, "description": "beneficiaryVerifyAccountRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyAccountApiResponseOfBeneficiaryVerifyAccount" }, "examples": { "default": { "value": { "code": "VERIFIED", "details": { "account_name_match_result": "FULL_MATCH", "resolved_account_name": "Betty Morris", "resolved_bank_name": "ClearBank Limited" }, "message": "This is a valid account. Refer to the details object for verification details." } } } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/beneficiaries/verify_account", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "bank_details": { "account_name": "Betty Morris", "account_number": "10006132", "account_routing_type1": "sort_code", "account_routing_value1": "040568", "bank_country_code": "GB", "iban": "", "local_clearing_system": "", "swift_code": "" }, "entity_type": "PERSONAL", "transfer_method": "LOCAL" }, "response_body": { "code": "VERIFIED", "details": { "account_name_match_result": "FULL_MATCH", "resolved_account_name": "Betty Morris", "resolved_bank_name": "ClearBank Limited" }, "message": "This is a valid account. Refer to the details object for verification details." } } ], "x-scope": [ { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers/create": { "post": { "tags": [ "Payouts > Payers" ], "summary": "1|Create a Payer", "description": "Create a new payer to be stored on the Airwallex platform.", "operationId": "createPayer", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payer" ], "properties": { "nickname": { "type": "string", "description": "Nickname of the payer." }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details of the payer.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } }, "description": "payerContactRequestDto.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerContact" }, "examples": { "default": { "value": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/payers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } }, "response_body": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers/{id}/delete": { "post": { "tags": [ "Payouts > Payers" ], "summary": "6|Delete an Existing Payer", "description": "Delete an existing payer stored on the Airwallex platform.", "operationId": "deletePayer", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "id of the payer contact to update.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "payer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/payers/payer_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers": { "get": { "tags": [ "Payouts > Payers" ], "summary": "3|List all Payers", "description": "Get list of payers with optional filters on from date/time, to date/time, names and entity type. Results are paginated, with default list limit of 50 results.", "operationId": "listPayers", "x-oboSupported": false, "parameters": [ { "name": "entity_type", "in": "query", "description": "Filter on entity type of COMPANY or PERSONAL.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "COMPANY" } }, { "name": "from_date", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time", "default": "2017-04-01" } }, { "name": "name", "in": "query", "description": "Filter on name of payer.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "Clare" } }, { "name": "nick_name", "in": "query", "description": "Filter on nickname of payer.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_date", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date-time", "default": "2030-01-01T00:00:00+0000" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/PayerContact" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/payers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } ] } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers/{id}": { "get": { "tags": [ "Payouts > Payers" ], "summary": "2|Retrieve a Payer", "description": "Get a specific payer by specifying the Airwallex payer_id.", "operationId": "retrievePayer", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "id of the payer contact to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "payer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerContact" }, "examples": { "default": { "value": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/payers/payer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers/schema": { "post": { "tags": [ "Payouts > Payers" ], "summary": "7|Retrieve the Payer Schema", "description": "Given a partial payer request, return a dynamic schema of all fields. Can be used to generate a dynamic payer form user interface.\n\n[beta]: This is a new endpoint with significant complexity, so the experience of integrating with it will be improved as we obtain more feedback. It is ready for production use, and is currently used internally by Airwallex for our Webapp beneficiary form and dynamic schema documentation. Please get in touch with our support team if you'd like to know more.", "operationId": "payers_schema", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "create_payer_request": { "type": "object", "required": [ "payer" ], "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`).", "properties": { "nickname": { "type": "string", "description": "Nickname of the payer." }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details of the payer.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } } } }, "relaxed_validation": { "type": "string", "description": "Whether to use relaxed validation (manual resolution of missing/invalid fields). This feature is only available to some accounts." }, "use_payer_full_address": { "type": "string", "description": "Whether payer address will be specified using a single full address field, or individual address component fields. This feature is only available to some accounts." } } }, "examples": { "default": { "value": { "create_payer_request": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } }, "relaxed_validation": "false", "use_payer_full_address": "false" } } } } }, "description": "createPayerSchemaRequestRaw.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResult" }, "examples": { "default": { "value": { "errors": {}, "schema": {} } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/payers/schema", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "create_payer_request": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } }, "relaxed_validation": "false", "use_payer_full_address": "false" }, "response_body": { "errors": {}, "schema": {} } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/payers/{id}/update": { "post": { "tags": [ "Payouts > Payers" ], "summary": "4|Update an Existing Payer", "description": "Edit an existing payer stored on the Airwallex platform.", "operationId": "updatePayer", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "id of the payer contact to update.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "payer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payer" ], "properties": { "nickname": { "type": "string", "description": "Nickname of the payer." }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details of the payer.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } }, "description": "payerContactRequestDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerContact" }, "examples": { "default": { "value": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/payers/payer_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } }, "response_body": { "id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/payers/validate": { "post": { "tags": [ "Payouts > Payers" ], "summary": "5|Validate a Payer", "description": "Given a payer request, validate it and return all failed fields as a 400 response. No errors will be `OK` as a 200 response.", "operationId": "payers_validate", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payer" ], "properties": { "nickname": { "type": "string", "description": "Nickname of the payer." }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details of the payer.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } } }, "description": "The partial payer creation request. Any subset of fields can be supplied, starting at an empty object (`{}`)." }, "examples": { "default": { "value": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } } } }, "description": "createPayerRequestRaw.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/payers/validate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "nickname": "Complete Concrete Pty Ltd", "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" } } } ], "x-scope": [ { "scope": "beneficiary:read", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "beneficiary:write", "group": "Payouts", "resource_name": "Beneficiaries", "oauthSupported": true, "apiKeySupported": true }, { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers/{id}/cancel": { "post": { "tags": [ "Payouts > Transfers" ], "summary": "6|Cancel a Transfer", "description": "Cancel a transfer by specifying the `id`.", "operationId": "transfers_cancel", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the transfer to cancel.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "[\"transfer_not_found\"\n,\"update_unsupported\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/transfers/transfer_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK" } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers/{id}/confirm_funding": { "post": { "tags": [ "Payouts > Transfers" ], "summary": "4|Confirm Funding for a Transfer", "description": "Confirm funding of a transfer under the post-funding settlement model by specifying the `id`. The funding status of this transfer will transition from `REQUIRES_FUNDING_CONFIRMATION` to `SCHEDULED` accordingly.", "operationId": "confirmFunding", "parameters": [ { "name": "id", "in": "path", "description": "id.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "default": { "value": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } } } } }, "400": { "description": "[\"transfer_not_found\"\n,\"update_unsupported\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/transfers/transfer_id/confirm_funding", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers/create": { "post": { "tags": [ "Payouts > Transfers" ], "summary": "1|Create a Transfer", "description": "> [!INFORMATIONAL: Transfer to card is available for early access]\n> Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [support@airwallex.com](mailto:support@airwallex.com) if you would like to use this feature. [Learn more about early access](https://www.airwallex.com/docs/developer-tools/release-phases).\n\nCreate a new transfer to a beneficiary. The transfer can either include an underlying conversion when the transfer currency varies from the source currency, or will not include a conversion when the transfer currency and source currency match.\n\nWe have created a dynamic schema that will return required fields based on some key criteria that we need to determine the destination of the transfer and the route it will take to reach that destination. \n\n**Transfer Fee**\n\nBy default, payer is responsible for the transfer fee but may be passed onto the beneficiary by setting `fee_paid_by` to `BENEFICIARY`. The `fee_paid_by` flag affects the total amount the payer has to pay, and the amount the beneficiary receives.\n\nThe fee component is calculated by the system and is communicated back via `fee_currency` and `fee_amount` in the API response. The actual amounts both parties pay and receive are represented by `amount_payer_pays` and `amount_beneficiary_receives` respectively.\n\n**Approvals**\n\nCreating a transfer to be submitted for approval is available upon request. When a transfer including a conversion is submitted for approval, values for `amount_beneficiary_receives`, `amount_payer_pays`, `fee_amount`, `transfer_amount` and `source_amount` in the response are tentative based on the exchange rate at the time of creation until the transfer status changes to `SCHEDULED`, at which point the exchange rate is confirmed. When the transfer status transitions to `SCHEDULED`, if the `transfer_date` is a past date, its value will get updated.", "operationId": "createTransfer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason", "reference", "request_id", "transfer_currency" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transfer.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } } }, "beneficiary": { "type": "object", "description": "Details for the beneficiary in the transfer request. If beneficiary_id provided in the transfer request then beneficiary should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "stablecoin_wallet": { "type": "object", "required": [ "asset", "network", "address" ], "properties": { "asset": { "type": "string", "description": "Stablecoin asset type, e.g., `USDC`." }, "network": { "type": "string", "description": "Blockchain network, e.g., `ETHEREUM`." }, "address": { "type": "string", "description": "Blockchain wallet address of the beneficiary. Sending stablecoins to an incorrect wallet address or unsupported network will result in the irreversible loss of funds. Always verify the recipient wallet address and network before initiating a transfer." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds. Possible values: `BANK_ACCOUNT`, `DIGITAL_WALLET`, `CARD`, `STABLECOIN_WALLET`." } } }, "beneficiary_id": { "type": "string", "description": "An Airwallex `beneficiary_id` previously generated by utilizing the Airwallex Contact API. This may be provided in place of the `beneficiary` object and should be empty if the beneficiary fields are provided." }, "client_data": { "type": "string", "description": "Free text field available to you; can be populated with any additional identifiers that may be required for the transfer." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER`/`BENEFICIARY` will be liable for the transfer fees, and it affects the actual amount the beneficiary receives." }, "lock_rate_on_create": { "type": "boolean", "description": "Customers could choose whether to use confirmed rates for scheduled transfer with conversion. This field should only be specified when a conversion is involved.If customers do not specify this field, the default value is true. This field can either be specified to be TRUE when creating a transfer with currency conversions at a confirmed rate or FALSE if an unconfirmed rate is wanted." }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details for the payer in the transfer request. If payer_id provided in the transfer request then payer should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } }, "payer_id": { "type": "string", "description": "An Airwallex payer_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the payer section and should be empty if the payer fields are provided." }, "quote_id": { "type": "string", "description": "quote id from a previously created lockfx quote." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the beneficiary on the transfer transaction with their bank." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request ID specified by the client. Payout creation requests with a `request_id` that has been used in the past 7 days are treated as duplicated payout and cannot be processed. When you are not sure about the outcome of a payout creation request, e.g. when there are network issues or system failures such as timeout, you can try to get a payout with this `request_id` to find out. \nNote: Can be non-UUID as long as it is unique among the requests within the past 7 days." }, "source_amount": { "type": "string", "description": "Source amount in `source_currency`." }, "source_currency": { "type": "string", "description": "Source currency, i.e. the currency that the Payer uses to fund the transfer (3-letter ISO-4217 code)." }, "swift_charge_option": { "type": "string", "description": "(For SWIFT transfers only), specify who should bear SWIFT charges, either `SHARED` (default) or `PAYER`." }, "transfer_amount": { "type": "string", "description": "Transfer amount in `transfer_currency`." }, "transfer_currency": { "type": "string", "description": "Transfer currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)." }, "transfer_date": { "type": "string", "description": "Date when transfer should be made." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e. SWIFT, LOCAL." } } }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "client_data": "string", "fee_paid_by": "PAYER", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "quote_id": "", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": "10000", "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": "10000", "transfer_currency": "AUD", "transfer_date": "2017-03-20", "transfer_method": "SWIFT" } } } } }, "description": "createTransferRequestDto.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "default": { "value": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } } } } }, "400": { "description": "[\"request_id_duplicate\"\n,\"declaration_required\"\n,\"amount_beneficiary_receives_below_limit\"\n,\"amount_below_transfer_method_limit\"\n,\"source_amount_below_account_limit\"\n,\"transfer_amount_below_account_limit\"\n,\"amount_beneficiary_receives_above_cumulative_limit\"\n,\"amount_above_transfer_method_limit\"\n,\"source_amount_above_account_limit\"\n,\"transfer_amount_above_account_limit\"\n,\"fee_unknown\"\n,\"service_unavailable\"\n,\"currency_pair_invalid\"\n,\"order_info_unsupported\"\n,\"order_reconciliation_failed\"\n,\"transfer_currency_unsupported\"\n,\"source_currency_unsupported\"\n,\"open_position_limit_exceeded\"\n,\"balance_insufficient\"\n,\"payout_method_unsupported\"\n,\"payer_unsupported\"\n,\"validation_failed\"\n,\"quote_id_invalid\"\n,\"quote_id_required\"\n,\"beneficiary_type_unsupported\"\n,\"order_amount_insufficient\"\n,\"quote_expired\"\n,\"transfer_date_invalid\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "declaration_required": { "value": { "code": "declaration_required", "details": {}, "message": "Complete the CN local transfer declaration process before creating the transfer.", "source": "declaration_required" } }, "request_id_duplicate": { "value": { "code": "request_id_duplicate", "source": "request_id", "message": "request_id 90459a20-d35d-3149-a998-795074c3971d has been used in the past. Please use a different request_id for this request", "details": { "request_id": "90459a20-d35d-3149-a998-795074c3971d", "id": "27cb219e-ec23-4aa3-8a86-89c40dad08bc" } } }, "validation_failed": { "value": { "code": "validation_failed", "message": "validation_failed", "details": { "errors": [ { "source": "beneficiary.address.postcode", "code": "030" }, { "source": "beneficiary.address.street_address", "code": "018", "params": { "length_min": 5, "length_max": 200 } }, { "source": "beneficiary.address.street_address", "code": "028" } ] } } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "409": { "description": "[\"request_pending\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/transfers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "client_data": "string", "fee_paid_by": "PAYER", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "quote_id": "", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": "10000", "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": "10000", "transfer_currency": "AUD", "transfer_date": "2017-03-20", "transfer_method": "SWIFT" }, "response_body": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } }, { "key": "declaration_required", "name": "Declaration Required", "method": "POST", "uri": "/api/v1/transfers/create", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "declaration_required", "details": {}, "message": "Complete the CN local transfer declaration process before creating the transfer.", "source": "declaration_required" } }, { "key": "request_id_duplicate", "name": "Request ID Duplicate", "method": "POST", "uri": "/api/v1/transfers/create", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "request_id_duplicate", "source": "request_id", "message": "request_id 90459a20-d35d-3149-a998-795074c3971d has been used in the past. Please use a different request_id for this request", "details": { "request_id": "90459a20-d35d-3149-a998-795074c3971d", "id": "27cb219e-ec23-4aa3-8a86-89c40dad08bc" } } }, { "key": "validation_failed", "name": "Validation Failed", "method": "POST", "uri": "/api/v1/transfers/create", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "validation_failed", "message": "validation_failed", "details": { "errors": [ { "source": "beneficiary.address.postcode", "code": "030" }, { "source": "beneficiary.address.street_address", "code": "018", "params": { "length_min": 5, "length_max": 200 } }, { "source": "beneficiary.address.street_address", "code": "028" } ] } } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers": { "get": { "tags": [ "Payouts > Transfers" ], "summary": "3|List all Transfers", "description": "Get list of transfers from a specified creation date/time, with optional filters on end creation date/time, buy/sell currency and status. Alternatively, one or neither of the *from* or *to* created_at request fields needs to be populated. In the event that neither or only the to created_at fields are populated, then transfers 30 days in arrears of today or the *to* created_at date will be returned.", "operationId": "listTransfers", "parameters": [ { "name": "batch_transfer_id", "in": "query", "description": "Batch transfer unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid", "default": "55713d04-c569-4510-abb7-5b47d2423a84" } }, { "name": "beneficiary_id", "in": "query", "description": "Beneficiary unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid", "default": "55713d04-c569-4510-abb7-5b47d2423a84" } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2022-12-01T20:00:00Z" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call. The 30-day limit will be removed if `page` is present in the request. Passing page=0 on the very first page will override the 30 days default for null date ranges, enabling a complete search of the transfers.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page, defaultValue 2000.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 2000 } }, { "name": "request_id", "in": "query", "description": "Transfer `request_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "short_reference_id" } }, { "name": "short_reference_id", "in": "query", "description": "Transfer `short_reference_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "short_reference_id" } }, { "name": "status", "in": "query", "description": "Status of the transfer.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "PROCESSING" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2022-12-31T20:00:00Z" } }, { "name": "transfer_currency", "in": "query", "description": "Transfer currency.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorBasedPagedQueryResultDtoOfTransfer" }, "examples": { "default": { "value": { "items": [ { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/transfers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker" }, "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers/{id}": { "get": { "tags": [ "Payouts > Transfers" ], "summary": "2|Retrieve a Transfer", "description": "Get a specific transfer by specifying the Airwallex `id`.", "operationId": "retrieveTransfer", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the transfer to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "transfer_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "default": { "value": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/transfers/transfer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure": { "code": "90502", "message": "Unable to process due to risk concerns.", "details": { "type": "TM_SUSPEND", "reason_codes": [ "EXPIRED_TRANSACTION_RFI" ] } }, "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } ], "x-scope": [ { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/transfers/validate": { "post": { "tags": [ "Payouts > Transfers" ], "summary": "5|Validate a Transfer", "description": "Given a transfer request, validate it and return all failed fields as a 400 response. No errors will be `\"OK\"` as a 200 response.", "operationId": "transfers_validate", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason", "reference", "request_id", "transfer_currency" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transfer.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } } }, "beneficiary": { "type": "object", "description": "Details for the beneficiary in the transfer request. If beneficiary_id provided in the transfer request then beneficiary should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the beneficiary.", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } } }, "address": { "type": "object", "description": "Beneficiary's address details.", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } } }, "bank_details": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "description": "Beneficiary's bank account details where the payment will be credited.", "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } } }, "card": { "type": "object", "required": [ "cardholder_name", "token" ], "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access", "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } } }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "description": "Beneficiary's digital wallet details where the payment will be credited.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } } }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds." } } }, "beneficiary_id": { "type": "string", "description": "An Airwallex beneficiary_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the beneficiary section and should be empty if the beneficiary fields are provided." }, "client_data": { "type": "string", "description": "Free text field available to you; can be populated with any additional identifiers that may be required for the transfer." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER`/`BENEFICIARY` will be liable for the transfer fees, and it affects the actual amount the beneficiary receives." }, "lock_rate_on_create": { "type": "boolean", "description": "Customers could choose whether to use confirmed rates for scheduled transfer with conversion. This field should only be specified when a conversion is involved.If customers do not specify this field, the default value is true. This field can either be specified to be TRUE when creating a transfer with currency conversions at a confirmed rate or FALSE if an unconfirmed rate is wanted." }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "type": "object", "required": [ "address", "entity_type" ], "description": "Details for the payer in the transfer request. If payer_id provided in the transfer request then payer should be empty.", "properties": { "additional_info": { "type": "object", "description": "Additional information about the payer.", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } } }, "address": { "type": "object", "required": [ "country_code" ], "description": "Payer's address details.", "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } } }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } } }, "payer_id": { "type": "string", "description": "An Airwallex payer_id previously generated by utilising the Airwallex Contact API. This may be provided in place of the payer section and should be empty if the payer fields are provided." }, "quote_id": { "type": "string", "description": "quote id from a previously created lockfx quote." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the beneficiary on the transfer transaction with their bank." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request ID specified by the client. Payout creation requests with a `request_id` that has been used in the past 7 days are treated as duplicated payout and cannot be processed. When you are not sure about the outcome of a payout creation request, e.g. when there are network issues or system failures such as timeout, you can try to get a payout with this `request_id` to find out. \nNote: Can be non-UUID as long as it is unique among the requests within the past 7 days." }, "source_amount": { "type": "string", "description": "Source amount in `source_currency`." }, "source_currency": { "type": "string", "description": "Source currency, i.e. the currency that the Payer uses to fund the transfer (3-letter ISO-4217 code)." }, "swift_charge_option": { "type": "string", "description": "(For SWIFT transfers only), specify who should bear SWIFT charges, either `SHARED` (default) or `PAYER`." }, "transfer_amount": { "type": "string", "description": "Transfer amount in `transfer_currency`." }, "transfer_currency": { "type": "string", "description": "Transfer currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)." }, "transfer_date": { "type": "string", "description": "Date when transfer should be made." }, "transfer_method": { "type": "string", "description": "Transfer method, i.e. SWIFT, LOCAL." } } }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "client_data": "string", "fee_paid_by": "PAYER", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "quote_id": "", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": "10000", "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": "10000", "transfer_currency": "AUD", "transfer_date": "2017-03-20", "transfer_method": "SWIFT" } } } } }, "description": "createTransferRequestDto.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "[\"validation_failed\"\n,\"service_unavailable\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "code": "validation_failed", "details": { "errors": [ { "code": "011", "source": "transfer_method" } ] }, "message": "This is not valid." } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/transfers/validate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "card": { "brand": "VISA", "cardholder_name": "John Walker", "currency": "USD", "expiry_month": "10", "expiry_year": "2033", "number": "************1111", "token": "AKvN4TqxI04SNFZ+oYRXaECtDA==" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "8365ea88-2946-4877-abe1-e02a1015288d", "client_data": "string", "fee_paid_by": "PAYER", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "46c22228-5831-4c53-a4fa-a3ab4954877c", "quote_id": "", "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source_amount": "10000", "source_currency": "AUD", "swift_charge_option": "SHARED", "transfer_amount": "10000", "transfer_currency": "AUD", "transfer_date": "2017-03-20", "transfer_method": "SWIFT" } }, { "key": "validation_failed", "name": "Validation Failed", "method": "POST", "uri": "/api/v1/transfers/validate", "status_code": 400, "reason_phrase": "Bad Request", "response_body": { "code": "validation_failed", "details": { "errors": [ { "code": "011", "source": "transfer_method" } ] }, "message": "This is not valid." } } ], "x-scope": [ { "scope": "transfer:write", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/risk/issuing/fraud_feedback": { "post": { "tags": [ "Risk > Fraud Feedback (Issuing)" ], "summary": "1|Fraud Feedback (Issuing)", "description": "Create a confirmation on whether a transaction was authorized by the cardholder.", "operationId": "issuingFraudFeedback", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "authorization_id" ], "properties": { "authorization_id": { "type": "string", "description": "Unique id for the authorization." }, "cardholder_decision": { "type": "string", "description": "The cardholder authorization status. Use `AUTHORIZED_BY_CARDHOLDER`, `NOT_AUTHORIZED_BY_CARDHOLDER`." } } }, "examples": { "default": { "value": { "authorization_id": "authorization_id", "cardholder_decision": "AUTHORIZED_BY_CARDHOLDER" } } } } }, "description": "userAuthorizationRespondRequest", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthorizationRespond" }, "examples": { "default": { "value": { "authorization_id": "authorization_id", "card_id": "card_id", "cardholder_decision": "AUTHORIZED_BY_CARDHOLDER" } } } } } }, "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "[\"invalid_state_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/risk/issuing/fraud_feedback", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "authorization_id": "authorization_id", "cardholder_decision": "AUTHORIZED_BY_CARDHOLDER" }, "response_body": { "authorization_id": "authorization_id", "card_id": "card_id", "cardholder_decision": "AUTHORIZED_BY_CARDHOLDER" } } ], "x-scope": [ { "scope": "risk.issuing_fraud_feedback:write", "group": "Risk", "resource_name": "Issuing Fraud Feedback", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/rfis": { "get": { "tags": [ "Risk > Request for Information (RFI)" ], "summary": "2|List all RFIs", "description": "Returns a list of RFIs raised for your Airwallex account, sorted by the RFI creation date in descending order.", "operationId": "listRequestForInformationRfi", "parameters": [ { "name": "end_created_at", "in": "query", "description": "The end date of created_at in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "from_created_at", "in": "query", "description": "The start date of created_at in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "A limit on the number of records to be returned on a page, between 1 and 2000. The default is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "statuses", "in": "query", "description": "List of RFI status separated by `,`. One of `ACTION_REQUIRED`, `ANSWERED`, `CLOSED`.", "required": false, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "types", "in": "query", "description": "List of RFI types separated by `,`. Currently only supports `KYC`, `KYC_ONGOING`, `CARDHOLDER`, `TRANSACTION` and `PAYMENT_ENABLEMENT` type.", "required": false, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedRfiSessionQueryResult" }, "examples": { "default": { "value": { "items": [ { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } ], "page_after": "YWZ0ZXI9MTdiYTVhYzktM2FiMC00NmIzLWE4ODctMTNjNmU5NTg2N2Qy", "page_before": "YmVmb3JlPTg0NDg0ODIwLTU0N2UtNDc5YS1iMTY3LTgzYjQwMzcwODQ2ZQ==" } } } } } }, "400": { "description": "[\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/rfis", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } ], "page_after": "YWZ0ZXI9MTdiYTVhYzktM2FiMC00NmIzLWE4ODctMTNjNmU5NTg2N2Qy", "page_before": "YmVmb3JlPTg0NDg0ODIwLTU0N2UtNDc5YS1iMTY3LTgzYjQwMzcwODQ2ZQ==" } } ], "x-scope": [ { "scope": "risk.rfi:read", "group": "Risk", "resource_name": "Request for Information (RFI)", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/rfis/{id}/respond": { "post": { "tags": [ "Risk > Request for Information (RFI)" ], "summary": "3|Respond to an RFI", "description": "Allows you to respond to an RFI request by providing the required answers.", "operationId": "respond", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the RFI.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "request_for_information_rfi_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "questions": { "type": "array", "description": "List of questions.", "items": { "type": "object", "properties": { "answer": { "type": "object", "description": "Response to the question.", "properties": { "address": { "type": "object", "description": "Response for `ADDRESS` type.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "attachments": { "type": "array", "description": "Response for `ATTACHMENT` type.", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "File id provided in the response from the File Service API." } } } }, "comment": { "type": "string", "description": "Comment for this response." }, "confirmed": { "type": "boolean", "description": "Response for `CONFIRMATION` type." }, "identity_document": { "type": "object", "description": "Response for `IDENTITY_DOCUMENT` type.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "issuing_country": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Identity number." }, "type": { "type": "string", "description": "Type of identity document. One of `DRIVING_LICENSE`,`PASSPORT`,`IDENTITY_CARD`,`MEDICARE_CARD`,`SSN`,`ITIN`." } } }, "text": { "type": "string", "description": "Response for `TEXT` type." }, "type": { "type": "string", "description": "The type of response to the question.", "enum": [ "TEXT", "ATTACHMENT", "IDENTITY_DOCUMENT", "CONFIRMATION", "LIVENESS", "ADDRESS" ] } } }, "id": { "type": "string", "description": "Unique identifier for the question." } } } } } }, "examples": { "default": { "value": { "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263" } ] } } } } }, "description": "RFI response.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RfiSession" }, "examples": { "default": { "value": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } } } } }, "400": { "description": "[\"invalid_state_for_operation\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/rfis/request_for_information_rfi_id/respond", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263" } ] }, "response_body": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } ], "x-scope": [ { "scope": "risk.rfi:write", "group": "Risk", "resource_name": "Request for Information (RFI)", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/rfis/{id}": { "get": { "tags": [ "Risk > Request for Information (RFI)" ], "summary": "1|Retrieve an RFI", "description": "Retrieves details of an RFI using the given RFI unique identifier.", "operationId": "retrieveRequestForInformationRfi", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the RFI.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "request_for_information_rfi_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RfiSession" }, "examples": { "default": { "value": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } } } } }, "400": { "description": "[\"invalid_state_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/rfis/request_for_information_rfi_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } ], "x-scope": [ { "scope": "risk.rfi:read", "group": "Risk", "resource_name": "Request for Information (RFI)", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/sellers/create": { "post": { "tags": [ "Risk > Sellers" ], "summary": "1|Create a Seller", "description": "Creates a new seller for your MoR account.", "operationId": "createSeller", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "object", "description": "Business address.", "properties": { "address_line1": { "type": "string", "description": "Address line 1." }, "address_line2": { "type": "string", "description": "Address line 2." }, "country_code": { "type": "string", "description": "Country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postal code." }, "state": { "type": "string", "description": "State or province." }, "suburb": { "type": "string", "description": "Suburb or city." } } }, "business_identification_number": { "type": "string", "description": "Business identification number." }, "email": { "type": "string", "description": "Contact email." }, "industry_code": { "type": "string", "description": "Industry code." }, "legal_entity_name": { "type": "string", "description": "Legal entity name." }, "merchant_category_code": { "type": "string", "description": "Merchant category code." }, "phone_number": { "type": "string", "description": "Phone number." }, "registration_country": { "type": "string", "description": "Registration country code." }, "registration_date": { "type": "string", "description": "Registration date in YYYY-MM-DD format." }, "trading_name": { "type": "string", "description": "Trading name." }, "websites": { "type": "array", "description": "List of websites.", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Website URL." } } } } }, "description": "Seller details." }, "examples": { "default": { "value": { "address": { "address_line1": "123 Market St", "address_line2": "Suite 100", "country_code": "US", "postcode": "94105", "state": "California", "suburb": "San Francisco" }, "business_identification_number": "201626561Z", "email": "contact@acme.com", "industry_code": "ICCV3_0001XX", "legal_entity_name": "AIRWALLEX (SINGAPORE) PTE. LTD.", "merchant_category_code": "5734", "phone_number": "+1-555-1234", "registration_country": "SG", "registration_date": "2020-01-15", "trading_name": "AIRWALLEX SG", "websites": [ { "url": "https://www.subseller.com" } ] } } } } }, "description": "Seller creation request.", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubsellerStatus" }, "examples": { "default": { "value": { "created_at": "2025-10-24T06:15:09Z", "id": "2ec93632-07c6-4afc-8519-25da56f3931a", "status": "IN_REVIEW", "updated_at": "2025-10-24T07:01:03Z" } } } } } }, "400": { "description": "[\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/sellers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "address": { "address_line1": "123 Market St", "address_line2": "Suite 100", "country_code": "US", "postcode": "94105", "state": "California", "suburb": "San Francisco" }, "business_identification_number": "201626561Z", "email": "contact@acme.com", "industry_code": "ICCV3_0001XX", "legal_entity_name": "AIRWALLEX (SINGAPORE) PTE. LTD.", "merchant_category_code": "5734", "phone_number": "+1-555-1234", "registration_country": "SG", "registration_date": "2020-01-15", "trading_name": "AIRWALLEX SG", "websites": [ { "url": "https://www.subseller.com" } ] }, "response_body": { "created_at": "2025-10-24T06:15:09Z", "id": "2ec93632-07c6-4afc-8519-25da56f3931a", "status": "IN_REVIEW", "updated_at": "2025-10-24T07:01:03Z" } } ], "x-scope": [ { "scope": "risk.seller:write", "group": "Risk", "resource_name": "Sellers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/sellers/{id}/deactivate": { "post": { "tags": [ "Risk > Sellers" ], "summary": "3|Deactivate a Seller", "description": "Deactivates an existing seller by unique identifier.", "operationId": "sellers_deactivate", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the seller.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "seller_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubsellerStatus" }, "examples": { "default": { "value": { "created_at": "2025-10-24T06:15:09Z", "id": "2ec93632-07c6-4afc-8519-25da56f3931a", "status": "IN_REVIEW", "updated_at": "2025-10-24T07:01:03Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/sellers/seller_id/deactivate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "created_at": "2025-10-24T06:15:09Z", "id": "2ec93632-07c6-4afc-8519-25da56f3931a", "status": "IN_REVIEW", "updated_at": "2025-10-24T07:01:03Z" } } ], "x-scope": [ { "scope": "risk.seller:write", "group": "Risk", "resource_name": "Sellers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/sellers/{id}": { "get": { "tags": [ "Risk > Sellers" ], "summary": "2|Retrieve a Seller", "description": "Retrieves details of a seller using the given seller unique identifier.", "operationId": "retrieveSeller", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the seller.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "seller_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubsellerDetailsResponse" }, "examples": { "default": { "value": { "created_at": "2025-10-28T06:45:12Z", "details": { "address": { "address_line1": "123 Market St", "address_line2": "Suite 100", "country_code": "US", "postcode": "94105", "state": "California", "suburb": "San Francisco" }, "business_identification_number": "201626561Z", "email": "contact@acme.com", "industry_code": "ICCV3_0001XX", "legal_entity_name": "AIRWALLEX (SINGAPORE) PTE. LTD.", "merchant_category_code": "5734", "phone_number": "+1-555-1234", "registration_country": "SG", "registration_date": "2020-01-15", "trading_name": "AIRWALLEX SG", "websites": [ { "url": "https://www.subseller.com" } ] }, "id": "220362ad-f8e0-42c9-937a-5bdd67cfc7d1", "status": "ACTIVE", "updated_at": "2025-10-28T07:01:03Z" } } } } } }, "400": { "description": "[\"invalid_argument\", \"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/sellers/seller_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "created_at": "2025-10-28T06:45:12Z", "details": { "address": { "address_line1": "123 Market St", "address_line2": "Suite 100", "country_code": "US", "postcode": "94105", "state": "California", "suburb": "San Francisco" }, "business_identification_number": "201626561Z", "email": "contact@acme.com", "industry_code": "ICCV3_0001XX", "legal_entity_name": "AIRWALLEX (SINGAPORE) PTE. LTD.", "merchant_category_code": "5734", "phone_number": "+1-555-1234", "registration_country": "SG", "registration_date": "2020-01-15", "trading_name": "AIRWALLEX SG", "websites": [ { "url": "https://www.subseller.com" } ] }, "id": "220362ad-f8e0-42c9-937a-5bdd67cfc7d1", "status": "ACTIVE", "updated_at": "2025-10-28T07:01:03Z" } } ], "x-scope": [ { "scope": "risk.seller:read", "group": "Risk", "resource_name": "Sellers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/risk/watchlist/create": { "post": { "tags": [ "Risk > Watchlist" ], "summary": "4|Add an Item to the Watchlist", "description": "Add an item to the Watchlist.", "operationId": "createWatchlist", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action", "request_id", "type", "value" ], "properties": { "action": { "type": "string", "description": "Risk action to be taken by the risk engine: Use `BLOCK`, `VERIFY`, `ACCEPT` to always perform the associated risk action. The risk engine will prioritize actions in the following order: `BLOCK`>`VERIFY`>`ACCEPT`.\nPlease note that `ACCEPT` functionality will only be available to users with good fraud performance and will be subject to reasonable usage limits." }, "reason": { "type": "string", "description": "The reason for adding this item to the Watchlist." }, "request_id": { "type": "string", "description": "Unique id for the request." }, "status": { "type": "string", "description": "The status of the list item should be one of:`ACTIVE`,`INACTIVE`. Default is:`ACTIVE`." }, "type": { "type": "string", "description": "The type of the Watchlist item: `CARD_BIN`, `CARD_FINGERPRINT`, `CARD_ISSUER_COUNTRY_CODE`, `CUSTOMER_EMAIL`, `CUSTOMER_ID`. \nPlease note that `ACCEPT` Watchlist only supports `CARD_FINGERPRINT`, `CUSTOMER_EMAIL` and `CUSTOMER_ID`. \nThe following data fields are case sensitive: `CARD_FINGERPRINT`, `CUSTOMER_ID`." }, "value": { "type": "string", "description": "The value of the item corresponding to the correct type." } } }, "examples": { "default": { "value": { "action": "BLOCK", "reason": "risk concern", "request_id": "request_id", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "value": "testblock@123.com" } } } } }, "description": "listItemApiRequest", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" }, "examples": { "default": { "value": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } } } } }, "400": { "description": "[\"invalid_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "[\"list_item_duplicate\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/risk/watchlist/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "action": "BLOCK", "reason": "risk concern", "request_id": "request_id", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "value": "testblock@123.com" }, "response_body": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } ], "x-scope": [ { "scope": "risk.watchlist:write", "group": "Risk", "resource_name": "Watchlist", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/risk/watchlist": { "get": { "tags": [ "Risk > Watchlist" ], "summary": "2|List all Items", "description": "Get list of items with optional filters, sorted by the item creation date in descending order.", "operationId": "listWatchlist", "x-oboSupported": false, "parameters": [ { "name": "action", "in": "query", "description": "Filter on action of Watchlist item.", "required": false, "schema": { "type": "string" } }, { "name": "from_created_at", "in": "query", "description": "The start date of created_at in ISO8601 format (yyyy-MM-dd'T'HH:mm:ssZ). The default is 30 days before `to_create_at`.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "A limit on the number of records to be returned on a page, between 1 and 2000. The default is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2000 } }, { "name": "status", "in": "query", "description": "Filter on status of Watchlist item.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end date of created_at in ISO8601 format (yyyy-MM-dd'T'HH:mm:ssZ). The default is current time.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "type", "in": "query", "description": "Filter on type of Watchlist item.", "required": false, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Filter on value of Watchlist item.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCursorBasedPagedQueryResult" }, "examples": { "default": { "value": { "items": [ { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "reason": "risk concern", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } ], "page_after": "YWZ0ZXI9MTk5MTI3NzEtNjRmZi00NjljLTlkZTItY2I1MzM1OWU5NWZj", "page_before": "YWZ0ZXI9MTk5MTI3NzEtNjRmZi00NjljLTlkZTItY2I1MzM1OWU5NWZj" } } } } } }, "400": { "description": "[\"invalid_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/risk/watchlist", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "reason": "risk concern", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } ], "page_after": "YWZ0ZXI9MTk5MTI3NzEtNjRmZi00NjljLTlkZTItY2I1MzM1OWU5NWZj", "page_before": "YWZ0ZXI9MTk5MTI3NzEtNjRmZi00NjljLTlkZTItY2I1MzM1OWU5NWZj" } } ], "x-scope": [ { "scope": "risk.watchlist:read", "group": "Risk", "resource_name": "Watchlist", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/risk/watchlist/{item_id}": { "get": { "tags": [ "Risk > Watchlist" ], "summary": "1|Retrieve an Item", "description": "Get a specific Watchlist item by specifying the Airwallex item_id.", "operationId": "retrieveWatchlist", "x-oboSupported": false, "parameters": [ { "name": "item_id", "in": "path", "description": "item_id of the item to retrieve.", "required": true, "schema": { "type": "string", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "item_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" }, "examples": { "default": { "value": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/risk/watchlist/item_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } ], "x-scope": [ { "scope": "risk.watchlist:read", "group": "Risk", "resource_name": "Watchlist", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/risk/watchlist/{item_id}/update": { "post": { "tags": [ "Risk > Watchlist" ], "summary": "3|Update an Item", "description": "Edit an existing Watchlist item stored on the Airwallex platform.", "operationId": "updateWatchlist", "x-oboSupported": false, "parameters": [ { "name": "item_id", "in": "path", "description": "item_id of the list item to update.", "required": true, "schema": { "type": "string", "default": "46c22228-5831-4c53-a4fa-a3ab4954877c" }, "examples": { "default": { "value": "item_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "reason": { "type": "string", "description": "The reason for adding this item to the Watchlist." }, "request_id": { "type": "string", "description": "Unique id for the request." }, "status": { "type": "string", "description": "The status of the list item should be one of:`ACTIVE`,`INACTIVE`. Default is:`ACTIVE`." }, "value": { "type": "string", "description": "The value of the item corresponding to the correct type." } } }, "examples": { "default": { "value": { "reason": "risk concern", "request_id": "", "status": "ACTIVE", "value": "testblock@123.com" } } } } }, "description": "listItemUpdateRequest", "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" }, "examples": { "default": { "value": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } } } } }, "201": { "description": "Created" }, "400": { "description": "[\"invalid_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "[\"account_not_authorised_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"resource_not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "[\"list_item_duplicate\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_server_error\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/risk/watchlist/item_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "reason": "risk concern", "request_id": "", "status": "ACTIVE", "value": "testblock@123.com" }, "response_body": { "action": "BLOCK", "created_at": "2023-01-01T00:00:00+0000", "id": "", "reason": "risk concern", "request_id": "", "status": "ACTIVE", "type": "CUSTOMER_EMAIL", "updated_at": "2023-01-01T00:00:00+0000", "value": "testblock@123.com" } } ], "x-scope": [ { "scope": "risk.watchlist:write", "group": "Risk", "resource_name": "Watchlist", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/accounts/{id}/terms_and_conditions/agree": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "7|Agree To Terms and Conditions", "description": "Account agrees to terms and conditions.", "operationId": "agreeTermsAndConditions", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string", "default": "04580011-6378-4d75-af56-21bcf77c06b9" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agreed_at": { "type": "string", "description": "The timestamp marking when the account representative agreed to their service agreement in ISO 8601 format." }, "device_data": { "type": "object", "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis.", "properties": { "ip_address": { "type": "string", "description": "The IP address from which the account representative accepted their service agreement." }, "user_agent": { "type": "string", "description": "The user agent of the browser from which the account representative accepted their service agreement." } } }, "service_agreement_type": { "type": "string", "description": "The user’s service type of their agreement. Default to FULL.", "enum": [ "FULL", "RECIPIENT" ], "x-enumDescriptions": { "FULL": "[FULL service agreement](https://www.airwallex.com/terms/scale-user-terms-global) creates a service relationship between Airwallex and the account holder.", "RECIPIENT": "[RECIPIENT service agreement](https://www.airwallex.com/terms/recipient-agreement-global) clarifies that there is no service relationship between Airwallex and the recipient, and that the recipient’s relationship is with the platform. This service agreement type is required for creating [Ledger Account](/docs/payments-for-platforms/use-cases/payments-for-marketplaces)." } } }, "description": "Terms and conditions between Airwallex and the account holder." }, "examples": { "default": { "value": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } } } } }, "description": "termsAndConditions.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/terms_and_conditions/agree", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" }, "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/create": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "1|Create an Account", "description": "Create a new Airwallex account for your users, merchants, subsidiaries, business partners or clients. You can append more information to the account after creation using the ‘update account’ endpoint. To append documents, please use the ‘file service’ endpoint. Once all the required information has been provided you can submit the account using the ‘Submit account for activation’ endpoint.\n", "operationId": "createAccount", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "account_details": { "type": "object", "description": "Relevant information associated with Airwallex account.", "properties": { "attachments": { "type": "object", "description": "Supplementary files gathered during onboarding. May contain supplementary materials for BusinessEntity and BusinessPersons (UBO, etc).", "properties": { "additional_files": { "type": "array", "description": "Additional files.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the additional file.", "enum": [ "DRIVERS_LICENSE_FRONT", "DRIVERS_LICENSE_BACK", "PERSONAL_ID_FRONT", "PERSONAL_ID_BACK", "PASSPORT", "MEDICARE_CARD", "OTHER" ] } } } } } }, "business_details": { "type": "object", "description": "General information about the business, such as its name, address, and other relevant details.", "properties": { "account_usage": { "type": "object", "description": "The intended purpose of the account, such as product usage and monthly turnover.", "properties": { "estimated_monthly_revenue": { "type": "object", "description": "The approximate amount of revenue a business generates in a month.", "properties": { "amount": { "type": "string", "description": "The approximate amount of revenue a business generates in a month." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`ACCEPT_ONLINE_PAYMENTS`,`COLLECT_MARKETPLACE_PROCEEDS`, \n`RECEIVE_TRANSFERS`,`GET_PAID`,`CONVERT_FUNDS`, \n`MAKE_TRANSFERS`,`CREATE_CARDS`,`MANAGE_EXPENSES`, \n`USE_AWX_API`,`TRANSFER_CNY_INBOUND`.", "items": { "type": "string" } } } }, "as_trustee": { "type": "boolean", "description": "Whether this account is set up as a trustee on behalf of a trust." }, "attachments": { "type": "object", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "EIN_LETTER", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "TRUST_DEED", "UNIT_HOLDER_REGISTER", "UBO_SUPPORTIVE", "THIRD_PARTY_SHAREHOLDING_DOCUMENT" ] } } } } } }, "business_address": { "type": "object", "description": "Address where the business operates and conducts its activities.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required for non-registered sole proprietors and businesses that do not have a business registration country.** Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_name_trading": { "type": "string", "description": "Also known as a \"doing business as\" (DBA) name, refers to a name under which the business operates and conducts its activities, which may differ from its legal name." }, "business_start_date": { "type": "string", "description": "The date on which the business officially begins its operations in YYYY-MM-DD format." }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "CORPORATION", "GENERAL_PARTNERSHIP", "LIMITED_LIABILITY_COMPANY", "LIMITED_LIABILITY_PARTNERSHIP", "LIMITED_PARTNERSHIP", "PARTNERSHIP", "SELF_MANAGED_SUPER_FUND", "SOLE_PROPRIETOR", "NON_REGISTERED_SOLE_PROPRIETOR", "TRUST", "OTHER" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "exports_goods_or_services": { "type": "boolean", "description": "Indicate whether the business engages in the export of goods and/or services." }, "fax_number": { "type": "string", "description": "Business fax number." }, "has_governing_document": { "type": "boolean", "description": "Indicate whether the NZ business has a governing document (e.g. a constitution, charter, rules, or a shareholders' agreement). Leave null when undeclared (do not default to false)." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_nominee_shareholders": { "type": "boolean", "description": "Indicate whether any of the individuals hold their shares on behalf of a third party." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "has_ringgit_borrowing": { "type": "boolean", "description": "Indicate whether the business engages in domestic Ringgit borrowing." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "no_shareholders_with_over_25percent": { "type": "boolean", "description": "Attestation of ownership structure without shareholders holding above 25% shares." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required for all business types except non-registered sole proprietors and businesses that do not have a business registration country.** If your business has no registration country, provide it in business_address.country_code instead. Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "registration_address_english": { "type": "object", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters).", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "state_of_incorporation": { "type": "string", "description": "The state where the business incorporated, different from registration state. (2-letter ISO 3166-2 state code)." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } } }, "business_person_details": { "type": "array", "description": "Information about the individuals that own or have a controlling interest in the business, or are authorized to act on behalf of the business. This list doesn't support partial update (i.e. one person of many), you need to pass the entire list for a successful update.", "items": { "type": "object", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PERSON_NAME_CHANGE_CERTIFICATE", "APPLICANT_SIGNATURE", "PROOF_OF_ADDRESS", "VIDEO_SELFIE", "PHOTO_SELFIE", "SUPPORTIVE_OTHER", "APPOINTMENT_DOCUMENT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format. Required for US accounts." }, "email": { "type": "string", "description": "Email of the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "first_name": { "type": "string", "description": "**Required for submit.** First name of the business person. 1–250 characters." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if first_name contains non-ASCII characters." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card. Required for all persons except director-only persons in AU/NZ, or when deferred identity verification is enabled.", "properties": { "primary": { "type": "object", "description": "**Required when identifications is provided.** Details of the primary identification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "**Required.** Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Country where the identification document is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Tax unique identifier number (e.g., SSN or ITIN for US persons)." }, "type": { "type": "string", "description": "**Required.** Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } }, "secondary": { "type": "object", "description": "Details of the secondary identity verification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } } } }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "**Required for submit.** Last name of the business person. 1–250 characters." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if last_name contains non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if middle_name contains non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code) Required for all persons except director-only persons in AU/NZ." }, "person_id": { "type": "string", "description": "Read-only. Unique Id of this person. Returned in responses after the person is created. Include this field when updating existing persons (API version 2023-06-01+) to update the correct record; omitting it creates a new person.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "residential_address": { "type": "object", "description": "Residential address of the business person. Required for all persons except director-only persons in AU/NZ.", "properties": { "address_line1": { "type": "string", "description": "**Required when residential_address is provided.** The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable. For US addresses, must include a house/building number." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required when residential_address is provided.** Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country. Required for US accounts." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country. Required for US accounts (2-letter state code)." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "roles": { "type": "array", "description": "**Required for submit.** Roles of the business person. At least one role must be specified. Allowed values: `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. A maximum of one person can hold AUTHORISED_PERSON, CONTROLLING_PERSON, or LEGAL_REPRESENTATIVE. The order is not guaranteed in response.", "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } } }, "individual_details": { "type": "object", "description": "Individual details including name, including name, address, face photo, and documents.", "properties": { "account_usage": { "type": "object", "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume.", "properties": { "card_usage": { "type": "array", "description": "Ways in which the account will use Airwallex borderless cards. \n`GENERAL_EXPENSES`, `BUSINESS_EXPENSES`, `EDUCATION`, \n`TRAVEL_TRANSPORT`, `INSURANCE`, `SERVICES`, \n`BILLS_UTILITIES`, `INVESTMENT`, `FEES_CHARGES`, \n`HEALTHCARE`, `HOUSING`, `NO_CARD_USAGE`.", "items": { "type": "string", "enum": [ "GENERAL_EXPENSES", "BUSINESS_EXPENSES", "EDUCATION", "TRAVEL_TRANSPORT", "INSURANCE", "SERVICES", "BILLS_UTILITIES", "INVESTMENT", "FEES_CHARGES", "HEALTHCARE", "HOUSING", "NO_CARD_USAGE" ] } }, "collection_country_codes": { "type": "array", "description": "Countries from which the account will be collecting funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "collection_from": { "type": "array", "description": "Sources and counterparties from which the account will be collecting funds. \n`ALLOWANCE_FROM_FAMILY`, `BENEFITS_FROM_STATE`, `EMPLOYMENT_INCOME`, \n`INVESTMENT_INCOME_NONPROPERTY`, `INCOME_FROM_PROPERTY`, \n`INCOME_FROM_MARKETPLLACES`, \n`INSURANCE`, `LOANS`, `SAVINGS`, `OTHER_THIRD_PARTIES`, \n`PAYMENT_REFUNDS`.", "items": { "type": "string", "enum": [ "ALLOWANCE_FROM_FAMILY", "BENEFITS_FROM_STATE", "EMPLOYMENT_INCOME", "INVESTMENT_INCOME_NONPROPERTY", "INCOME_FROM_PROPERTY", "INCOME_FROM_MARKETPLLACES", "INSURANCE", "LOANS", "SAVINGS", "OTHER_THIRD_PARTIES", "PAYMENT_REFUNDS" ] } }, "expected_monthly_transaction_volume": { "type": "object", "description": "Estimate of expected monthly transaction volume.", "properties": { "amount": { "type": "string", "description": "Estimate of the expected amount of money to be collected or paid out each month, in US dollars." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } } }, "payout_country_codes": { "type": "array", "description": "Countries to which the account will be paying funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "payout_to": { "type": "array", "description": "Beneficiaries and counterparties to which the account will be paying funds. \n`CONNECTED_AWX_ACCOUNT`, `EDUCATIONAL_INSTITUTIONS`, `FRIENDS_OR_RELATIVES`, \n`MARKETPLACE_PLATFORM`, `MARKETPLACE_SELLERS`, `MOBILITY_PLATFORM`, \n`OTHER_THIRD_PARTY_INDIVIDUALS`, `OWN_BANK_ACCOUNT`.", "items": { "type": "string", "enum": [ "CONNECTED_AWX_ACCOUNT", "EDUCATIONAL_INSTITUTIONS", "FRIENDS_OR_RELATIVES", "MARKETPLACE_PLATFORM", "MARKETPLACE_SELLERS", "MOBILITY_PLATFORM", "OTHER_THIRD_PARTY_INDIVIDUALS", "OWN_BANK_ACCOUNT" ] } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`CREATE_CARDS`, `MAKE_TRANSFERS`, `MARKETPLACE_WALLET`, \n`MOBILITY_WALLET`, `OTHERS`, `PAYROLL_WALLET`, \n`RECEIVE_TRANSFERS`, `TRADE_SECURITIES`, `TUITION_PAYMENTS`.", "items": { "type": "string", "enum": [ "CREATE_CARDS", "MAKE_TRANSFERS", "MARKETPLACE_WALLET", "MOBILITY_WALLET", "OTHERS", "PAYROLL_WALLET", "RECEIVE_TRANSFERS", "TRADE_SECURITIES", "TUITION_PAYMENTS" ] } } } }, "attachments": { "type": "object", "description": "Reference to uploaded identification document.", "properties": { "individual_documents": { "type": "array", "description": "Identity files for individual accounts.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "PERSON_NAME_CHANGE_CERTIFICATE", "PROOF_OF_ADDRESS", "SUPPORTIVE_OTHER", "VIDEO_SELFIE", "PHOTO_SELFIE" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the account user in YYYY-MM-DD format." }, "employer": { "type": "object", "description": "Information of the individual's employer.", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "Name of the employer." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with the individual's employer. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." } } }, "estimated_monthly_income": { "type": "object", "description": "Estimate of monthly income.", "properties": { "amount": { "type": "string", "description": "Estimate of monthly income." }, "currency": { "type": "string", "description": "Currency of the income. (3-letter ISO 4217 currency code)." } } }, "first_name": { "type": "string", "description": "First name of the account user." }, "first_name_english": { "type": "string", "description": "First name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card.", "properties": { "primary": { "type": "object", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "type": "object", "description": "Medicare card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } } }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Personal unique identifier.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "SSN", "ITIN" ] } } } } }, "secondary": { "type": "object", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "type": "object", "description": "Medicare card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } } }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Personal unique identifier.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "SSN", "ITIN" ] } } } } } } }, "last_name": { "type": "string", "description": "Last name of the account user." }, "last_name_english": { "type": "string", "description": "Last name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the account user." }, "middle_name_english": { "type": "string", "description": "Middle name of the account user. (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the account user. (2-letter ISO 3166-2 country code)." }, "occupation": { "type": "string", "description": "Occupation of the individual person.", "enum": [ "ACCOUNTANT", "ADMINISTRATION", "ARCHITECTURE", "ARTIST", "ATHLETE", "BEAUTY", "BUSINESSMAN", "CONSTRUCTION", "COOK", "DELIVERY", "DESIGNER", "ENGINEER", "FINANCE", "GOVERNMENT", "HEALTHCARE", "INSURANCE", "JOURNALIST", "LEGAL", "MANAGER", "MARKETING", "MEDIA", "MILITARY", "NURSE", "OFFICER", "OTHERS", "PILOT", "PROGRAMMER", "PRODUCTION", "REAL_ESTATE", "SALESPERSON", "SELF_EMPLOYMENT", "STUDENT", "SURVEYOR", "TEACHER", "TECHNICIAN", "TRAVEL", "UNEMPLOYED", "WAITER" ] }, "other_names": { "type": "array", "description": "Alias or other names of the individual person if different.", "items": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name (given name) of the individual person if different." }, "last_name": { "type": "string", "description": "Last name (family name) of the individual person if different." }, "middle_name": { "type": "string", "description": "Middle name of the individual person if different." } } } }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "Phone number of the account user, used for identity verification." }, "photo_holding_identification_file_id": { "type": "string", "description": "File id of a photo of the individual holding their identification. Applicable only if specifically requested by Airwallex." }, "residential_address": { "type": "object", "description": "Address of the account user.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required.** Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "residential_address_english": { "type": "object", "description": "Address of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the address field includes non-ASCII characters.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } } } }, "legal_entity_id": { "type": "string", "description": "Legal Entity unique identifier of the account. If not provided, new Legal Entity will be created." }, "legal_entity_type": { "type": "string", "description": "Type of account. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "store_details": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "description": "Relevant information associated with the store you are applying payment solutions for. For store field validation and error codes, see [store detail requirements](/docs/connected-accounts/onboarding/kyb-and-onboarding/native-api/store-detail-requirement).", "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex.", "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } } }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "CARDS", "BANK_DIRECT_DEBIT", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "type": "object", "description": "Physical address of the store.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } } } } }, "trustee_details": { "type": "object", "description": "Only applicable for SELF_MANAGED_SUPER_FUND business structure, information about the trustee which can be a business or an individual.", "properties": { "business_details": { "type": "object", "description": "Business details including the type of business, primary place of business, and industry type.", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "EIN_LETTER", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "TRUST_DEED", "UNIT_HOLDER_REGISTER", "UBO_SUPPORTIVE", "THIRD_PARTY_SHAREHOLDING_DOCUMENT" ] } } } } } }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority.." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business.", "items": { "type": "object", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PERSON_NAME_CHANGE_CERTIFICATE", "APPLICANT_SIGNATURE", "PROOF_OF_ADDRESS", "VIDEO_SELFIE", "PHOTO_SELFIE", "SUPPORTIVE_OTHER", "APPOINTMENT_DOCUMENT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format." }, "email": { "type": "string", "description": "Email of the business person." }, "first_name": { "type": "string", "description": "First name of the business person." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card.", "properties": { "primary": { "type": "object", "description": "Details of the primary identification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } }, "secondary": { "type": "object", "description": "Details of the secondary identity verification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } } } }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "Last name of the business person." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code)." }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person." }, "residential_address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "roles": { "type": "array", "description": "Roles of the business person. Any of `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. The order is not guaranteed in response.", "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } } }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "PARTNERSHIP", "SOLE_PROPRIETOR" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "registration_address_english": { "type": "object", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters).", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } } }, "individual_details": { "type": "array", "description": "Individual details including name, including name, address, face photo, and documents.", "items": { "type": "object", "properties": { "address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "attachments": { "type": "object", "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "identity_files": { "type": "array", "description": "Identity files.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "DRIVERS_LICENSE_FRONT", "DRIVERS_LICENSE_BACK", "PERSONAL_ID_FRONT", "PERSONAL_ID_BACK", "PASSPORT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the trustee in YYYY-MM-DD format." }, "first_name": { "type": "string", "description": "First name of the trustee." }, "first_name_english": { "type": "string", "description": "First name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identification_drivers_license_version": { "type": "string", "description": "Driver's license card number (not driver's license number) the trustee can provide." }, "identification_number": { "type": "string", "description": "Identification number the trustee can provide." }, "identification_type": { "type": "string", "description": "Identification type the trustee can provide." }, "last_name": { "type": "string", "description": "Last name of the trustee." }, "last_name_english": { "type": "string", "description": "Last name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the trustee. (2-letter ISO 3166-2 country code)." } } } }, "legal_entity_type": { "type": "string", "description": "Type of trustee. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } } } }, "customer_agreements": { "type": "object", "description": "Agreements collected from the user, such as acceptance of terms and conditions, or opt in for marketing.", "properties": { "agreed_to_biometrics_consent": { "type": "boolean", "description": "Consent to Airwallex collecting and processing the biometrics data (applicable if liveness check is conducted)." }, "agreed_to_data_usage": { "type": "boolean", "description": "Consent to Airwallex using the provided data, including consent for Airwallex to verify the identity of relevant individuals with Airwallex service providers and database owners in accordance with the Identity Verification Terms." }, "agreed_to_terms_and_conditions": { "type": "boolean", "description": "Agreement to abide by the Airwallex terms and conditions." }, "opt_in_for_marketing": { "type": "boolean", "description": "Agreement to receive email from Airwallex on news, promotions, etc." }, "terms_and_conditions": { "type": "object", "description": "Terms and conditions between Airwallex and the account holder.", "properties": { "agreed_at": { "type": "string", "description": "The timestamp marking when the account representative agreed to their service agreement in ISO 8601 format." }, "device_data": { "type": "object", "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis.", "properties": { "ip_address": { "type": "string", "description": "The IP address from which the account representative accepted their service agreement." }, "user_agent": { "type": "string", "description": "The user agent of the browser from which the account representative accepted their service agreement." } } }, "service_agreement_type": { "type": "string", "description": "The user’s service type of their agreement. Default to FULL.", "enum": [ "FULL", "RECIPIENT" ], "x-enumDescriptions": { "FULL": "[FULL service agreement](https://www.airwallex.com/terms/scale-user-terms-global) creates a service relationship between Airwallex and the account holder.", "RECIPIENT": "[RECIPIENT service agreement](https://www.airwallex.com/terms/recipient-agreement-global) clarifies that there is no service relationship between Airwallex and the recipient, and that the recipient’s relationship is with the platform. This service agreement type is required for creating [Ledger Account](/docs/payments-for-platforms/use-cases/payments-for-marketplaces)." } } } } } }, "identifier": { "type": "string", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format. You can specify up to 5 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "nickname": { "type": "string", "description": "Optional human-friendly account name." }, "primary_contact": { "type": "object", "description": "Contact information for the the primary contact of the Airwallex specified account. It is required to provide at least one form of contact information.", "properties": { "email": { "type": "string", "description": "A valid email address." }, "mobile": { "type": "string", "description": "A valid mobile phone number." } } } } }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "identifier": "", "metadata": { "id": "1" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" } } } } } }, "description": "account.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "identifier": "", "metadata": { "id": "1" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" } }, "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/account/amendments/create": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "10|Create an Account Amendment", "description": "Creates an amendment request to edit existing account data for an account that has passed KYC verification.", "operationId": "createAmendment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "primary_contact": { "type": "object", "description": "Contact information for the primary contact of the Airwallex specified account.", "properties": { "email": { "type": "string", "description": "A valid email address." }, "mobile": { "type": "string", "description": "A valid mobile phone number." } } }, "store_details": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "description": "Relevant information associated with the store you are applying payment solutions for. For store field validation and error codes, see [store detail requirements](/docs/connected-accounts/onboarding/kyb-and-onboarding/native-api/store-detail-requirement).", "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex.", "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } } }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "CARDS", "BANK_DIRECT_DEBIT", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "type": "object", "description": "Physical address of the store.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } } } } }, "target": { "type": "string", "description": "Target of the amendment.", "enum": [ "account_details.store_details", "primary_contact" ] } } }, "examples": { "default": { "value": { "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } } } }, "description": "request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Amendment" }, "examples": { "default": { "value": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/account/amendments/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" }, "response_body": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/account": { "get": { "tags": [ "Embedded Finance > Accounts" ], "summary": "3|Retrieve Account Details", "description": "Retrieve account details for your own Airwallex account.", "operationId": "detail", "x-oboSupported": false, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/account", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": true, "x-scope": [ { "scope": "platform_account:read", "group": "Core Resources", "resource_name": "Account Details", "oauthSupported": true, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts": { "get": { "tags": [ "Embedded Finance > Accounts" ], "summary": "4|List all Connected Accounts", "description": "Get list of accounts connected to your platform. If you’re not a platform, the list is empty.", "operationId": "listAccounts", "x-oboSupported": false, "parameters": [ { "name": "account_status", "in": "query", "description": "The status of the account.", "required": false, "schema": { "type": "string", "enum": [ "ACTION_REQUIRED", "ACTIVE", "CLOSED", "CREATED", "DORMANT", "SUBMITTED", "SUSPENDED" ], "x-enumDescriptions": { "ACTION_REQUIRED": "Additional information or action is required to continue.", "ACTIVE": "Account is active.", "CLOSED": "Account has been closed.", "CREATED": "Account has been created but not yet submitted.", "DORMANT": "Account is inactive due to prolonged inactivity.", "SUBMITTED": "Account has been submitted for review.", "SUSPENDED": "Account is temporarily suspended." } } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier.", "required": false, "schema": { "type": "string" } }, { "name": "metadata", "in": "query", "description": "The metadata of the account. The value should be set in key:value format. (e.g., id:1).", "required": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, maximum 500.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Account" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P Accounts" ], "summary": "9|Reactivate an Account", "description": "Change an account status from SUSPENDED to ACTIVE, effectively reactivating it. This status change also applies to all accounts under the same client legal entity. If multiple accounts are affected, the response will include account information for all impacted accounts.", "operationId": "reactivate", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Provides the additional comment message for the account reactivation." } } }, "examples": { "default": { "value": { "message": "Reactivate by platform through client API" } } } } }, "description": "reactivateRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "examples": { "default": { "value": [ { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } ] } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/reactivate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "message": "Reactivate by platform through client API" }, "response_body": [ { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } ] } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/{id}": { "get": { "tags": [ "Embedded Finance > Accounts" ], "summary": "2|Retrieve an Account", "description": "Get a connected account by unique identifier.", "operationId": "retrieveAccount", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounts/account_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:read", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/account/amendments/{amendment_id}": { "get": { "tags": [ "Embedded Finance > Accounts" ], "summary": "11|Retrieve an Account Amendment", "description": "Get an account amendment.", "operationId": "retrieveAmendment", "parameters": [ { "name": "amendment_id", "in": "path", "description": "Amendment unique identifier.", "required": true, "schema": { "type": "string", "default": "d1c27dbf-a6d8-4bac-a2e2-a03c7a79cc17" }, "examples": { "default": { "value": "amendment_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Amendment" }, "examples": { "default": { "value": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/account/amendments/amendment_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:read", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/account/wallet_info": { "get": { "tags": [ "Embedded Finance > Accounts" ], "summary": "12|Retrieve Account Wallet Information", "description": "Retrieve your own account number and account name which other businesses on Airwallex can find you with.", "operationId": "retrieveWalletInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountWalletInfo" }, "examples": { "default": { "value": { "account_name": "John Walker", "account_number": "4521908077956712" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/account/wallet_info", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_name": "John Walker", "account_number": "4521908077956712" } } ], "x-oauthSupported": true, "x-scope": [ { "scope": "account.wallet_info:read", "group": "Core Resources", "resource_name": "Wallet Info", "oauthSupported": true, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/accounts/{id}/submit": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "6|Submit an Account for Activation", "description": "To complete registration of an Airwallex account, all mandatory fields and documentation must be submitted in line with the relevant business structure and jurisdiction. Please note that you must use the applicable tag that corresponds to documents uploaded as stated in the ‘Create an account’ section. After account activation, if you update `primary_contact.email` or `primary_contact.mobile` using the ‘Update account’ endpoint, you need to submit the account in order for the changes to take effect (available for individual accounts only).", "operationId": "accounts_submit", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string", "default": "04580011-6378-4d75-af56-21bcf77c06b9" }, "examples": { "default": { "value": "account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/submit", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/{id}/suspend": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "8|Suspend an Account", "description": "Change an account status from ACTIVE to SUSPENDED, effectively suspending it. This is a temporary status change that can be reversed with Reactivate. For official account closure, use [Create an offboarding](/docs/api/scale/offboardings/create) instead. This status change also applies to all accounts under the same client legal entity. If multiple accounts are affected, the response will include account information for all impacted accounts.", "operationId": "accounts_suspend", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "The reason for the account suspension." } } }, "examples": { "default": { "value": { "message": "Suspend by platform through client API due to suspicious activity" } } } } }, "description": "suspendRequest.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "examples": { "default": { "value": [ { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } ] } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/suspend", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "message": "Suspend by platform through client API due to suspicious activity" }, "response_body": [ { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } ] } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/{id}/update": { "post": { "tags": [ "Embedded Finance > Accounts" ], "summary": "5|Update a Connected Account", "description": "Once a new account is created and connected to yours, you can come back and update the account information following the instructions below. You can update this information prior to submitting the account for activation.", "operationId": "updateAccount", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex account unique identifier.", "required": true, "schema": { "type": "string", "default": "04580011-6378-4d75-af56-21bcf77c06b9" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "account_details": { "type": "object", "description": "Relevant information associated with Airwallex account.", "properties": { "business_details": { "type": "object", "description": "Business details including the type of business, primary place of business and industry type.", "properties": { "account_usage": { "type": "object", "description": "The intended purpose of the account, such as product usage and monthly turnover.", "properties": { "estimated_monthly_revenue": { "type": "object", "description": "The approximate amount of revenue a business generates in a month.", "properties": { "amount": { "type": "string", "description": "The approximate amount of revenue a business generates in a month." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`ACCEPT_ONLINE_PAYMENTS`,`COLLECT_MARKETPLACE_PROCEEDS`, \n`RECEIVE_TRANSFERS`,`GET_PAID`,`CONVERT_FUNDS`, \n`MAKE_TRANSFERS`,`CREATE_CARDS`,`MANAGE_EXPENSES`, \n`USE_AWX_API`,`TRANSFER_CNY_INBOUND`.", "items": { "type": "string" } } } }, "as_trustee": { "type": "boolean", "description": "Sets up this account as a trustee on behalf of a trust." }, "attachments": { "type": "object", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "EIN_LETTER", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "TRUST_DEED", "UNIT_HOLDER_REGISTER", "UBO_SUPPORTIVE", "THIRD_PARTY_SHAREHOLDING_DOCUMENT" ] } } } } } }, "business_address": { "type": "object", "description": "The main location from which the business operates.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required when business_address is provided** — for non-registered sole proprietors and businesses without a business registration country. Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority.." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_name_trading": { "type": "string", "description": "Also known as a \"doing business as\" (DBA) name, refers to a name under which the business operates and conducts its activities, which may differ from its legal name." }, "business_start_date": { "type": "string", "description": "The date on which the business officially begins its operations in YYYY-MM-DD format." }, "business_structure": { "type": "string", "description": "The type of business structure.", "enum": [ "COMPANY", "PARTNERSHIP", "SOLE_PROPRIETOR" ] }, "contact_number": { "type": "string", "description": "The primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "fax_number": { "type": "string", "description": "Business fax number." }, "has_governing_document": { "type": "boolean", "description": "Indicate whether the NZ business has a governing document (e.g. a constitution, charter, rules, or a shareholders' agreement). Leave null when undeclared (do not default to false)." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "type": "object", "description": "The location where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required when registration_address is provided** — for all business types except non-registered sole proprietors and businesses without a business registration country. If your business has no registration country, provide it in business_address.country_code instead. Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "registration_address_english": { "type": "object", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters).", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "state_of_incorporation": { "type": "string", "description": "The state where the business incorporated, different from registration state. (2-letter ISO 3166-2 state code)." }, "trust_name": { "type": "string", "description": "Full name of the trust." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } } }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business. Each object represents an individual associated with the business (e.g., beneficial owner, director, authorized person).\n\n**Validation timing:** Most fields are accepted during an update call regardless of completeness. However, all fields marked as required below must be populated before the account can be submitted for KYC review via the Submit endpoint or the embedded KYC component.\n\n**Role requirements by country:** The array must collectively include at least one person for each required role: GB requires AUTHORISED_PERSON + BENEFICIAL_OWNER + DIRECTOR; US requires AUTHORISED_PERSON + BENEFICIAL_OWNER + DIRECTOR or CONTROLLING_PERSON; CN requires AUTHORISED_PERSON + BENEFICIAL_OWNER + LEGAL_REPRESENTATIVE; all other countries require AUTHORISED_PERSON + BENEFICIAL_OWNER.\n\n**Prefill behavior:** Data saved via this API is automatically prefilled in the embedded KYC component. For a person to appear in the KYC form, the `roles` field must be populated with at least one valid role. We recommend including `first_name`, `last_name`, and `roles` as the minimum payload for a visible, identifiable person entry.", "items": { "type": "object", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PERSON_NAME_CHANGE_CERTIFICATE", "APPLICANT_SIGNATURE", "PROOF_OF_ADDRESS", "VIDEO_SELFIE", "PHOTO_SELFIE", "SUPPORTIVE_OTHER", "APPOINTMENT_DOCUMENT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format. Required for US accounts." }, "email": { "type": "string", "description": "Email of the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "first_name": { "type": "string", "description": "**Required for submit.** First name of the business person. 1–250 characters." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if first_name contains non-ASCII characters." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card. Required for all persons except director-only persons in AU/NZ, or when deferred identity verification is enabled.", "properties": { "primary": { "type": "object", "description": "**Required when identifications is provided.** Details of the primary identification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "**Required.** Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Country where the identification document is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Tax unique identifier number (e.g., SSN or ITIN for US persons)." }, "type": { "type": "string", "description": "**Required.** Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } }, "secondary": { "type": "object", "description": "Details of the secondary identity verification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } } } }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "**Required for submit.** Last name of the business person. 1–250 characters." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if last_name contains non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if middle_name contains non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code) Required for all persons except director-only persons in AU/NZ." }, "person_id": { "type": "string", "description": "Read-only. Unique Id of this person. Returned in responses after the person is created. Include this field when updating existing persons (API version 2023-06-01+) to update the correct record; omitting it creates a new person.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "residential_address": { "type": "object", "description": "Residential address of the business person. Required for all persons except director-only persons in AU/NZ.", "properties": { "address_line1": { "type": "string", "description": "**Required when residential_address is provided.** The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable. For US addresses, must include a house/building number." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required when residential_address is provided.** Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country. Required for US accounts." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country. Required for US accounts (2-letter state code)." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "roles": { "type": "array", "description": "**Required for submit.** Roles of the business person. At least one role must be specified. Allowed values: `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. A maximum of one person can hold AUTHORISED_PERSON, CONTROLLING_PERSON, or LEGAL_REPRESENTATIVE. The order is not guaranteed in response.", "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } } }, "individual_details": { "type": "object", "description": "Individual details including name, date of birth, address, face photo, and documents.", "properties": { "account_usage": { "type": "object", "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume.", "properties": { "card_usage": { "type": "array", "description": "Ways in which the account will use Airwallex borderless cards. \n`GENERAL_EXPENSES`, `BUSINESS_EXPENSES`, `EDUCATION`, \n`TRAVEL_TRANSPORT`, `INSURANCE`, `SERVICES`, \n`BILLS_UTILITIES`, `INVESTMENT`, `FEES_CHARGES`, \n`HEALTHCARE`, `HOUSING`, `NO_CARD_USAGE`.", "items": { "type": "string", "enum": [ "GENERAL_EXPENSES", "BUSINESS_EXPENSES", "EDUCATION", "TRAVEL_TRANSPORT", "INSURANCE", "SERVICES", "BILLS_UTILITIES", "INVESTMENT", "FEES_CHARGES", "HEALTHCARE", "HOUSING", "NO_CARD_USAGE" ] } }, "collection_country_codes": { "type": "array", "description": "Countries from which the account will be collecting funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "collection_from": { "type": "array", "description": "Sources and counterparties from which the account will be collecting funds. \n`ALLOWANCE_FROM_FAMILY`, `BENEFITS_FROM_STATE`, `EMPLOYMENT_INCOME`, \n`INVESTMENT_INCOME_NONPROPERTY`, `INCOME_FROM_PROPERTY`, \n`INCOME_FROM_MARKETPLLACES`, \n`INSURANCE`, `LOANS`, `SAVINGS`, `OTHER_THIRD_PARTIES`, \n`PAYMENT_REFUNDS`.", "items": { "type": "string", "enum": [ "ALLOWANCE_FROM_FAMILY", "BENEFITS_FROM_STATE", "EMPLOYMENT_INCOME", "INVESTMENT_INCOME_NONPROPERTY", "INCOME_FROM_PROPERTY", "INCOME_FROM_MARKETPLLACES", "INSURANCE", "LOANS", "SAVINGS", "OTHER_THIRD_PARTIES", "PAYMENT_REFUNDS" ] } }, "expected_monthly_transaction_volume": { "type": "object", "description": "Estimate of expected monthly transaction volume.", "properties": { "amount": { "type": "string", "description": "Estimate of the expected amount of money to be collected or paid out each month, in US dollars." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } } }, "payout_country_codes": { "type": "array", "description": "Countries to which the account will be paying funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "payout_to": { "type": "array", "description": "Beneficiaries and counterparties to which the account will be paying funds. \n`CONNECTED_AWX_ACCOUNT`, `EDUCATIONAL_INSTITUTIONS`, `FRIENDS_OR_RELATIVES`, \n`MARKETPLACE_PLATFORM`, `MARKETPLACE_SELLERS`, `MOBILITY_PLATFORM`, \n`OTHER_THIRD_PARTY_INDIVIDUALS`, `OWN_BANK_ACCOUNT`.", "items": { "type": "string", "enum": [ "CONNECTED_AWX_ACCOUNT", "EDUCATIONAL_INSTITUTIONS", "FRIENDS_OR_RELATIVES", "MARKETPLACE_PLATFORM", "MARKETPLACE_SELLERS", "MOBILITY_PLATFORM", "OTHER_THIRD_PARTY_INDIVIDUALS", "OWN_BANK_ACCOUNT" ] } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`CREATE_CARDS`, `MAKE_TRANSFERS`, `MARKETPLACE_WALLET`, \n`MOBILITY_WALLET`, `OTHERS`, `PAYROLL_WALLET`, \n`RECEIVE_TRANSFERS`, `TRADE_SECURITIES`, `TUITION_PAYMENTS`.", "items": { "type": "string", "enum": [ "CREATE_CARDS", "MAKE_TRANSFERS", "MARKETPLACE_WALLET", "MOBILITY_WALLET", "OTHERS", "PAYROLL_WALLET", "RECEIVE_TRANSFERS", "TRADE_SECURITIES", "TUITION_PAYMENTS" ] } } } }, "attachments": { "type": "object", "description": "Reference to uploaded identification document.", "properties": { "individual_documents": { "type": "array", "description": "Identity files for individual accounts.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "PERSON_NAME_CHANGE_CERTIFICATE", "PROOF_OF_ADDRESS", "SUPPORTIVE_OTHER", "VIDEO_SELFIE", "PHOTO_SELFIE" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the account user in YYYY-MM-DD format." }, "employer": { "type": "object", "description": "Information of the individual's employer.", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "Name of the employer." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with the individual's employer. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." } } }, "estimated_monthly_income": { "type": "object", "description": "Estimate of monthly income.", "properties": { "amount": { "type": "string", "description": "Estimate of monthly income." }, "currency": { "type": "string", "description": "Currency of the income. (3-letter ISO 4217 currency code)." } } }, "first_name": { "type": "string", "description": "First name of the account user." }, "first_name_english": { "type": "string", "description": "First name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card.", "properties": { "primary": { "type": "object", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "type": "object", "description": "Medicare card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } } }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Personal unique identifier.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "SSN", "ITIN" ] } } } } }, "secondary": { "type": "object", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "type": "object", "description": "Medicare card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } } }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Personal unique identifier.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "SSN", "ITIN" ] } } } } } } }, "last_name": { "type": "string", "description": "Last name of the account user." }, "last_name_english": { "type": "string", "description": "Last name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the account user." }, "middle_name_english": { "type": "string", "description": "Middle name of the account user. (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the account user. (2-letter ISO 3166-2 country code)." }, "occupation": { "type": "string", "description": "Occupation of the individual person.", "enum": [ "ACCOUNTANT", "ADMINISTRATION", "ARCHITECTURE", "ARTIST", "ATHLETE", "BEAUTY", "BUSINESSMAN", "CONSTRUCTION", "COOK", "DELIVERY", "DESIGNER", "ENGINEER", "FINANCE", "GOVERNMENT", "HEALTHCARE", "INSURANCE", "JOURNALIST", "LEGAL", "MANAGER", "MARKETING", "MEDIA", "MILITARY", "NURSE", "OFFICER", "OTHERS", "PILOT", "PROGRAMMER", "PRODUCTION", "REAL_ESTATE", "SALESPERSON", "SELF_EMPLOYMENT", "STUDENT", "SURVEYOR", "TEACHER", "TECHNICIAN", "TRAVEL", "UNEMPLOYED", "WAITER" ] }, "other_names": { "type": "array", "description": "Alias or other names of the individual person if different.", "items": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name (given name) of the individual person if different." }, "last_name": { "type": "string", "description": "Last name (family name) of the individual person if different." }, "middle_name": { "type": "string", "description": "Middle name of the individual person if different." } } } }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "Phone number of the account user, used for identity verification." }, "photo_holding_identification_file_id": { "type": "string", "description": "File id of a photo of the individual holding their identification. Applicable only if specifically requested by Airwallex." }, "residential_address": { "type": "object", "description": "Address of the account user.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "**Required when residential_address is provided.** Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "residential_address_english": { "type": "object", "description": "Address of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the address field includes non-ASCII characters.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } } } }, "store_details": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "description": "Relevant information associated with the store you are applying payment solutions for. For store field validation and error codes, see [store detail requirements](/docs/connected-accounts/onboarding/kyb-and-onboarding/native-api/store-detail-requirement).", "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex.", "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } } }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "CARDS", "BANK_DIRECT_DEBIT", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "type": "object", "description": "Physical address of the store.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } } } } }, "trustee_details": { "type": "object", "description": "Details identifying the trustees. Only for SELF_MANAGED_SUPER_FUND business structure.", "properties": { "business_details": { "type": "object", "description": "Business details including the type of business, primary place of business, and industry type.", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "EIN_LETTER", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "TRUST_DEED", "UNIT_HOLDER_REGISTER", "UBO_SUPPORTIVE", "THIRD_PARTY_SHAREHOLDING_DOCUMENT" ] } } } } } }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority.." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business.", "items": { "type": "object", "properties": { "attachments": { "type": "object", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PERSON_NAME_CHANGE_CERTIFICATE", "APPLICANT_SIGNATURE", "PROOF_OF_ADDRESS", "VIDEO_SELFIE", "PHOTO_SELFIE", "SUPPORTIVE_OTHER", "APPOINTMENT_DOCUMENT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format." }, "email": { "type": "string", "description": "Email of the business person." }, "first_name": { "type": "string", "description": "First name of the business person." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identifications": { "type": "object", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card.", "properties": { "primary": { "type": "object", "description": "Details of the primary identification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } }, "secondary": { "type": "object", "description": "Details of the secondary identity verification.", "properties": { "drivers_license": { "type": "object", "description": "Driver's license.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } } }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "type": "object", "description": "Passport.", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } } }, "personal_id": { "type": "object", "description": "Other government-issued unique identifier card.", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } } }, "tax_id": { "type": "object", "description": "Tax unique identifier.", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } } } } } } }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "Last name of the business person." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code)." }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person." }, "residential_address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "roles": { "type": "array", "description": "Roles of the business person. Any of `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. The order is not guaranteed in response.", "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } } }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "PARTNERSHIP", "SOLE_PROPRIETOR" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "registration_address_english": { "type": "object", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters).", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } } }, "individual_details": { "type": "array", "description": "Individual details including name, including name, address, face photo, and documents.", "items": { "type": "object", "properties": { "address": { "type": "object", "description": "Address where the business is registered.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "attachments": { "type": "object", "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.).", "properties": { "identity_files": { "type": "array", "description": "Identity files.", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "DRIVERS_LICENSE_FRONT", "DRIVERS_LICENSE_BACK", "PERSONAL_ID_FRONT", "PERSONAL_ID_BACK", "PASSPORT" ] } } } } } }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the trustee in YYYY-MM-DD format." }, "first_name": { "type": "string", "description": "First name of the trustee." }, "first_name_english": { "type": "string", "description": "First name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identification_drivers_license_version": { "type": "string", "description": "Driver's license card number (not driver's license number) the trustee can provide." }, "identification_number": { "type": "string", "description": "Identification number the trustee can provide." }, "identification_type": { "type": "string", "description": "Identification type the trustee can provide." }, "last_name": { "type": "string", "description": "Last name of the trustee." }, "last_name_english": { "type": "string", "description": "Last name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the trustee. (2-letter ISO 3166-2 country code)." } } } }, "legal_entity_type": { "type": "string", "description": "Type of trustee. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } } } } }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format. You can specify up to 5 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "nickname": { "type": "string", "description": "Optional human-friendly account name." } } }, "examples": { "default": { "value": { "account_details": { "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "has_governing_document": false, "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "trust_name": "name", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "metadata": { "id": "1" }, "nickname": "" } } } } }, "description": "The account details to update.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "account_details": { "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "has_governing_document": false, "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "trust_name": "name", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "metadata": { "id": "1" }, "nickname": "" }, "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_governing_document": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "SSN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:write", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/charges/create": { "post": { "tags": [ "Embedded Finance > Charges" ], "summary": "1|Create a Charge", "description": "Create a charge to be applied to a connected account.", "operationId": "createCharge", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "reason", "reference", "request_id", "source" ], "properties": { "amount": { "type": "string", "description": "Amount of the charge in `currency`, representing how much to charge." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code)." }, "reason": { "type": "string", "description": "Reason for the charge instruction. One of: `wages_salary`, `donation_charitable_contribution`, `personal_remittance`, `transfer_to_own_account`, `pension`, `family_support`, `living_expenses`, `education_training`, `travel`, `investment_proceeds`, `investment_capital`, `loan_credit_repayment`, `taxes`, `goods_purchased`, `business_expenses`, `medical_services`, `professional_business_services`, `technical_services`, `other_services`, `construction`, `freight`, `real_estate`." }, "reference": { "type": "string", "description": "User specified reference that will be displayed to the beneficiary. 1-140 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier. 1-50 characters long." }, "source": { "type": "string", "description": "Airwallex account unique identifier." } } }, "examples": { "default": { "value": { "amount": "10000", "currency": "AUD", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source": "1936398" } } } } }, "description": "chargeRequestDto.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" }, "examples": { "default": { "value": { "amount": "10000", "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/charges/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "amount": "10000", "currency": "AUD", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "source": "1936398" }, "response_body": { "amount": "10000", "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_charge:write", "group": "Embedded Finance", "resource_name": "Charges", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/charges": { "get": { "tags": [ "Embedded Finance > Charges" ], "summary": "3|List all Charges", "description": "Get a list of charges created by your Airwallex account. The charges returned will be sorted by creation time.", "operationId": "listCharges", "parameters": [ { "name": "currency", "in": "query", "description": "Currency (3-letter ISO-4217 code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, minimum 10, maximum 2000.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "request_id", "in": "query", "description": "Charge `request_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Airwallex account unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } }, { "name": "status", "in": "query", "description": "Status of the charge, one of: `NEW`, `PENDING`, `SETTLED`,`SUSPENDED`, `FAILED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "NEW" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Charge" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": 10000, "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/charges", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": 10000, "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_charge:read", "group": "Embedded Finance", "resource_name": "Charges", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/charges/{id}": { "get": { "tags": [ "Embedded Finance > Charges" ], "summary": "2|Retrieve a Charge", "description": "Get the details of a charge that has previously been created. Supply the unique charge identifier that was returned at the time your created a new charge and Airwallex will return details of the corresponding charge.", "operationId": "retrieveCharge", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the charge to retrieve.", "required": true, "schema": { "type": "string", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "charge_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Charge" }, "examples": { "default": { "value": { "amount": 10000, "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/charges/charge_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": 10000, "created_at": "2017-03-22T16:08:02+1100", "currency": "AUD", "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "source": "1936398", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_charge:read", "group": "Embedded Finance", "resource_name": "Charges", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/connected_account_transfers/create": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "summary": "1|Create a Connected Account Transfer", "description": "Initiate a new connected account transfer to send funds from your Airwallex account to a connected account. Your Airwallex balance must cover the transfer amount or you will receive an “Insufficient Funds” error message.", "operationId": "createConnectedAccountTransfer", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "destination", "reason", "reference", "request_id" ], "properties": { "additional_info": { "type": "object", "description": "Additional information about the transaction.", "properties": { "card_payment_data": { "type": "object", "description": "Additional information about the card payment funding the connected account transfer.", "properties": { "amount": { "type": "string", "description": "The payment amount for this transaction." }, "brand": { "type": "string", "description": "The card brand. Possible enum values:", "enum": [ "MASTERCARD", "VISA", "UNION_PAY", "AMERICAN_EXPRESS", "JCB", "DISCOVER", "DINERS_CLUB_INTERNATIONAL" ] }, "card_issuing_country": { "type": "string", "description": "Country code where the card was issued (e.g., `US`, `GB`, `CN`)." }, "card_token": { "type": "string", "description": "A unique token (GUID) representing the customer’s card number." }, "card_type": { "type": "string", "description": "The card type. Possible enum values:", "enum": [ "CREDIT", "DEBIT", "PREPAID" ] }, "cardholder_name": { "type": "string", "description": "The cardholder's name. Not applicable to `APPLE_PAY` and `GOOGLE_PAY`." }, "created_at": { "type": "string", "description": "The timestamp when the customer created the payment transaction." }, "deposit_id": { "type": "string", "description": "The unique identifier of the deposit that corresponds to the settlement into Airwallex's Global Account." }, "ip_address": { "type": "string", "description": "IP address (IPv4 or IPv6) of the payer’s device at the time of payment." }, "payment_method": { "type": "string", "description": "The payment method used for this transaction. Possible enum values:", "enum": [ "APPLE_PAY", "GOOGLE_PAY", "CARD_ON_FILE" ] }, "three_dsecure_outcome": { "type": "string", "description": "The outcome of a 3D Secure authentication process, which verifies the identity of a cardholder during an online purchase. Possible enum values:", "enum": [ "ATTEMPTED", "AUTHENTICATED", "FAILED", "NOT_APPLICABLE", "NOT_REQUESTED" ] } } }, "merchant_data": { "type": "object", "description": "Structured merchant information for nested-flow transfers.", "properties": { "business_name": { "type": "string", "description": "The merchant's official legal name." }, "business_registration_date": { "type": "string", "description": "The date when the merchant's business was registered, in `YYYY-MM-DD` format. For example, `2025-03-15`." }, "business_registration_number": { "type": "string", "description": "The merchant's Business Registration Number (BRN) or equivalent identifier." }, "business_trading_name": { "type": "string", "description": "The merchant's trading or DBA (doing business as) name." }, "industry_category_code": { "type": "string", "description": "The merchant's industry category code." }, "merchant_identifier": { "type": "string", "description": "The merchant's unique identifier on the platform." }, "registration_country": { "type": "string", "description": "The merchant's country of registration in ISO 3166-1 alpha-2 format. For example, `CN` or `HK`." }, "store_urls": { "type": "array", "description": "The merchant's store URL(s).", "items": { "type": "string" } } } } } }, "amount": { "type": "string", "description": "Amount of the transfer in `currency`, representing how much to transfer." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code)." }, "destination": { "type": "string", "description": "Airwallex account unique identifier." }, "reason": { "type": "string", "description": "Reason for the transfer instruction. One of: `wages_salary`, `donation_charitable_contribution`, `personal_remittance`, `transfer_to_own_account`, `pension`, `family_support`, `living_expenses`, `education_training`, `travel`, `investment_proceeds`, `investment_capital`, `loan_credit_repayment`, `taxes`, `goods_purchased`, `business_expenses`, `medical_services`, `professional_business_services`, `technical_services`, `other_services`, `construction`, `freight`, `real_estate`." }, "reference": { "type": "string", "description": "User specified reference that will be displayed to the beneficiary. 1-140 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier. 1-50 characters long." } } }, "examples": { "default": { "value": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" }, "merchant_data": { "business_name": "", "business_registration_date": "", "business_registration_number": "", "business_trading_name": "", "industry_category_code": "", "merchant_identifier": "", "registration_country": "", "store_urls": [] } }, "amount": "10000", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } }, "description": "transferRequestDto.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedAccountTransfer" }, "examples": { "default": { "value": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" }, "merchant_data": { "business_name": "", "business_registration_date": "", "business_registration_number": "", "business_trading_name": "", "industry_category_code": "", "merchant_identifier": "", "registration_country": "", "store_urls": [] } }, "amount": "10000", "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n,\"insufficient_fund\"\n,\"validation_failed\"\n,\"request_id_duplicate\"\n,\"bad_request\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/connected_account_transfers/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" }, "merchant_data": { "business_name": "", "business_registration_date": "", "business_registration_number": "", "business_trading_name": "", "industry_category_code": "", "merchant_identifier": "", "registration_country": "", "store_urls": [] } }, "amount": "10000", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "response_body": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" }, "merchant_data": { "business_name": "", "business_registration_date": "", "business_registration_number": "", "business_trading_name": "", "industry_category_code": "", "merchant_identifier": "", "registration_country": "", "store_urls": [] } }, "amount": "10000", "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_transfer:write", "group": "Embedded Finance", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/connected_account_transfers": { "get": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "summary": "3|List all Connected Account Transfers", "description": "Get a list of connected account transfers created by your Airwallex account. The transfers returned are sorted by creation time.", "operationId": "listConnectedAccountTransfers", "parameters": [ { "name": "currency", "in": "query", "description": "Currency (3-letter ISO-4217 code).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } }, { "name": "destination", "in": "query", "description": "Airwallex account unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, minimum 10, maximum 2000.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "request_id", "in": "query", "description": "Transfer `request_id`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of the transfer. One of: `NEW`, `SETTLED`, `PENDING`, `SUSPENDED`, `FAILED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/ConnectedAccountTransfer" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": 10000, "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/connected_account_transfers", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": 10000, "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_transfer:read", "group": "Embedded Finance", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/connected_account_transfers/{id}": { "get": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "summary": "2|Retrieve a Connected Account Transfer", "description": "Get transaction details for a connected account transfer by specifying the transfer unique identifier.", "operationId": "retrieveConnectedAccountTransfer", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the connected account transfer to retrieve.", "required": true, "schema": { "type": "string", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "connected_account_transfer_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedAccountTransfer" }, "examples": { "default": { "value": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" } }, "amount": 10000, "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/connected_account_transfers/connected_account_transfer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "additional_info": { "card_payment_data": { "amount": "", "brand": "MASTERCARD", "card_issuing_country": "", "card_token": "", "card_type": "CREDIT", "cardholder_name": "", "created_at": "", "deposit_id": "", "ip_address": "", "payment_method": "APPLE_PAY", "three_dsecure_outcome": "ATTEMPTED" } }, "amount": 10000, "created_at": "2018-03-22T16:08:02+1100", "currency": "AUD", "destination": "acct_DjU6FcdYPYy6MEJsU0JAPg", "failure_reasons": [ "EXPIRED_TRANSACTION_RFI_PAYER", "EXPIRED_TRANSACTION_RFI_BENEFICIARY", "DORMANCY_KYC_NO_RESPONSE_PAYER", "DORMANCY_KYC_NO_RESPONSE_BENEFICIARY", "WEBSITE_KYC_NO_RESPONSE_PAYER", "WEBSITE_KYC_NO_RESPONSE_BENEFICIARY", "WATCHLIST_RESTRICTION_PAYER", "WATCHLIST_RESTRICTION_BENEFICIARY", "OTHER_HIGH_RISK_PAYER", "OTHER_HIGH_RISK_BENEFICIARY" ], "fee": 10, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "reason": "travel", "reference": "PMT1936398", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "D220926-QZ7BTZE", "status": "NEW", "updated_at": "2018-03-22T16:08:02+1100" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_transfer:read", "group": "Embedded Finance", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true } ], "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/hosted_flows/{id}/authorize": { "post": { "tags": [ "Embedded Finance > Hosted Flows" ], "summary": "3|Authorize a Flow", "description": "Explicitly authorize the user to access a created hosted flow instance. You can then redirect the user to the `url` link in the response.", "operationId": "hostedFlows_authorize", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the hosted flow instance.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "hosted_flow_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "identity": { "type": "string", "description": "The platform’s identifier for the user, such as a user unique identifier, session unique identifier, or access token." } } }, "examples": { "default": { "value": { "identity": "" } } } } }, "description": "request to create the flow instance." }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizedAWXHostedFlow" }, "examples": { "default": { "value": { "authorization_code": "", "id": "", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/hosted_flows/hosted_flow_id/authorize", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "identity": "" }, "response_body": { "authorization_code": "", "id": "", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "hosted_flow:write", "group": "Embedded Finance", "resource_name": "Hosted Flows", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/hosted_flows/create": { "post": { "tags": [ "Embedded Finance > Hosted Flows" ], "summary": "1|Create a Flow", "description": "Create a hosted flow instance for an account. Specify the `account_id` of the connected account for which you are creating the flow, and the hosted flow `template` provided by Airwallex.", "operationId": "createHostedFlow", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "account_id", "template" ], "properties": { "account_id": { "type": "string", "description": "Account unique identifier of the connected account for which the hosted flow instance is created." }, "error_url": { "type": "string", "description": "If set, the user will be redirected to this URL if an error occurs, with an extra query parameter `ahfi_id`." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the hosted flow." }, "return_url": { "type": "string", "description": "The user be redirected to this URL after finishing the flow, with an extra query parameter `ahfi_id`, this field is only required if Airwallex is hosting the experience." }, "template": { "type": "string", "description": "Unique identifier of the template that the created flow instance will follow." } } }, "examples": { "default": { "value": { "account_id": "acct_wst1AJZWbOx2Ijf-PDS123w", "error_url": "", "metadata": {}, "return_url": "", "template": "" } } } } }, "description": "request to create the flow instance." }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXHostedFlow" }, "examples": { "default": { "value": { "id": "ahfi_Y9_AbPkQQQe0K81XcHLy5w", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } } } } }, "400": { "description": "[\"Your account does not have a flow template\"\n,\"Account does not exist.\"\n\"Invalid value for return_url.\"\n]" }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/hosted_flows/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "account_id": "acct_wst1AJZWbOx2Ijf-PDS123w", "error_url": "", "metadata": {}, "return_url": "", "template": "" }, "response_body": { "id": "ahfi_Y9_AbPkQQQe0K81XcHLy5w", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "hosted_flow:write", "group": "Embedded Finance", "resource_name": "Hosted Flows", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/hosted_flows/{id}": { "get": { "tags": [ "Embedded Finance > Hosted Flows" ], "summary": "2|Retrieve a Flow", "description": "Get the AWX Hosted Flow instance by its unique identifier.", "operationId": "retrieveHostedFlow", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the hosted flow instance.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "hosted_flow_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXHostedFlow" }, "examples": { "default": { "value": { "id": "ahfi_Y9_AbPkQQQe0K81XcHLy5w", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/hosted_flows/hosted_flow_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "ahfi_Y9_AbPkQQQe0K81XcHLy5w", "metadata": {}, "result": {}, "status": "INIT", "url": "" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "hosted_flow:read", "group": "Embedded Finance", "resource_name": "Hosted Flows", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/invitation_links/create": { "post": { "tags": [ "Embedded Finance > Invitation Links" ], "summary": "1|Create an Account Invitation Link", "operationId": "createInvitationLink", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "mode" ], "properties": { "account_id": { "type": "string", "description": "Id of Airwallex account to be invited. Required for `scale_connect` mode, optional for `oauth2` mode. When provided, account must already be connected to partner or platform." }, "mode": { "type": "string", "description": "Invitation link mode. One of `oauth2`, `scale_connect`." }, "oauth2": { "type": "object", "required": [ "redirect_uri", "response_type", "scope" ], "description": "OAuth parameters, if invitation link mode is `oauth2`.", "properties": { "redirect_uri": { "type": "string", "description": "The platform callback URL redirected to after auth." }, "response_type": { "type": "string", "description": "This tells the Airwallex authorization server that the platform is initiating a Scale Invitation Link flow with OAuth mode. One of `code`." }, "scope": { "type": "array", "description": "The permissions the platform is requesting from the user.", "items": { "type": "string" } }, "state": { "type": "string", "description": "The platform generates a random string and includes it in the request. It should then check that the same value is returned after the user authorizes the app. Max length is 100 characters." } } }, "scale_connect": { "type": "object", "required": [ "redirect_uri" ], "description": "Scale connect parameters, if invitation link mode is `scale_connect`.", "properties": { "redirect_uri": { "type": "string", "description": "The platform callback URL redirected to after scale connect." } } }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format. You can specify up to 5 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "identifier": { "type": "string", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier. In oauth2 mode, identifier will be included in the query parameter when redirecting a user back to the client's redirect_uri. Max length is 1000 characters." }, "prefilled_formdata": { "type": "array", "description": "Data pre-filled by platform during new user signup.", "items": { "type": "object", "required": [ "field", "value" ], "properties": { "field": { "type": "string", "description": "the field name of pre filled form data.", "enum": [ "email", "first_name", "last_name", "mobile_number", "business_name", "country", "contact_name" ] }, "value": { "type": "string", "description": "The field value of pre-filled form data." }, "verified": { "type": "boolean", "description": "Whether the platform has verified the value." }, "editable": { "type": "boolean", "description": "Whether the user can edit the value." } } } } } }, "examples": { "default": { "value": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "metadata": { "id": "1" }, "identifier": "2fe425fd", "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ] } } } } }, "description": "link.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLink" }, "examples": { "default": { "value": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "created_at": "2021-07-13T15:56:57.006071Z", "expire_at": "2021-08-12T15:56:57.006071Z", "id": "link_V8CoOYobPMyBKyL-S59DtA", "identifier": "2fe425fd", "metadata": { "id": "1" }, "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ], "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "url": "https://www.sandbox.airwallex.com/connect/scale?invitationId=link_V8CoOYobPMyBKyL-S59DtA" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/invitation_links/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "metadata": { "id": "1" }, "identifier": "2fe425fd", "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ] }, "response_body": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "created_at": "2021-07-13T15:56:57.006071Z", "expire_at": "2021-08-12T15:56:57.006071Z", "id": "link_V8CoOYobPMyBKyL-S59DtA", "identifier": "2fe425fd", "metadata": { "id": "1" }, "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ], "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "url": "https://www.sandbox.airwallex.com/connect/scale?invitationId=link_V8CoOYobPMyBKyL-S59DtA" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "invitation_link:write", "group": "Embedded Finance", "resource_name": "Invitation Links", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/invitation_links/{id}": { "get": { "tags": [ "Embedded Finance > Invitation Links" ], "summary": "2|Retrieve an Account Invitation Link", "operationId": "retrieveInvitationLink", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex invitation link unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "invitation_link_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLink" }, "examples": { "default": { "value": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "created_at": "2021-07-13T15:56:57.006071Z", "expire_at": "2021-08-12T15:56:57.006071Z", "id": "link_V8CoOYobPMyBKyL-S59DtA", "identifier": "2fe425fd", "metadata": { "id": "1" }, "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ], "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "url": "https://www.sandbox.airwallex.com/connect/scale?invitationId=link_V8CoOYobPMyBKyL-S59DtA" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounts/invitation_links/invitation_link_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_id": "acct_hm-QFRVYO4-InXeIsCPKOg", "created_at": "2021-07-13T15:56:57.006071Z", "expire_at": "2021-08-12T15:56:57.006071Z", "id": "link_V8CoOYobPMyBKyL-S59DtA", "identifier": "2fe425fd", "metadata": { "id": "1" }, "mode": "oauth2", "oauth2": { "redirect_uri": "https://oauth.pstmn.io/v1/callback", "response_type": "code", "scope": [ "r:awx_action:balances_view", "r:awx_action:settings.account_details_view" ], "state": "xcoiv98y2kd22vusuye3kch" }, "prefilled_formdata": [ { "field": "email", "value": "charlotesmith@email.com", "verified": true, "editable": false } ], "scale_connect": { "redirect_uri": "https://www.pstmn.io/v1/callback" }, "url": "https://www.sandbox.airwallex.com/connect/scale?invitationId=link_V8CoOYobPMyBKyL-S59DtA" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "connected_account:read", "group": "Embedded Finance", "resource_name": "Connected Accounts", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/accounts/{account_id}/offboardings/create": { "post": { "tags": [ "Embedded Finance > Offboardings" ], "summary": "1|Create an Offboarding", "description": "Submit an offboarding request for a connected account. This creates an Airwallex Operations-owned\noffboarding case; it does not replace operations handling of the closure workflow.\n\nYou can create an offboarding for a connected account that is not already closed or\npending closure. Create Offboarding is not limited to `ACTIVE` accounts. While the\noffboarding case is `PENDING`, the connected account `status` does not change.\nAfter the offboarding completes successfully (`COMPLETED`), the account enters pending\nclosure and the connected account `status` returned by the client API is `SUSPENDED`\non all API versions. After a 30-day grace period the account is permanently closed;\nfrom API version `2026-08-21` that surfaces as `CLOSED` (earlier versions continue to\nreturn `SUSPENDED`).\n\nIf multiple connected accounts share the same client legal entity, you cannot create\nan offboarding for another account under that legal entity until the existing\noffboarding request is completed.\n\nUse this endpoint for official account closure. To temporarily disable an account,\nuse [Suspend account](/docs/api/scale/accounts/suspend) instead. Balance handling\nduring offboarding is managed by Airwallex operations and is not available through\nthis API.", "operationId": "createOffboarding", "x-oboSupported": false, "parameters": [ { "name": "account_id", "in": "path", "description": "The account ID of the connected account to offboard.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reason_code" ], "properties": { "comment": { "type": "string", "description": "Optional comment providing additional context for the offboarding request." }, "reason_code": { "type": "string", "description": "Reason code for offboarding the connected account. Possible values:\n\n * `COMMERCIAL_DECISION`: Account closure due to a commercial factors, such as account inactivity, low profitability, or other business-strategy reasons.\n * `INCOMPLETE_ONBOARDING_KYC`: The account holder signed up but did not complete KYC within specific timeframe.\n * `COMPANY_DISSOLVED_OR_LIQUIDATING`: The associated company has been dissolved or entered liquidation.\n\n * `POLICY_VIOLATION`: Offboarding due to a breach of the Acceptable Use Policy or Terms of Service. This includes operating an unsupported business model (e.g., prohibited industry, unsupported country) or actively misusing the account (e.g., personal use, circumvention of controls).\n * `FRAUDULENT_ACTIVITY`: Offboarding due to evidence of fraud. Some examples: application fraud (stolen/fake identity), merchant fraud, payment fraud, or card testing.\n * `SANCTIONS_EXPOSURE`: Offboarding due to a confirmed sanctions link or exposure, violating global sanctions policies.\n * `SUSPECTED_MONEY_LAUNDERING_OR_TERRORIST_FINANCING`: Offboarding due to suspicion of Money Laundering (ML), Terrorist Financing (TF), or other serious financial crimes, based on transaction patterns, unclear source of funds/wealth, or links to illicit activities (e.g., human trafficking, shell companies).\n * `REPUTATIONAL_RISK_OR_ADVERSE_MEDIA`: Offboarding due to negative public information (adverse media) or other factors that pose a significant reputational risk to Airwallex, even if not directly linked to a confirmed financial crime.\n * `NOT_COMPLY_WITH_ONGOING_REVIEWS`: Offboarding due to repeated failure to respond to Risk and Compliance-related Requests for Information (RFI) or Customer Due Diligence (CDD) reviews regarding their account activity.\n * `LINKAGE_TO_HIGH_RISK_CLIENT`: Offboarding due to a confirmed connection (e.g., shared ownership, validated linked devices) to another entity that has been flagged or offboarded for high-risk activity, such as fraud or financial crime.\n * `OTHER`: Client initiated closure or other reason if not listed above.\n" } } }, "examples": { "default": { "value": { "comment": "Account no longer needed", "reason_code": "OTHER" } } } } }, "description": "request.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Embedded_Finance_Offboarding" }, "examples": { "default": { "value": { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } } } } } }, "400": { "description": "[\"invalid_argument\"\n,\"bad_request\"\n,\"operation_failed\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/accounts/account_id/offboardings/create", "request_headers": { "Authorization": "Bearer ", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "comment": "Account no longer needed", "reason_code": "OTHER" }, "response_body": { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } } ], "x-scope": [ { "scope": "connected_account.offboarding:write", "group": "Embedded Finance", "resource_name": "Connected Account Offboardings", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/accounts/{account_id}/offboardings": { "get": { "tags": [ "Embedded Finance > Offboardings" ], "summary": "3|List all Offboardings", "description": "Retrieve a paginated list of offboardings for a connected account.", "operationId": "listOffboarding", "x-oboSupported": false, "parameters": [ { "name": "account_id", "in": "path", "description": "The account ID of the connected account to list offboardings for.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } }, { "name": "from_created_at", "in": "query", "description": "The start date of created_at in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve the next or previous page of results.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default 100, min 10, max 200.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "Status of offboarding request.", "required": false, "schema": { "type": "string", "enum": [ "CANCELLED", "COMPLETED", "PENDING" ] } }, { "name": "to_created_at", "in": "query", "description": "The end date of created_at in ISO8601 format (inclusive).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Embedded_Finance_Offboarding" } }, "page_after": { "type": "string", "description": "The page bookmark used for search the item after the result." }, "page_before": { "type": "string", "description": "The page bookmark used for search the item before the result." } } }, "examples": { "default": { "value": { "items": [ { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"invalid_argument\"\n,\"bad_request\"\n,\"operation_failed\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounts/account_id/offboardings", "request_headers": { "Authorization": "Bearer ", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "connected_account.offboarding:read", "group": "Embedded Finance", "resource_name": "Connected Account Offboardings", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/accounts/{account_id}/offboardings/{id}": { "get": { "tags": [ "Embedded Finance > Offboardings" ], "summary": "2|Retrieve an Offboarding", "description": "Retrieve details of a specific offboarding by its unique ID.", "operationId": "retrieveOffboarding", "x-oboSupported": false, "parameters": [ { "name": "account_id", "in": "path", "description": "The account ID of the connected account.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } }, { "name": "id", "in": "path", "description": "The unique ID of the offboarding case.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "offboarding_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Embedded_Finance_Offboarding" }, "examples": { "default": { "value": { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } } } } } }, "400": { "description": "[\"invalid_argument\"\n,\"bad_request\"\n,\"operation_failed\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "[\"not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/accounts/account_id/offboardings/offboarding_id", "request_headers": { "Authorization": "Bearer ", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "comment": "Account no longer needed", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "PENDING", "updated_at": "2026-04-10T12:00:00+0000" } } ], "x-scope": [ { "scope": "connected_account.offboarding:read", "group": "Embedded Finance", "resource_name": "Connected Account Offboardings", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/platform_liquidity_programs/{id}/program_spending_accounts/create": { "post": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "4|Create a Program Spending Account", "description": "Creates a spending account for a program, allowing access to program funds when transacting.", "operationId": "createProgramSpendingAccount", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "connected_account_id" ], "properties": { "connected_account_id": { "type": "string", "description": "Unique identifier of the Connected Account that the spending account is linked to." } }, "description": "Request to create a program spending account." }, "examples": { "default": { "value": { "connected_account_id": "ACCT_123e4567" } } } } }, "description": "Program spending account creation details.", "required": true }, "responses": { "201": { "description": "created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProgramSpendingAccountResponse" }, "examples": { "default": { "value": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/program_spending_accounts/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "connected_account_id": "ACCT_123e4567" }, "response_body": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/deposit": { "post": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "2|Deposit Funds Into a Program", "description": "Deposits funds into the program's settlement Airwallex account from the platform's wallet. The program limit balance will increase by the deposited amount.", "operationId": "deposit", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "request_id" ], "properties": { "amount": { "type": "number", "description": "Deposit amount, greater than 0." }, "currency": { "type": "string", "description": "Currency in 3-letter ISO-4217 format." }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client. It's used by Airwallex for idempotency check. In case of timeout, the client can retry with the same `request_id`." } }, "description": "Deposit request for platform liquidity program." }, "examples": { "default": { "value": { "amount": 500, "currency": "USD", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } }, "description": "Deposit details.", "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformLiquidityProgram" }, "examples": { "default": { "value": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/deposit", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 500, "currency": "USD", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "response_body": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/program_spending_accounts": { "get": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "6|List all Program Spending Accounts", "description": "Retrieve a list of spending accounts associated with a Platform Liquidity Program.", "operationId": "listProgramSpendingAccounts", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } }, { "name": "page", "in": "query", "description": "Page marker to retrieve the previous or next page of results. Set this field to the value returned by `page_before` or `page_after` to retrieve the previous or next page, respectively.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items to return per page, range [10, 100], default to 10.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 10, "maximum": 100, "default": 10 } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProgramSpendingAccounts" }, "examples": { "default": { "value": { "items": [ { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } ], "page_after": "eyJpZCI6ImIxMjM0NSJ9", "page_before": "eyJpZCI6ImEzNTUzMiJ9" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/program_spending_accounts", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } ], "page_after": "eyJpZCI6ImIxMjM0NSJ9", "page_before": "eyJpZCI6ImEzNTUzMiJ9" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/transactions": { "get": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "8|List all Program Transactions", "description": "Retrieve a list of transactions that contributed to the balance in the Platform Liquidity Program.", "operationId": "platformLiquidityPrograms_listTransactions", "x-oboSupported": false, "parameters": [ { "name": "connected_account_id", "in": "query", "description": "Unique identifier of the Connected Account that the spending account is linked to.", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "The transaction currency in 3-letter ISO-4217 format.", "required": false, "schema": { "type": "string" } }, { "name": "from_post_at", "in": "query", "description": "The start date (inclusive) of the date range during which balance activity occurred in your program fund balance. If not specified, `from_post_at` defaults to 7 days before `to_post_at`.", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } }, { "name": "page", "in": "query", "description": "Page marker to retrieve the previous or next page of results. Set this field to the value returned by `page_before` or `page_after` to retrieve the previous or next page, respectively.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Page size, range [10, 1000], default to 100.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "to_post_at", "in": "query", "description": "The end date (exclusive) of the date range during which the balance activity occurred in your program fund balance. Defaults to today if neither this field nor `from_post_at` are specified. If `from_post_at` is specified, then `to_post_at` defaults to 7 days after the `from_post_at` date.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProgramTransactions" }, "examples": { "default": { "value": { "items": [ { "amount": 500, "available_limit": 9500, "connected_account_id": "ACCT_123e4567", "currency": "USD", "id": "123e4567-e89b-12d3-a456-426614174000", "posted_at": "2023-06-01T15:30:00Z", "source_id": "123e4567-e89b-12d3-a456-426614174000", "transaction_type": "LIQUIDITY_AUTH_DEBIT" } ], "page_after": "eyJpZCI6ImIxMjM0NSJ9", "page_before": "eyJpZCI6ImEzNTUzMiJ9" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/transactions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "amount": 500, "available_limit": 9500, "connected_account_id": "ACCT_123e4567", "currency": "USD", "id": "123e4567-e89b-12d3-a456-426614174000", "posted_at": "2023-06-01T15:30:00Z", "source_id": "123e4567-e89b-12d3-a456-426614174000", "transaction_type": "LIQUIDITY_AUTH_DEBIT" } ], "page_after": "eyJpZCI6ImIxMjM0NSJ9", "page_before": "eyJpZCI6ImEzNTUzMiJ9" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/program_spending_accounts/{spending_account_id}/adjust_limits": { "post": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "7|Adjust Program Spending Account Limits", "description": "Updates a spending account's spending limits. Set `limit_policy` to `ENFORCED` to apply per-currency limits, or `BYPASSED` to turn them off. When enforcing, you can include `limit_adjustments` to raise or lower each currency's limit (a positive amount increases it, a negative amount decreases it). Leave `limit_adjustments` out when `limit_policy` is `BYPASSED`.", "operationId": "programSpendingAccountsAdjustLimits", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "enforced": { "value": "platform_liquidity_program_id" }, "bypassed": { "value": "platform_liquidity_program_id" } } }, { "name": "spending_account_id", "in": "path", "description": "Program Spending Account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "enforced": { "value": "spending_account_id" }, "bypassed": { "value": "spending_account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "limit_policy", "request_id" ], "properties": { "limit_adjustments": { "type": "array", "description": "Non-empty signed per-currency adjustments for `ENFORCED`; omitted for `BYPASSED`.", "items": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "Amount to adjust the available limit. Positive values increase the limit; negative values decrease it. Supports up to two decimal places." }, "currency": { "type": "string", "description": "Supported uppercase three-letter ISO 4217 currency code." } }, "description": "Signed adjustment to one currency's available limit." } }, "limit_policy": { "type": "string", "description": "Target limit policy.", "enum": [ "BYPASSED", "ENFORCED" ] }, "request_id": { "type": "string", "description": "A globally unique UUID specified by the client to ensure idempotency. If the request times out, retry with the same `request_id`." } }, "description": "Request to adjust a program spending account's limit policy and per-currency limits." }, "examples": { "enforced": { "value": { "limit_adjustments": [ { "amount": -300, "currency": "USD" } ], "limit_policy": "ENFORCED", "request_id": "550e8400-e29b-41d4-a716-446655440002" } }, "bypassed": { "value": { "limit_policy": "BYPASSED", "request_id": "550e8400-e29b-41d4-a716-446655440002" } } } } }, "description": "Target policy and optional signed limit adjustments.", "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramSpendingAccount" }, "examples": { "enforced": { "value": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } }, "bypassed": { "value": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_policy": "BYPASSED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "400": { "description": "`validation_error`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "`already_exists`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "[\"internal_error\"\n,\"service_unavailable\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "enforced", "name": "Enforced", "method": "POST", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/program_spending_accounts/spending_account_id/adjust_limits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "limit_adjustments": [ { "amount": -300, "currency": "USD" } ], "limit_policy": "ENFORCED", "request_id": "550e8400-e29b-41d4-a716-446655440002" }, "response_body": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } }, { "key": "bypassed", "name": "Bypassed", "method": "POST", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/program_spending_accounts/spending_account_id/adjust_limits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "limit_policy": "BYPASSED", "request_id": "550e8400-e29b-41d4-a716-446655440002" }, "response_body": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_policy": "BYPASSED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}": { "get": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "1|Retrieve a Program", "description": "Retrieve details of a Platform Liquidity Program.", "operationId": "retrievePlatformLiquidityProgram", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformLiquidityProgram" }, "examples": { "default": { "value": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/program_spending_accounts/{spending_account_id}": { "get": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "5|Retrieve a Program Spending Account", "description": "Retrieve details of a program spending account.", "operationId": "retrieveProgramSpendingAccounts", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } }, { "name": "spending_account_id", "in": "path", "description": "Program Spending Account unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "spending_account_id" } } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramSpendingAccount" }, "examples": { "default": { "value": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/program_spending_accounts/spending_account_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "connected_account_id": "ACCT_123e4567", "created_at": "2023-06-01T15:30:00Z", "funding_source_id": "123e4567-e89b-12d3-a456-426614174001", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 1300, "currency": "USD", "reserved_amount": 120, "total_amount": 1420 } ], "limit_policy": "ENFORCED", "status": "ACTIVE", "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_liquidity_programs/{id}/withdraw": { "post": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "summary": "3|Withdraw Funds From a Program", "description": "Withdraws funds from the program's settlement Airwallex account into the platform's wallet. The program limit balance will decrease by the withdrawn amount.", "operationId": "withdraw", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the program.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_liquidity_program_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "currency", "request_id" ], "properties": { "amount": { "type": "number", "description": "Withdraw amount, greater than 0." }, "currency": { "type": "string", "description": "Currency in 3-letter ISO-4217 format." }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client. It's used by Airwallex for idempotency check. In case of timeout, the client can retry with the same `request_id`." } }, "description": "Withdrawal request for platform liquidity program." }, "examples": { "default": { "value": { "amount": 500, "currency": "USD", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } }, "description": "Withdraw details.", "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformLiquidityProgram" }, "examples": { "default": { "value": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "`forbidden`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "`too_many_requests`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "`service_unavailable`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/platform_liquidity_programs/platform_liquidity_program_id/withdraw", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 500, "currency": "USD", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "response_body": { "created_at": "2023-06-01T15:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "limit_balances": [ { "available_amount": 10000, "currency": "HKD", "reserved_amount": 2000, "total_amount": 12000 } ], "supported_connected_account_regions": [ "HK", "SG" ], "name": "Merchant A Program", "status": "ACTIVE", "supported_currencies": [ { "currency": "HKD", "low_balance_threshold": 1000 } ], "updated_at": "2023-06-01T15:45:30Z" } } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_reports/create": { "post": { "tags": [ "Embedded Finance > Platform Reports" ], "summary": "1|Create a Platform Report", "description": "Create a new report. This request triggers an Airwallex job to generate a new report.\n\nA report id is returned that can then be used to retrieve the download link for that file ([Get Platform report](/docs/api/scale/platform_reports/retrieve)).", "operationId": "createPlatformReport", "x-oboSupported": false, "parameters": [ { "name": "x-api-version", "in": "header", "description": "x-api-version.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "file_format", "type" ], "properties": { "file_format": { "type": "string", "description": "File format of the report. Currently supported formats: `CSV`.", "enum": [ "CSV" ] }, "file_name": { "type": "string", "description": "File name requested for the report. If not provided, a file name will be automatically generated by Airwallex in the following format: `{REPORT_TYPE}_{TIMESTAMP}`. Format of `TIMESTAMP` is `YYYY-MM-DDThh:mm:ss+0000`." }, "from_created_at": { "type": "string", "description": "Timestamp (inclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `created_at` field in the `TRANSACTION_RECON_REPORT`\n * `created_at` field in the `PAYOUT_REPORT`\n * `created_at` field in the `ISSUING_TRANSACTION_REPORT`\n * `created_at` field in the `APPLICATION_FEE_REPORT`\n* `created_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n* `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_created_at` = `2023-01-01` and `to_created_at` = `2023-01-02` to obtain records created during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_created_at` and `to_created_at` is 366 days." }, "from_updated_at": { "type": "string", "description": "Timestamp (inclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `last_update` field in the `TRANSACTION_RECON_REPORT`\n * `last_update` field in the `PAYOUT_REPORT`\n * `last_update` field in the `ISSUING_TRANSACTION_REPORT`\n * `last_update` field in the `APPLICATION_FEE_REPORT`\n* `updated_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n* `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_updated_at` = `2023-01-01` and `to_updated_at` = `2023-01-02` to obtain records last updated during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_updated_at` and `to_updated_at` is 366 days." }, "to_created_at": { "type": "string", "description": "Timestamp (exclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `created_at` field in the `TRANSACTION_RECON_REPORT`\n * `created_at` field in the `PAYOUT_REPORT`\n * `created_at` field in the `ISSUING_TRANSACTION_REPORT`\n * `created_at` field in the `APPLICATION_FEE_REPORT`\n* `created_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n* `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_created_at` = `2023-01-01` and `to_created_at` = `2023-01-02` to obtain records created during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_created_at` and `to_created_at` is 366 days." }, "to_updated_at": { "type": "string", "description": "Timestamp (exclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `last_update` field in the `TRANSACTION_RECON_REPORT`\n * `last_update` field in the `PAYOUT_REPORT`\n * `last_update` field in the `ISSUING_TRANSACTION_REPORT`\n * `last_update` field in the `APPLICATION_FEE_REPORT`\n* `updated_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n* `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_updated_at` = `2023-01-01` and `to_updated_at` = `2023-01-02` to obtain records last updated during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_updated_at` and `to_updated_at` is 366 days." }, "type": { "type": "string", "description": "Type of report requested.", "enum": [ "TRANSACTION_RECON_REPORT", "PAYOUT_REPORT", "BALANCE_REPORT", "ACCOUNT_REPORT", "ISSUING_TRANSACTION_REPORT", "APPLICATION_FEE_REPORT", "PLATFORM_LIQUIDITY_TRANSACTION_REPORT", "PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT" ], "x-enumDescriptions": { "TRANSACTION_RECON_REPORT": "All financial transactions having occurred on your Platform account and connected accounts.", "PAYOUT_REPORT": "Details of all payouts out of your Platform account and connected accounts, across all payout statuses.", "BALANCE_REPORT": "Balances of your Platform account and connected accounts.", "ACCOUNT_REPORT": "Account-related information for your Platform and connected accounts, including KYC & KYB information.", "ISSUING_TRANSACTION_REPORT": "All issuing transactions having occurred on your Platform account and connected accounts.", "APPLICATION_FEE_REPORT": "A consolidated list of application fees that a Platform account charges its connected accounts.", "PLATFORM_LIQUIDITY_TRANSACTION_REPORT": "Transactions across all Platform Liquidity Program accounts under your Platform account, including both program accounts and program subscriber accounts.", "PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT": "End-of-day balances across all Platform Liquidity Program accounts under your Platform account, with one record per program, currency, and UTC calendar day." } } } }, "examples": { "default": { "value": { "file_format": "CSV", "file_name": "my_report_1", "from_created_at": "2023-01-01", "from_updated_at": "", "to_created_at": "2023-01-02", "to_updated_at": "", "type": "TRANSACTION_RECON_REPORT" } } } } }, "description": "request to create a Platform report.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScaleReportRes" }, "examples": { "default": { "value": { "id": "b4ac9a1e-8cd8-11ed-a1eb-0242ac1200a2" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]" }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/platform_reports/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "file_format": "CSV", "file_name": "my_report_1", "from_created_at": "2023-01-01", "from_updated_at": "", "to_created_at": "2023-01-02", "to_updated_at": "", "type": "TRANSACTION_RECON_REPORT" }, "response_body": { "id": "b4ac9a1e-8cd8-11ed-a1eb-0242ac1200a2" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_report:write", "group": "Embedded Finance", "resource_name": "Platform Reports", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/platform_reports/{id}": { "get": { "tags": [ "Embedded Finance > Platform Reports" ], "summary": "2|Retrieve a Platform Report", "description": "Retrieve the download URL of a report once the report is ready.\n\nSubscribe to the `Platform Report` webhook in the Airwallex webapp to be notified when the report that you have requested is ready.\n\nThe download link obtained is only valid for 1 minute, due to security considerations. If clients opens the link within 1 minute, the report download can be completed even if the total download time takes longer than 1 minute.", "operationId": "retrievePlatformReport", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Airwallex-generated unique identifier for the report.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "platform_report_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScaleReportRes" }, "examples": { "default": { "value": { "download_url": "", "download_url_expires_at": "2023-01-02T00:01:00+0000", "failed_reason": "REPORT_SIZE_LIMIT_EXCEEDED", "file_format": "CSV", "file_name": "my_report_1", "from_created_at": "2023-01-01T00:00:00+0000", "from_updated_at": "", "id": "b4ac9a1e-8cd8-11ed-a1eb-0242ac1200a2", "status": "COMPLETED", "to_created_at": "2023-01-02T00:00:00+0000", "to_updated_at": "", "type": "TRANSACTION_RECON_REPORT" } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]" }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/platform_reports/platform_report_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "download_url": "", "download_url_expires_at": "2023-01-02T00:01:00+0000", "failed_reason": "REPORT_SIZE_LIMIT_EXCEEDED", "file_format": "CSV", "file_name": "my_report_1", "from_created_at": "2023-01-01T00:00:00+0000", "from_updated_at": "", "id": "b4ac9a1e-8cd8-11ed-a1eb-0242ac1200a2", "status": "COMPLETED", "to_created_at": "2023-01-02T00:00:00+0000", "to_updated_at": "", "type": "TRANSACTION_RECON_REPORT" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "platform_report:read", "group": "Embedded Finance", "resource_name": "Platform Reports", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account", "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/psp_settlement_deposits": { "get": { "tags": [ "Embedded Finance > PSP Settlement Deposits" ], "summary": "1|List all PSP Settlement Deposits", "description": "Get a list of PSP settlement deposits sent to your account. The deposits returned are sorted by deposit time in descending order.", "operationId": "listPspSettlementDeposits", "x-oboSupported": false, "parameters": [ { "name": "deposit_id", "in": "query", "description": "Unique identifier of the deposit.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "from_deposited_at", "in": "query", "description": "The start date of `deposited_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "global_account_id", "in": "query", "description": "Global account unique identifier to which the funds were sent.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "holding_account_id", "in": "query", "description": "Holding account unique identifier into which the funds were deposited.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, minimum 10, maximum 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "status", "in": "query", "description": "PSP Settlement Deposit status. One of `NEW`, `MATCHED`, or `ACTION_REQUIRED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_deposited_at", "in": "query", "description": "The end date of `deposited_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementDeposit" }, "examples": { "default": { "value": { "amount": "10000", "currency": "AUD", "deposit_id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "deposited_at": "2022-09-22T16:08:02+1100", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "holding_account_id": "acct_wst1AJZWbOx2Ijf-PDS123w", "payer": { "name": "" }, "psp_settlement_intent_id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "reference": "PMT1936398", "requirements": { "matching_psp_settlement_required": { "message": "" }, "psp_settlement_intent_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "status": "ACTION_REQUIRED" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/psp_settlement_deposits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": "10000", "currency": "AUD", "deposit_id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "deposited_at": "2022-09-22T16:08:02+1100", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "holding_account_id": "acct_wst1AJZWbOx2Ijf-PDS123w", "payer": { "name": "" }, "psp_settlement_intent_id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "reference": "PMT1936398", "requirements": { "matching_psp_settlement_required": { "message": "" }, "psp_settlement_intent_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "status": "ACTION_REQUIRED" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_deposit:read", "group": "Embedded Finance", "resource_name": "PSP Settlement Deposits", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/{id}/cancel": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "6|Cancel a PSP Settlement Intent", "description": "Use this endpoint to cancel a PSP Settlement intent.\n \nIf the PSP settlement intent has been cancelled already or matched or settled with the corresponding PSP settlement deposit, then it cannot be cancelled.", "operationId": "pspSettlementIntents_cancel", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement intent to cancel.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_intent_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementIntent" }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_intents/psp_settlement_intent_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/create": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "1|Create a PSP Settlement Intent", "description": "Use this endpoint to share data with Airwallex on the *settlement* to be deposited by the PSP.\n \nData on a PSP Settlement should be shared with Airwallex before the pay-in PSP deposits funds into the holding account.\n\nPSP settlement intent is created with initial status `NEW`.", "operationId": "createPspSettlementIntent", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "currency", "expected_settlement_date", "global_account_id", "request_id", "settlement_reference" ], "properties": { "associate_by_deposit_ids": { "type": "array", "description": "Unique identifiers of the deposits associated with this PSP settlement intent. If present, these will be used instead of the `settlement_reference` field to associate deposits with this intent.", "items": { "type": "string" } }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) of this PSP settlement intent." }, "expected_settlement_date": { "type": "string", "description": "Expected date on which these funds will be deposited by the PSP into the global account, in `YYYY-MM-DD` format in the UTC timezone." }, "global_account_id": { "type": "string", "description": "Global account unique identifier that will accept the deposit for this PSP settlement intent." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this PSP settlement intent. This can be useful for storing additional information about it in a structured format.", "additionalProperties": { "type": "string" } }, "request_id": { "type": "string", "description": "Unique request identifier. Max length 50 characters." }, "settlement_reference": { "type": "string", "description": "The PSP settlement reference field refers to the reference attached by the pay-in PSP when sending the deposit to Airwallex. The pay-in PSP typically also includes this reference in settlement reports. Airwallex uses this field to match the PSP settlement splits you have created with funds received from the PSP. Min length 5 characters. Max length 255 characters." } } }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "currency": "USD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398" } } } } }, "description": "request.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementIntent" }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_intents/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "associate_by_deposit_ids": [], "currency": "USD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398" }, "response_body": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents": { "get": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "3|List all PSP Settlement Intents", "description": "Get a list of PSP settlement intents created by your account. The intents returned are sorted by creation time in descending order.", "operationId": "listPspSettlementIntents", "x-oboSupported": false, "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "global_account_id", "in": "query", "description": "Global account unique identifier of the PSP settlement intents.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, minimum 10, maximum 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "settlement_reference", "in": "query", "description": "Settlement reference that has been specified while creating PSP settlement intents.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "PSP Settlement Intent status. One of `NEW`, `SUBMITTED`, `MATCHED`, `ACTION_REQUIRED`, `SETTLED`, `CANCELLED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/SettlementIntent" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398", "status": "NEW" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/psp_settlement_intents", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398", "status": "NEW" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:read", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/{id}": { "get": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "2|Retrieve a PSP Settlement Intent", "description": "Get details for a PSP settlement intent by specifying the intent unique identifier.", "operationId": "retrievePspSettlementIntent", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement intent to retrieve.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_intent_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementIntent" }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/psp_settlement_intents/psp_settlement_intent_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:read", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/{id}/submit": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "5|Submit a PSP Settlement Intent", "description": "Submit a PSP settlement intent.\n \nThis means all PSP settlement split information for a PSP settlement intent has been provided, and it is ready to be matched with a PSP settlement deposit.", "operationId": "pspSettlementIntents_submit", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement intent to submit.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_intent_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementIntent" }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_intents/psp_settlement_intent_id/submit", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/{id}/update": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "summary": "4|Update a PSP Settlement Intent", "description": "Use this endpoint to update a PSP settlement intent data.\n\nPSP settlement intent values can only be updated if the current status is `NEW`, `ACTION_REQUIRED` or `SUBMITTED`.\n\nUpdating any of the fields `associate_by_deposit_ids`, `currency`, `global_account_id` or `settlement_reference` on a PSP settlement intent in status `ACTION_REQUIRED` changes the status to `SUBMITTED`.", "operationId": "updatePspSettlementIntent", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement intent to update.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_intent_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "associate_by_deposit_ids": { "type": "array", "description": "Unique identifiers of the deposits associated with this PSP settlement intent. If present, these will be used instead of the `settlement_reference` field to associate deposits with this intent.", "items": { "type": "string" } }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) of this PSP settlement intent." }, "expected_settlement_date": { "type": "string", "description": "Expected date on which these funds will be deposited by the PSP into the global account, in `YYYY-MM-DD` format in the UTC timezone." }, "global_account_id": { "type": "string", "description": "Global account unique identifier that will accept the funds for this PSP settlement intent." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this PSP settlement intent. This can be useful for storing additional information about it in a structured format.", "additionalProperties": { "type": "string" } }, "request_id": { "type": "string", "description": "Unique request identifier. Max length 50 characters." }, "settlement_reference": { "type": "string", "description": "The PSP settlement reference field refers to the reference attached by the pay-in PSP when sending the deposit to Airwallex. The pay-in PSP typically also includes this reference in settlement reports. Airwallex uses this field to match the PSP settlement splits you have created with funds received from the PSP. Min length 5 characters. Max length 255 characters." } } }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "currency": "USD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398" } } } } }, "description": "The updated values for the PSP settlement intent.", "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementIntent" }, "examples": { "default": { "value": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_intents/psp_settlement_intent_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "associate_by_deposit_ids": [], "currency": "USD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "settlement_reference": "PMT1936398" }, "response_body": { "associate_by_deposit_ids": [], "associated_deposit_ids": [], "created_at": "2022-09-22T16:08:02+1100", "currency": "AUD", "expected_settlement_date": "2022-08-26", "global_account_id": "3f457fe5-daf4-9962-92ec-10332301d9p3", "id": "psi_0iBwL9IuOZaKCz8Kn-01ew", "metadata": {}, "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "requirements": { "matching_psp_settlement_required": { "message": "" }, "reference_disambiguation_required": { "message": "" } }, "settlement_reference": "PMT1936398", "status": "NEW" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_splits/{id}/cancel": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "summary": "5|Cancel a PSP Settlement Split", "description": "If the PSP settlement split has not yet been matched, it can be cancelled (for example, if data had been shared wrongly previously.) After cancelling, the associated PSP settlement intent status becomes `NEW`. A new PSP settlement split should be created after cancellation to ensure all funds in the holding account are allocated to a seller, and the PSP settlement intent should be submitted again.", "operationId": "pspSettlementSplits_cancel", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement split to cancel.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_split_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementSplit" }, "examples": { "default": { "value": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_splits/psp_settlement_split_id/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_split:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Splits", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_splits": { "get": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "summary": "2|List all PSP Settlement Splits", "description": "Get list of PSP settlement splits created by your account. The splits returned are sorted by creation time in descending order.", "operationId": "listPspSettlementSplits", "x-oboSupported": false, "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "global_account_id", "in": "query", "description": "Global account unique identifier that accepted the deposit for the splits.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "holding_account_id", "in": "query", "description": "Airwallex holding account unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "The value you select to identify while creating the split.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100, minimum 10, maximum 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "psp_settlement_intent_id", "in": "query", "description": "Unique identifier of the PSP settlement intent associated with the PSP settlement splits.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "settlement_type", "in": "query", "description": "PSP Settlement Split settlement type. Could be either `CREDIT` or `DEBIT`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "PSP Settlement Split status. One of `NEW`, `RELEASED`, `PENDING`, `FAILED`, `SETTLED` or `CANCELLED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "target_account_id", "in": "query", "description": "Airwallex target account unique identifier.", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "The end date of `created_at` in ISO8601 format (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/SettlementSplit" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/psp_settlement_splits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } ] } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_split:read", "group": "Embedded Finance", "resource_name": "PSP Settlement Splits", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_splits/{id}/release": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "summary": "4|Release a PSP Settlement Split", "description": "Release the split when your Platform considers a seller ready to receive funds (for example, when a shopper has received goods). Funds are deducted from the holding account's balance, and are credited to the available balance of the respective seller connected accounts.\n\nReleasing a credit split results in net movement of funds from the holding account to the seller wallet. Releasing a debit split results in movement of funds in the opposite direction (from the connected account to the holding account).\n\nStatus of the split is moved to state `PENDING` first when we receive the request and then updated as `SETTLED` when the funds movement between holding account and target account completed successfully.", "operationId": "pspSettlementSplits_release", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement split to release.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_split_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier. 1-50 characters long." } } }, "examples": { "default": { "value": { "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } }, "description": "Request the release of a PSP settlement split." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementSplit" }, "examples": { "default": { "value": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_splits/psp_settlement_split_id/release", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" }, "response_body": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_split:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Splits", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_splits/{id}": { "get": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "summary": "1|Retrieve a PSP Settlement Split", "description": "Get details for a PSP settlement split by specifying the split unique identifier.", "operationId": "retrievePspSettlementSplit", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the PSP settlement split to retrieve.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_split_id" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementSplit" }, "examples": { "default": { "value": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "404": { "description": "NOT FOUND" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/psp_settlement_splits/psp_settlement_split_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amount": "10000", "created_at": "2022-09-22T16:08:02+1100", "id": "pss_78acasfou09cja", "settlement_type": "CREDIT", "status": "NEW", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_split:read", "group": "Embedded Finance", "resource_name": "PSP Settlement Splits", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/psp_settlement_intents/{psp_settlement_intent_id}/split": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "summary": "3|Split a PSP Settlement Intent", "description": "Use this endpoint to share data with Airwallex on the *funds* to be transferred to or from a target account as part of the PSP Settlement. When `settlement_type` is `CREDIT`, this is a payment to the target account. When `settlement_type` is `DEBIT`, this is a refund or chargeback.\n\nData on the amounts within a PSP Settlement should be shared with Airwallex before funds from the pay-in PSP settle in the holding account.\n\nEach PSP settlement split is created with an initial status of `NEW`.", "operationId": "splitPspSettlementIntent", "x-oboSupported": false, "parameters": [ { "name": "psp_settlement_intent_id", "in": "path", "description": "Unique identifier of the PSP settlement intent to split.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "psp_settlement_intent_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "splits" ], "properties": { "request_id": { "type": "string", "description": "Unique request identifier. Max length 50 characters." }, "splits": { "type": "array", "description": "A (partial) list of PSP Settlement Splits that comprise the PSP Settlement Intent. Maximum 2000 PSP Settlement Splits per call to this endpoint.", "items": { "type": "object", "required": [ "amount", "identifier", "settlement_type", "target_account_id" ], "properties": { "amount": { "type": "string", "description": "Amount of the PSP settlement split, representing how much to disburse to the account. Must always be positive." }, "identifier": { "type": "string", "description": "A value you select to identify this split, must be unique per PSP settlement intent, max length 40 symbols." }, "settlement_type": { "type": "string", "description": "Settlement type of the split, One of `CREDIT` or `DEBIT`." }, "target_account_id": { "type": "string", "description": "The Airwallex account receiving the credit or paying the debit." } } } } } }, "examples": { "default": { "value": { "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "splits": [ { "amount": "1000.5", "identifier": "PMT1936398", "settlement_type": "CREDIT", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } ] } } } } }, "description": "PSP Settlement Splits included in the PSP Settlement Intent.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntentSplit" }, "examples": { "default": { "value": { "psp_settlement_intent_id": "", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } } } } }, "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIntentSplit" } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\",\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/psp_settlement_intents/psp_settlement_intent_id/split", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "splits": [ { "amount": "1000.5", "identifier": "PMT1936398", "settlement_type": "CREDIT", "target_account_id": "acct_5SF2d1wFPZ-4WIHUBzOXXw" } ] }, "response_body": { "psp_settlement_intent_id": "", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2" } } ], "x-oauthSupported": false, "x-scope": [ { "scope": "psp_settlement_intent:write", "group": "Embedded Finance", "resource_name": "PSP Settlement Intents", "oauthSupported": false, "apiKeySupported": true } ], "x-resourceLevel": "account" } }, "/api/v1/audit_log/security_audit_logs": { "get": { "tags": [ "Security > Activity Log" ], "summary": "1|Security Audit Logs", "description": "Use this endpoint to get a list of security audit logs of the login account.\n\nSecurity audit logs includes activity related to: User management actions, User login actions, API key actions, 2FA actions, Login credential changes.", "operationId": "listSecurityAuditLogs", "x-oboSupported": false, "parameters": [ { "name": "end_event_time", "in": "query", "description": "The end date the audit log event time in ISO8601 format (exclusive), if not provided, default to from_event_time plus 180 days.", "required": false, "schema": { "type": "string" } }, { "name": "from_event_time", "in": "query", "description": "The start date of the audit log event time in ISO8601 format (inclusive), default and earliest value 2024-02-06T00:00:00+0800.", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page bookmark.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "Page size, default 100 if not provided, valid value 1-2000.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedSecurityAuditLog" }, "examples": { "default": { "value": { "items": [ { "account_id": "acct_TOslkS7-MnyXlQuV8Lb4og", "event_details": { "new_value": "test+111@airwallex.com" }, "event_time": "2022-06-08T06:41:37+0000", "event_type": "user.email.added", "id": "45a6d9c3-bdcd-3bbf-b592-10f287a87ccd", "operator_info": { "email": "test@airwallex.com", "mobile": "12345679", "type": "WEBAPP_ACCOUNT_USER" }, "session_info": { "application": "Chrome", "ip_address": "127.0.0.1", "location": "Hong Kong", "operating_system": "Mac OS X", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36" } } ], "page_after": "", "page_before": "" } } } } } }, "400": { "description": "[\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"Unauthorized\"\n,\"Insufficient permissions\"\n,\"credentials_invalid\"\n,\"credentials_expired\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/audit_log/security_audit_logs", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "account_id": "acct_TOslkS7-MnyXlQuV8Lb4og", "event_details": { "new_value": "test+111@airwallex.com" }, "event_time": "2022-06-08T06:41:37+0000", "event_type": "user.email.added", "id": "45a6d9c3-bdcd-3bbf-b592-10f287a87ccd", "operator_info": { "email": "test@airwallex.com", "mobile": "12345679", "type": "WEBAPP_ACCOUNT_USER" }, "session_info": { "application": "Chrome", "ip_address": "127.0.0.1", "location": "Hong Kong", "operating_system": "Mac OS X", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36" } } ], "page_after": "", "page_before": "" } } ], "x-scope": [ { "scope": "security.activity_log:read", "group": "Security", "resource_name": "Activity Log", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account", "x-badges": [ { "name": "Early access" } ] } }, "/api/v1/simulation/account/amendments/{id}/approve": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Accounts" ], "summary": "1|Approve an Account Amendment", "description": "Use this endpoint to approve an account amendment in PENDING status. Please note that the action is asynchronous and may take some time to complete. This endpoint does not guarantee an immediate status change upon request.", "operationId": "simulation_approveAmendment", "parameters": [ { "name": "id", "in": "path", "description": "Account amendment unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "account_id" } } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationAmendment" }, "examples": { "default": { "value": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/account/amendments/account_id/approve", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "response_body": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/account/amendments/{id}/reject": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Accounts" ], "summary": "2|Reject an Account Amendment", "description": "Use this endpoint to reject an account amendment in PENDING status. Please note that the action is asynchronous and may take some time to complete. This endpoint does not guarantee an immediate status change upon request.", "operationId": "simulation_rejectAmendment", "parameters": [ { "name": "id", "in": "path", "description": "Account amendment unique identifier.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "account_id" } } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationAmendment" }, "examples": { "default": { "value": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/account/amendments/account_id/reject", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 202, "reason_phrase": "Accepted", "response_body": { "id": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "status": "APPROVED", "store_details": { "cross_border_transaction_percent": "5.6", "dispute_percent": "1.5", "employee_size": 100, "estimated_transaction_volume": { "average_amount_per_transaction": "100", "currency": "AUD", "max_amount_per_transaction": "1000", "monthly_transaction_amount": "500000" }, "financial_statements": [ { "file_id": "your_file_id" } ], "fulfillment_days": 3, "industry_code": "ICCV3_0002XX", "mcc": "5599", "operating_models": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS" ], "payment_distribution": [], "refund_percent": "1.5", "selling_to_country_codes": [ "US", "CA" ], "shipping_from_country_codes": [ "US", "AU" ], "store_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "store_description": "I sell awesome products", "store_name": "My Awesome Store", "store_photos": [ { "file_id": "your_photo_file_id" } ], "store_websites": [ { "url": "https://my-awesome-store.com" } ] }, "target": "account_details.store_details" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/accounts/{account_id}/update_status": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Accounts" ], "summary": "3|Update Status of Connected Account", "description": "Use this endpoint to transition the status of a connected account to one of the following: ACTIVE, SUSPENDED. The connected account must be in the SUBMITTED state to transition statuses. Learn about the [connected account status lifecycle](https://airwallex.com/docs/global-treasury/connected-accounts/kyc-and-onboarding/simulate-connected-account-status-transition).", "operationId": "simulation_updateStatus", "parameters": [ { "name": "account_id", "in": "path", "description": "Connected account unique identifier.", "required": true, "schema": { "type": "string", "default": "acct_zwxZXgUJOTCL5J9v89FfJQ" }, "examples": { "default": { "value": "account_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "next_status" ], "properties": { "force": { "type": "boolean", "description": "Force the account to transition the status. This is true by default. If this is set to false, then any action_required state will not be cleared." }, "next_status": { "type": "string", "description": "The connected account status to transition to.", "enum": [ "ACTION_REQUIRED", "ACTIVE", "SUSPENDED" ] } } }, "examples": { "default": { "value": { "force": true, "next_status": "ACTIVE" } } } } }, "description": "payload", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationAccount" }, "examples": { "default": { "value": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "ITIN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "ITIN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/accounts/account_id/update_status", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "force": true, "next_status": "ACTIVE" }, "response_body": { "account_details": { "attachments": { "additional_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "business_details": { "account_usage": { "estimated_monthly_revenue": { "amount": "50000", "currency": "USD" }, "product_reference": [ "ACCEPT_ONLINE_PAYMENTS", "RECEIVE_TRANSFERS" ] }, "as_trustee": true, "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_name_trading": "", "business_start_date": "2023-10-11", "business_structure": "COMPANY", "contact_number": "6457892324", "description_of_goods_or_services": "", "explanation_for_high_risk_countries_exposure": "", "exports_goods_or_services": true, "has_member_holding_public_office": true, "has_nominee_shareholders": true, "has_prior_financial_institution_refusal": true, "has_ringgit_borrowing": true, "industry_category_code": "ICCV3_0000XX", "no_shareholders_with_over_25percent": true, "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "state_of_incorporation": "CA", "url": "http://www.your_company.com" }, "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "industry_category_code": "" }, "estimated_monthly_income": { "amount": "", "currency": "" }, "first_name": "Alice", "first_name_english": "Alice", "has_member_holding_public_office": false, "has_prior_financial_institution_refusal": false, "identifications": { "primary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "ITIN" } }, "secondary": { "drivers_license": { "back_file_id": "", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "gender": "F", "issuing_state": "VIC", "number": "6275046", "version": "" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "medicare_card": { "back_file_id": "", "card_number": "3395653571", "color": "GREEN", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "reference_number": "" }, "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "mrz_line1": "P", "effective_at": "2020-11-01", "expire_at": "2040-11-01", "front_file_id": "", "number": "" }, "tax_id": { "number": "", "type": "ITIN" } } }, "last_name": "Smith", "last_name_english": "Smith", "live_selfie_file_id": "", "middle_name": "Benedict", "middle_name_english": "Benedict", "nationality": "US", "occupation": "OTHERS", "other_names": [ { "first_name": "Alice", "last_name": "Benedict", "middle_name": "Benedict" } ], "person_id": "", "phone_number": "1-2025551234", "photo_holding_identification_file_id": "", "residential_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "residential_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" } }, "legal_entity_id": "", "legal_entity_type": "INDIVIDUAL", "trustee_details": { "business_details": { "attachments": { "business_documents": [ { "tag": "BUSINESS_LICENSE" } ] }, "business_identifiers": [ { "country_code": "US", "number": "A1098762872", "type": "BRN" } ], "business_name": "Swift Concrete Pty Ltd", "business_name_english": "Swift Concrete Pty Ltd", "business_person_details": [ { "attachments": { "business_person_documents": [ { "tag": "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER" } ] }, "date_of_birth": "1980-10-10", "email": "alice.smith@company.com", "first_name": "John", "first_name_english": "Alice", "identifications": { "primary": { "drivers_license": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "gender": "F", "issuing_state": "VIC", "number": "6275046" }, "identification_type": "PASSPORT", "issuing_country_code": "AU", "passport": { "effective_at": "2020-11-01", "expire_at": "2040-11-01", "mrz_line1": "P", "explanation_for_high_risk_countries_exposure": "", "industry_category_code": "ICCV3_0000XX", "operating_country": [ "US", "AU" ], "registration_address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "registration_address_english": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "url": "http://www.your_company.com" }, "individual_details": [ { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": { "identity_files": [ { "tag": "DRIVERS_LICENSE_FRONT" } ] }, "date_of_birth": "1980-10-10", "first_name": "John", "first_name_english": "Alice", "identification_drivers_license_version": "011536880", "identification_number": "AAA5417287BB", "identification_type": "PERSONAL_ID", "last_name": "Smith", "last_name_english": "Smith", "nationality": "US" } ], "legal_entity_type": "INDIVIDUAL" } }, "created_at": "", "customer_agreements": { "agreed_to_biometrics_consent": true, "agreed_to_data_usage": true, "agreed_to_terms_and_conditions": true, "opt_in_for_marketing": true, "terms_and_conditions": { "agreed_at": "2024-08-17T16:08:02+1100", "device_data": { "ip_address": "127.0.0.1", "user_agent": "Safari/537.36" }, "service_agreement_type": "FULL" } }, "id": "", "identifier": "", "metadata": {}, "next_action": { "type": "" }, "nickname": "", "primary_contact": { "email": "alice.smith@gmail.com", "mobile": "" }, "reactivate_details": { "message": "", "reactivated_at": "yyyy-MM-dd'T'HH:mm:ssZ" }, "requirements": { "agreement_to_terms_and_conditions_required": { "endpoint": "", "message": "Account has passed review. To activate the account, please agree to the terms and conditions by calling the endpoint.", "method": "POST" }, "other": [ { "error_code": "OTHER", "message": "Please contact customer support." } ], "photo_file_id_required": { "error_code": "FACE_CROPPED", "message": "Please retry the selfie. Your face was cropped.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" }, "photo_holding_id_required": [ { "error_code": "FACE_MATCHING_FAILED", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "message": "Please upload a photo of yourself holding your ID. Make sure nothing on the ID is covered — your face and ID details should be clear in the photo.", "photo_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=" } ], "primary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ], "reason_for_duplicate_account_required": [ { "error_code": "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "message": "Duplicate account found. Please confirm the reason for a second account." } ], "secondary_identification_required": [ { "back_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "error_code": "EXPIRED_DOCUMENT", "first_name": "Alice", "front_file_id": "Njg3MzkzNWMtMmNlNC00NDM3L=", "last_name": "Smith", "message": "Please upload a photo of a valid identification document. Document was expired.", "middle_name": "Benedict" } ] }, "status": "", "suspend_details": [ { "suspended_at": "yyyy-MM-dd'T'HH:mm:ssZ" } ], "view_type": "" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/billing/payment_sources/{id}/fail_next_autocharge": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "description": "Use this endpoint to simulate the failure of the next auto charge execution of a payment source. This will cause the next scheduled auto-charge to fail, allowing you to test error handling and retry logic in your billing workflows. This is only available in the Sandbox environment.", "operationId": "simulation_failPaymentSourceNextAutocharge", "x-oboSupported": false, "parameters": [ { "description": "Unique identifier of the Payment Source object.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "billing_id" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Simulation_Sandbox_Only_PaymentSource" }, "examples": { "default": { "value": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "cst_u79lnfufjxxfdc0", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } } } }, "description": "OK" }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "summary": "1|Fail Next Autocharge", "tags": [ "Simulation (Sandbox Only) > Billing" ], "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/billing/payment_sources/billing_id/fail_next_autocharge", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "billing_customer_id": "bcus_hkpd7fedfgb004apkvs", "created_at": "2022-01-01T10:15:30+0000", "external_id": "cst_u79lnfufjxxfdc0", "id": "psrc_d3Ds20ae5VihKs092", "linked_payment_account_id": "acct_ncI2nypPKSq2VXKxscAcg", "metadata": { "foo": "bar" }, "updated_at": "2022-01-01T10:15:30+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/deposit/create": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Deposits" ], "summary": "1|Create a Global Account Deposit", "description": "You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.", "operationId": "simulation_createDeposit", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "global_account_id" ], "properties": { "amount": { "type": "number", "description": "Amount to deposit into global account.", "minimum": 0, "maximum": 100000000 }, "global_account_id": { "type": "string", "format": "uuid", "description": "Global account unique identifier." }, "payer_bankname": { "type": "string", "description": "Name of the bank that the deposit is made from.", "minLength": 0, "maxLength": 255 }, "payer_country": { "type": "string", "description": "Payer country code of the transaction (2-letter ISO 3166-2 country code).", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "UNDEFINED", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XK", "XU", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "payer_name": { "type": "string", "description": "Name of the payer making the deposit.", "minLength": 0, "maxLength": 255 }, "reference": { "type": "string", "description": "Description of the deposit.", "minLength": 0, "maxLength": 255 }, "statement_ref": { "type": "string", "description": "Custom statement reference for this deposit. If a statement reference is provided, please note that it needs to be unique.", "minLength": 0, "maxLength": 255 }, "status": { "type": "string", "description": "Target next_status of this deposit. Default value is SETTLED.", "enum": [ "PENDING", "REJECTED", "SETTLED" ] } } }, "examples": { "default": { "value": { "amount": 1000, "global_account_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "payer_bankname": "", "payer_country": "AC", "payer_name": "1000", "reference": "", "statement_ref": "5487287788", "status": "SETTLED" } } } } }, "description": "payload", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationGaDeposit" }, "examples": { "default": { "value": { "amount": 10000, "create_time": "2017-03-22T16:08:02+1100", "currency": "AUD", "deposit_type": "CREDIT", "fee_amount": 10, "fee_currency": { "currency_code": "AED", "precision": 0, "value": "" }, "id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "payer_country": "US", "payer_name": "AMZNnt70paD1", "reference": "", "statement_ref": "5487287788", "status": "PENDING" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/deposit/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "amount": 1000, "global_account_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "payer_bankname": "", "payer_country": "AC", "payer_name": "1000", "reference": "", "statement_ref": "5487287788", "status": "SETTLED" }, "response_body": { "amount": 10000, "create_time": "2017-03-22T16:08:02+1100", "currency": "AUD", "deposit_type": "CREDIT", "fee_amount": 10, "fee_currency": { "currency_code": "AED", "precision": 0, "value": "" }, "id": "90b98dc6-63a0-403f-816b-ac5305b42a11", "payer_country": "US", "payer_name": "AMZNnt70paD1", "reference": "", "statement_ref": "5487287788", "status": "PENDING" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/deposits/{deposit_id}/reject": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Deposits" ], "summary": "4|Reject a Direct Debit Deposit", "description": "Rejects a pending deposit by transitioning the direct debit deposit status from `PENDING` to `REJECTED`.", "operationId": "simulation_reject", "parameters": [ { "name": "deposit_id", "in": "path", "description": "Unique identifier of the direct debit deposit.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "dd745da6-d48a-4347-87c2-3c33b920f5b1" }, "examples": { "default": { "value": "deposit_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/deposits/deposit_id/reject", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/deposits/{deposit_id}/reverse": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Deposits" ], "summary": "2|Reverse a Direct Debit Deposit", "description": "Creates a new direct debit deposit in the `SETTLED` state with an amount that offsets the original amount, i.e. negative value, and also deactivates the Linked Account. The original direct debit deposit will remain in the `SETTLED` state.", "operationId": "simulation_reverse", "parameters": [ { "name": "deposit_id", "in": "path", "description": "Unique identifier of the direct debit deposit.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "dd745da6-d48a-4347-87c2-3c33b920f5b1" }, "examples": { "default": { "value": "deposit_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/deposits/deposit_id/reverse", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/deposits/{deposit_id}/settle": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Deposits" ], "summary": "3|Settle a Direct Debit Deposit", "description": "Settles a pending deposit by transitioning the direct debit deposit status from `PENDING` to `SETTLED`.", "operationId": "simulation_settle", "parameters": [ { "name": "deposit_id", "in": "path", "description": "Unique identifier of the direct debit deposit.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "dd745da6-d48a-4347-87c2-3c33b920f5b1" }, "examples": { "default": { "value": "deposit_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/deposits/deposit_id/settle", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/card_transaction_lifecycles/{card_transaction_lifecycle_id}/capture": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "2|Capture the Card Transaction Lifecycle", "description": "Capture a card transaction lifecycle using the given lifecycle ID. This is only available in the sandbox environment.", "operationId": "simulation_captureTransaction", "parameters": [ { "name": "card_transaction_lifecycle_id", "in": "path", "description": "Unique identifier of the card transaction lifecycle to capture.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "merchant_info": { "type": "string", "description": "Merchant description." }, "transaction_amount": { "type": "number", "description": "Amount to capture. Providing an amount smaller than the full authorised amount will result in a partial capture of the indicated amount only. When not present, the full authorised amount will be captured." } } }, "examples": { "default": { "value": { "merchant_info": "Example", "transaction_amount": 100 } } } } }, "description": "payload", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTransaction" }, "examples": { "default": { "value": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "CLEARING", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "CLEARING", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/card_transaction_lifecycles/d8af1614-a6a1-4d45-aae7-6858fc6d9ede/capture", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "merchant_info": "Example", "transaction_amount": 100 }, "response_body": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "CLEARING", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "CLEARING", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/create": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "1|Create a Transaction for the Provided Card", "description": "Creates a transaction for the card_id (or card_number) provided, but does not capture the transaction. This is only available in the sandbox environment.", "operationId": "simulation_createIssuing", "parameters": [ { "name": "x-api-version", "in": "header", "description": "x-api-version.", "schema": { "type": "string" }, "examples": { "default": { "value": "2026-08-21" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "transaction_amount", "transaction_currency" ], "properties": { "auth_code": { "type": "string", "description": "Authorization code." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for card. Leave this blank if using card_number. If both card_number and card_id are provided, card_number will be used." }, "card_number": { "type": "string", "description": "Card Number." }, "merchant_category_code": { "type": "string", "description": "Merchant category code." }, "merchant_info": { "type": "string", "description": "Merchant description." }, "single_phase": { "type": "boolean", "description": "Set this to true to combine a single transaction that both authorizes and clears the transaction request. Defaults to false if not set. " }, "transaction_amount": { "type": "number", "description": "Transaction amount." }, "transaction_currency": { "type": "string", "description": "Currency of the transaction. Can only be one of USD, AUD, GBP, EUR, CAD, JPY, HKD, CNY, SGD, NZD, CHF." }, "transaction_failure_reason": { "type": "string", "description": "Set this field to simulate a failed transaction with the specific failure reason.", "enum": [ "CARDHOLDER_VERIFICATION_FAILED", "CVV_INVALID", "INVALID_EXPIRY_DATE", "PIN_INVALID", "PIN_RETRIES_EXCEEDED", "TRANSACTION_BLOCKED" ] }, "card_transaction_lifecycle_id": { "type": "string", "format": "uuid", "description": "The unique identifier of a card transaction lifecycle to associate with the new authorization." } } }, "examples": { "default": { "value": { "auth_code": "123312", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "4242424242424242", "merchant_category_code": "0742", "merchant_info": "Example", "single_phase": true, "transaction_amount": 100, "transaction_currency": "AUD", "transaction_failure_reason": "CVV_INVALID", "card_transaction_lifecycle_id": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" } } } } }, "description": "payload", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTransaction" }, "examples": { "default": { "value": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json", "x-api-version": "2026-08-21" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "auth_code": "123312", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "4242424242424242", "merchant_category_code": "0742", "merchant_info": "Example", "single_phase": true, "transaction_amount": 100, "transaction_currency": "AUD", "transaction_failure_reason": "CVV_INVALID", "card_transaction_lifecycle_id": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "response_body": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "AUTHORIZATION", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "AUTHORIZATION", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/threeds/notify": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "6|Send Threeds Notification for the Provided Card", "description": "Use this endpoint to send a threeds delegation mode notification for the provided card. Please note that this account must enable threeds delegation mode in notification configuration. This is only available in sandbox environment. ", "operationId": "simulation_notifyThreeds", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "card_number" ], "properties": { "card_number": { "type": "string", "description": "Card Number." }, "merchant_info": { "type": "object", "description": "Merchant Description.", "properties": { "acquirer_id": { "type": "string", "description": "Acquirer unique identifier." }, "merchant_category_code": { "type": "string", "description": "Merchant Category Code." }, "merchant_country_code": { "type": "string", "description": "Merchant Country Code." }, "merchant_id": { "type": "string", "description": "Merchant unique identifier." }, "merchant_name": { "type": "string", "description": "Merchant Name." }, "merchant_url": { "type": "string", "description": "Merchant URL." } } } } }, "examples": { "default": { "value": { "card_number": "4012000300000088", "merchant_info": { "acquirer_id": "459535", "merchant_category_code": "1200", "merchant_country_code": "US", "merchant_id": "641025a8-5845-477e-b9da-06dcd28d0d28", "merchant_name": "happyPay", "merchant_url": "http://www.happypay.com/" } } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "3DS notification processed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationThreedsNotification" }, "examples": { "default": { "value": { "status": "SUCCESS" } } } } } }, "400": { "description": "configuration_error or card_not_found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationThreedsNotification" } } } }, "401": { "description": "credentials_invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationError" } } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationThreedsNotification" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/threeds/notify", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "card_number": "4012000300000088", "merchant_info": { "acquirer_id": "459535", "merchant_category_code": "1200", "merchant_country_code": "US", "merchant_id": "641025a8-5845-477e-b9da-06dcd28d0d28", "merchant_name": "happyPay", "merchant_url": "http://www.happypay.com/" } }, "response_body": { "status": "SUCCESS" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/cardholders/{id}/pass_review": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "5|Pass Review Stage of a Cardholder", "description": "Use this endpoint to bypass the RFI process. Learn about the [cardholder status](/docs/issuing/get-started/create-cardholders/cardholder-statuses) and [Handle Cardholder Request for Information (RFI)](/docs/issuing/get-started/create-cardholders/handle-cardholder-rfi). This is only available in the sandbox environment.", "operationId": "simulation_passReviewCardholder", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the cardholder.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "issuing_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "not_found" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/cardholders/issuing_id/pass_review", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/refund": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "3|Refund a Transaction for the Provided Card", "description": "Refunds a transaction. This is only available in the sandbox environment.", "operationId": "simulation_refund", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "transaction_amount", "transaction_currency" ], "properties": { "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for card. Leave this blank if using card_number. If both card_number and card_id are provided, card_number will be used." }, "card_number": { "type": "string", "description": "Card Number." }, "merchant_category_code": { "type": "string", "description": "Merchant category code." }, "merchant_info": { "type": "string", "description": "Merchant description." }, "transaction_amount": { "type": "number", "description": "Transaction amount." }, "transaction_currency": { "type": "string", "description": "Currency of the transaction. Can only be one of USD, AUD, GBP, EUR, CAD, JPY, HKD, CNY, SGD, NZD, CHF." }, "card_transaction_lifecycle_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the original card transaction lifecycle to refund." } } }, "examples": { "default": { "value": { "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "4242424242424242", "merchant_category_code": "0742", "merchant_info": "Example", "transaction_amount": 100, "transaction_currency": "AUD", "card_transaction_lifecycle_id": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" } } } } }, "description": "payload", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTransaction" }, "examples": { "default": { "value": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "CLEARING", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "CLEARING", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/refund", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_number": "4242424242424242", "merchant_category_code": "0742", "merchant_info": "Example", "transaction_amount": 100, "transaction_currency": "AUD", "card_transaction_lifecycle_id": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "response_body": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "CLEARING", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "CLEARING", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/issuing/card_transaction_lifecycles/{card_transaction_lifecycle_id}/reverse": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Issuing" ], "summary": "4|Reverse the Card Transaction Lifecycle with the Provided Id", "description": "Reverse a card transaction lifecycle. This is only available in the sandbox environment.", "operationId": "simulation_reverseTransaction", "parameters": [ { "name": "card_transaction_lifecycle_id", "in": "path", "description": "Unique identifier of the card transaction lifecycle to reverse.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_amount": { "type": "number", "description": "Amount to reverse. Providing an amount smaller than the full authorised amount will result in a partial reversal of the indicated amount only. When not present, the full authorised amount will be reversed." } } }, "examples": { "default": { "value": { "transaction_amount": 100 } } } } }, "description": "payload", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTransaction" }, "examples": { "default": { "value": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "REVERSAL", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "REVERSAL_AUTH", "updated_at": "2018-03-22T16:08:02+00:00" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/issuing/card_transaction_lifecycles/d8af1614-a6a1-4d45-aae7-6858fc6d9ede/reverse", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "transaction_amount": 100 }, "response_body": { "auth_code": "000001", "billing_amount": 100, "billing_currency": "USD", "card_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "card_nickname": "", "client_data": "Some client data", "masked_card_number": "************4242", "merchant": { "category_code": "4829", "city": "Melbourne", "country": "Australia", "name": "Merchant A" }, "network_transaction_id": "3951729271768745", "process_result": "APPROVED", "retrieval_ref": "909916088001", "subtype": "REVERSAL", "transaction_amount": 100, "transaction_currency": "USD", "transacted_at": "2018-03-21T16:08:02+00:00", "card_transaction_event_id": "6c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_id": "7c2dc266-09ad-4235-b61a-767c7cd6d6ea", "card_transaction_lifecycle_id": "3c2dc266-09ad-4235-b61a-767c7cd6d6ea", "type": "REVERSAL_AUTH", "updated_at": "2018-03-22T16:08:02+00:00" } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/linked_accounts/{linked_account_id}/mandate/accept": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Linked Accounts" ], "summary": "1|Accept a Mandate", "description": "Accept a Mandate by transitioning the mandate status from `PROCESSING` to `ACTIVE`.", "operationId": "simulation_acceptMandate", "parameters": [ { "name": "linked_account_id", "in": "path", "description": "Unique identifier of the Linked Account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "f79e57a7-2323-4e8f-9bca-6c02afea1bc2" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"invalid_argument\",\"invalid_status_for_operation\"]" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/linked_accounts/linked_account_id/mandate/accept", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/linked_accounts/{linked_account_id}/mandate/cancel": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Linked Accounts" ], "summary": "3|Cancel a Mandate", "description": "Cancel a Mandate by transitioning the mandate status from `PROCESSING` or `ACTIVE` to `INACTIVE`.", "operationId": "simulation_cancelMandate", "parameters": [ { "name": "linked_account_id", "in": "path", "description": "Unique identifier of the Linked Account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "f79e57a7-2323-4e8f-9bca-6c02afea1bc2" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"invalid_argument\",\"invalid_status_for_operation\"]" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/linked_accounts/linked_account_id/mandate/cancel", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/linked_accounts/{linked_account_id}/fail_microdeposits": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Linked Accounts" ], "summary": "4|Fail a Micro Deposits Verification", "description": "Fail a Micro Deposits verification by transitioning the Linked Account status from `REQUIRES_ACTION` to `FAILED` with the reason `MICRO_DEPOSIT_FAILED`.", "operationId": "simulation_failMicrodeposits", "parameters": [ { "name": "linked_account_id", "in": "path", "description": "Unique identifier of the Linked Account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "f79e57a7-2323-4e8f-9bca-6c02afea1bc2" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"invalid_argument\",\"invalid_status_for_operation\"]" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/linked_accounts/linked_account_id/fail_microdeposits", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/linked_accounts/{linked_account_id}/mandate/reject": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Linked Accounts" ], "summary": "2|Reject a Mandate", "description": "Reject a Mandate by transitioning the mandate status from `PROCESSING` to `INACTIVE`.", "operationId": "simulation_rejectMandate", "parameters": [ { "name": "linked_account_id", "in": "path", "description": "Unique identifier of the Linked Account.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "f79e57a7-2323-4e8f-9bca-6c02afea1bc2" }, "examples": { "default": { "value": "linked_account_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" }, "examples": { "default": { "value": false } } } } }, "400": { "description": "[\"invalid_argument\",\"invalid_status_for_operation\"]" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/linked_accounts/linked_account_id/mandate/reject", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": false } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/accounts/{account_id}/offboardings/{id}/cancel": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Offboardings" ], "summary": "1|Cancel an Offboarding", "description": "Use this endpoint to simulate cancelling the offboarding of a connected account.", "operationId": "simulation_cancelOffboarding", "x-oboSupported": false, "parameters": [ { "name": "account_id", "in": "path", "description": "Connected account open ID.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } }, { "name": "id", "in": "path", "description": "Unique ID for the offboarding.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "offboarding_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Simulation_Sandbox_Only_Offboarding" }, "examples": { "default": { "value": { "comment": "offboard by platform through client api", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "CANCELLED", "updated_at": "2026-06-15T12:00:00+0000" } } } } } }, "400": { "description": "[\"invalid_argument\", \"invalid_status_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "credentials_invalid" }, "404": { "description": "[\"not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/accounts/account_id/offboardings/offboarding_id/cancel", "request_headers": { "Authorization": "Bearer ", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "comment": "offboard by platform through client api", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "CANCELLED", "updated_at": "2026-06-15T12:00:00+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/accounts/{account_id}/offboardings/{id}/complete": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Offboardings" ], "summary": "2|Complete an Offboarding", "description": "Use this endpoint to simulate completing the offboarding of a connected account.", "operationId": "simulation_completeOffboarding", "x-oboSupported": false, "parameters": [ { "name": "account_id", "in": "path", "description": "Connected account open ID.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "account_id" } } }, { "name": "id", "in": "path", "description": "Unique ID for the offboarding.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "offboarding_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Simulation_Sandbox_Only_Offboarding" }, "examples": { "default": { "value": { "comment": "offboard by platform through client api", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "COMPLETED", "updated_at": "2026-06-15T12:00:00+0000" } } } } } }, "400": { "description": "[\"invalid_argument\", \"invalid_status_for_operation\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "credentials_invalid" }, "404": { "description": "[\"not_found\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/accounts/account_id/offboardings/offboarding_id/complete", "request_headers": { "Authorization": "Bearer ", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "comment": "offboard by platform through client api", "created_at": "2026-03-24T10:00:00+0000", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reason_code": "OTHER", "status": "COMPLETED", "updated_at": "2026-06-15T12:00:00+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/payment_disputes/create": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Payment Acceptance" ], "summary": "2|Create a Payment Dispute", "description": "By creating a dispute, we raise a dispute for the merchant to respond.", "operationId": "simulation_createPaymentDispute", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "due_at", "payment_intent_id", "reason_code", "stage" ], "properties": { "amount": { "type": "number", "description": "The amount of dispute in transaction currency. The original payment amount is used by default." }, "comment": { "type": "string", "description": "The text description of why the dispute is raised." }, "documents": { "type": "array", "description": "The documents explain why the dispute is raised. The list of File unique identifiers submitted via File Service.", "items": { "type": "string" } }, "due_at": { "type": "string", "format": "date-time", "description": "The due date of dispute." }, "payment_intent_id": { "type": "string", "description": "The unique identifier of PaymentIntent to raise a dispute against." }, "reason_code": { "type": "string", "description": "The reason code for the dispute. Must be a valid reason code for the given processor." }, "stage": { "type": "string", "description": "The stage of dispute." } } }, "examples": { "default": { "value": { "amount": 100, "comment": "", "documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ" ], "due_at": "2025-05-20T13:14:00+0000", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "reason_code": "", "stage": "RFI" } } } } }, "description": "create dispute request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationPaymentDispute" }, "examples": { "default": { "value": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/payment_disputes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "amount": 100, "comment": "", "documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ" ], "due_at": "2025-05-20T13:14:00+0000", "payment_intent_id": "int_hkpdskz7vg1xc7uscdj", "reason_code": "", "stage": "RFI" }, "response_body": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/shopper_actions/{action}": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Payment Acceptance" ], "summary": "1|Simulate a Shopper Action", "description": "You can use this endpoint to simulate the shopper actions after obtaining a redirect URL for a PaymentIntent or PaymentConsent. Upon successful simulation of a shopper action on the given URL, a response with HTTP status `200 OK` and empty body will be returned. This endpoint is only available in the sandbox environment.", "operationId": "simulation_createShopperAction", "x-oboSupported": false, "parameters": [ { "name": "action", "in": "path", "description": "Action to simulate on a given redirect URL. Supported values are: \n \nPaymentIntent: `pay` and `reject`. \n \nPaymentConsent: `verify`.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "action" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The url with which shoppers actions will be simulated after redirection. Usually obtained from the response of [Confirm a PaymentIntent](/docs/api/payments/payment_intents/confirm) and [Verify a PaymentConsent](/docs/api/payments/payment_consents/verify)." } } }, "examples": { "default": { "value": { "url": "https://api.sandbox.airwallex.com/pa/sandbox/sg/mck_hkdmt2qn2gk5b13d15o" } } } } }, "description": "Request body for simulating shopper actions on a given URL.", "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request. Possible error codes: `validation_error`, `operation_not_supported`." }, "500": { "description": "Server Error. Possible error codes: `internal_error`." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/shopper_actions/action", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "url": "https://api.sandbox.airwallex.com/pa/sandbox/sg/mck_hkdmt2qn2gk5b13d15o" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/payment_disputes/{id}/escalate": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Payment Acceptance" ], "summary": "4|Escalate a Payment Dispute", "description": "By escalating a dispute, the evidence provided by the merchant is declined, and the dispute is escalated to the next stage.", "operationId": "simulation_escalatePaymentDispute", "parameters": [ { "name": "id", "in": "path", "description": "PaymentDispute unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "payment_acceptance_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "due_at" ], "properties": { "amount": { "type": "number", "description": "The adjusted amount of dispute." }, "comment": { "type": "string", "description": "The text description of why the dispute is escalated." }, "documents": { "type": "array", "description": "The documents explain why the dispute is escalated. The list of File unique identifiers submitted via File Service.", "items": { "type": "string" } }, "due_at": { "type": "string", "format": "date-time", "description": "The new due date of the dispute." } } }, "examples": { "default": { "value": { "amount": 100, "comment": "", "documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ" ], "due_at": "2025-08-14T09:14:00+0000" } } } } }, "description": "escalate dispute request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationPaymentDispute" }, "examples": { "default": { "value": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/payment_disputes/payment_acceptance_id/escalate", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 100, "comment": "", "documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ" ], "due_at": "2025-08-14T09:14:00+0000" }, "response_body": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/payment_disputes/{id}/resolve": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Payment Acceptance" ], "summary": "3|Resolve a Payment Dispute", "description": "By resolving a dispute, the dispute transitions to the final status.\n\n- When `in_favor_of` = `MERCHANT`, the dispute becomes `WON` or `REVERSED`\n- When `in_favor_of` = `CUSTOMER`, the dispute becomes `LOST`.", "operationId": "simulation_resolvePaymentDispute", "parameters": [ { "name": "id", "in": "path", "description": "PaymentDispute unique identifier.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "payment_acceptance_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "in_favor_of" ], "properties": { "amount": { "type": "number", "description": "The resolved amount. The full disputed amount is used by default." }, "comment": { "type": "string", "description": "The text explains why the dispute is resolved." }, "in_favor_of": { "type": "string", "description": "The party who is in favor of when resolving the dispute.", "enum": [ "CUSTOMER", "MERCHANT" ] } } }, "examples": { "default": { "value": { "amount": 100, "comment": "", "in_favor_of": "MERCHANT" } } } } }, "description": "resolve dispute request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationPaymentDispute" }, "examples": { "default": { "value": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/payment_disputes/payment_acceptance_id/resolve", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "amount": 100, "comment": "", "in_favor_of": "MERCHANT" }, "response_body": { "accept_details": [ { "accepted_at": "2023-09-18T03:11:00+0000", "accepted_by": "user@email.com", "description": "ACCEPT", "reason": "ee939540-3203-4a2c-9172-89a566485dd9", "refund": { "amount": 10, "reason": "REQUESTED_BY_CUSTOMER" } } ], "acquirer_reference_number": "789456", "amount": 100, "card_brand": "visa", "challenge_details": [ { "challenged_at": "2023-09-18T03:11:00+0000", "challenged_by": "test@airwallex.com", "customer_info": { "billing_address": "Billing address", "device_id": "00000000-000000000000000", "email": "test@airwallex.com", "ip": "212.121.222.123", "name": "John Deo", "phone_number": "13800000000" }, "delivery_info": { "address": "Shipping address", "delivered_at": "2023-09-18T03:11:00+0000", "fee_amount": 10, "fee_currency": "USD", "name": "Joe Doe", "phone_number": "13800000000", "shipped_at": "2023-09-18T03:11:00+0000", "shipping_company": "Shipping company", "shipping_method": "Shipping method", "status": "SHIPPED", "tracking_number": "123456" }, "order_info": { "created_at": "2023-09-18T03:11:00+0000", "id": "123456", "invoice_number": "456123", "products": [ { "currency": "USD", "name": "product", "quantity": 2, "unit_price": 100 } ], "total_amount": 200, "total_currency": "USD" }, "product_description": "product description", "product_type": "PHYSICAL_GOODS", "reason": "CUSTOMER_WITHDRAWN", "refund_refusal_reason": "reason", "seller_info": { "name": "seller", "store_name": "store", "store_physical_address": "store address", "store_url": "https://www.store-url.com" }, "stage": "CHARGEBACK", "supporting_documents": { "customer_communication_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "customer_signature_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "documents": [ { "description": "document descriptions.", "file_ids": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "type": "PRIMARY" } ], "duplicate_charge_defense_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "generated_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "other_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "proof_of_delivery_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "receipt_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "refund_policy_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ] } } ], "created_at": "2023-09-18T03:11:00+0000", "currency": "USD", "customer_id": "cus_ps8e0ZgQzd2QnCxVpzJrHD6KOVu", "customer_name": "John Doe", "due_at": "2023-09-18T03:11:00+0000", "id": "dst_nlstrf5jxgp32pfqbtq", "issuer_comment": "comment", "issuer_documents": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "merchant_order_id": "123456", "mode": "COLLABORATION", "payment_attempt_id": "att_nlstskcx5gipkzd6kse_dwsja0_decrp", "payment_intent_id": "int_nlstbs6rlgipjdwsja0_decrp", "payment_method_type": "VISA", "reason": { "description": "", "original_code": "", "type": "PRODUCT_NOT_RECEIVED" }, "refunds": [ { "acquirer_reference_number": "02709821210000001031868", "id": "rfd_ps8e0ZgQzd2QnCxVpzJrHD6KOVu" } ], "stage": "CHARGEBACK", "status": "RECEIVED", "transaction_type": "PAYMENT", "updated_at": "2023-09-18T03:11:00+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/rfis/{id}/close": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Request for Information (RFI)" ], "summary": "3|Close an RFI", "description": "Use this endpoint to close an RFI.", "operationId": "simulation_close", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the RFI.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "request_for_information_rfi_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationRfiSession" }, "examples": { "default": { "value": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/rfis/request_for_information_rfi_id/close", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/rfis/create": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Request for Information (RFI)" ], "summary": "1|Create an RFI", "description": "Use this endpoint to create an RFI for specific type.\nThe questions and related sources are simulated. \nAll RFIs for specified type must be in `CLOSED` status.", "operationId": "simulation_createRequestForInformationRfi", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type" ], "properties": { "questions": { "type": "array", "description": "The questions in this RFI.", "items": { "type": "object", "required": [ "answer" ], "properties": { "title": { "type": "object", "description": "Custom title for a newly created question, keyed by language code. Supported languages are `en`, `zh`, `fr`, and `vi`. If `title` is provided, `en` is required. Omitted languages retain their simulated defaults, while supplied languages beyond the built-in `en` and `zh` defaults are added. Ignored for questions that reuse an existing question by `id`. For questions rendered as structured forms (`ADDRESS`, `IDENTITY_DOCUMENT`, `LIVENESS`), the title is stored but the form's field label is displayed instead. Each value must be no more than 200 characters.", "properties": { "en": { "type": "string", "description": "Title in English. Required when `title` is provided." }, "zh": { "type": "string", "description": "Title in Chinese." }, "fr": { "type": "string", "description": "Title in French." }, "vi": { "type": "string", "description": "Title in Vietnamese." } } }, "description": { "type": "object", "description": "Custom description for a newly created question, keyed by language code. Supported languages are `en`, `zh`, `fr`, and `vi`. If `description` is provided, `en` is required. Same per-language fallback as `title`. Ignored for questions that reuse an existing question by `id`. Each value must be no more than 2000 characters.", "properties": { "en": { "type": "string", "description": "Description in English. Required when `description` is provided." }, "zh": { "type": "string", "description": "Description in Chinese." }, "fr": { "type": "string", "description": "Description in French." }, "vi": { "type": "string", "description": "Description in Vietnamese." } } }, "answer": { "type": "object", "required": [ "type" ], "description": "Expected response to the question.", "properties": { "type": { "type": "string", "description": "The expected type of response to the question.", "enum": [ "ADDRESS", "ATTACHMENT", "CONFIRMATION", "IDENTITY_DOCUMENT", "LIVENESS", "TEXT" ] } } }, "sources": { "type": "array", "description": "In the case where a question is linked to a specific source (such as a cardholder) then the source should be specified.", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the source." }, "type": { "type": "string", "description": "The type of the source. Valid values depend on the RFI type:: \n\n- `KYC`/`KYC_ONGOING`: `PERSON`\n- `CARDHOLDER`: `CARDHOLDER`\n- `MERCHANT_RISK`: `PAYMENT_INTENT`\n- `TRANSACTION`: `CHARGE`, `CONNECTED_ACCOUNT_TRANSFER`, `DIRECT_DEBIT`, `DEPOSIT`, `TRANSFER`." } } } } } } }, "type": { "type": "string", "description": "The type of RFI. Currently supports `KYC`, `KYC_ONGOING`, `CARDHOLDER`, `TRANSACTION`, `PAYMENT_ENABLEMENT` and `MERCHANT_RISK` types." } } }, "examples": { "default": { "value": { "questions": [ { "answer": { "type": "TEXT" }, "title": { "en": "Confirm your source of funds", "zh": "确认您的资金来源" }, "description": { "en": "Please describe the source of funds for this transaction.", "zh": "请说明该笔交易的资金来源。" }, "sources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "TRANSFER" } ] } ], "type": "KYC" } } } } }, "description": "create RFI request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationRfiSession" }, "examples": { "default": { "value": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/rfis/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "questions": [ { "answer": { "type": "TEXT" }, "title": { "en": "Confirm your source of funds", "zh": "确认您的资金来源" }, "description": { "en": "Please describe the source of funds for this transaction.", "zh": "请说明该笔交易的资金来源。" }, "sources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "TRANSFER" } ] } ], "type": "KYC" }, "response_body": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/rfis/{id}/follow_up": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Request for Information (RFI)" ], "summary": "2|Follow-up RFI", "description": "Use this endpoint to create a follow-up on an existing RFI. You can choose to retain the existing questions, append new ones, or both, depending on your testing needs.", "operationId": "simulation_followup", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the RFI.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "request_for_information_rfi_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "questions": { "type": "array", "description": "The questions in this RFI. You can refer to an existing question by its unique identifier, or append new questions by specifying the expected response type.", "items": { "type": "object", "properties": { "title": { "type": "object", "description": "Custom title for a newly created question, keyed by language code. Supported languages are `en`, `zh`, `fr`, and `vi`. If `title` is provided, `en` is required. Omitted languages retain their simulated defaults, while supplied languages beyond the built-in `en` and `zh` defaults are added. Ignored for questions that reuse an existing question by `id`. For questions rendered as structured forms (`ADDRESS`, `IDENTITY_DOCUMENT`, `LIVENESS`), the title is stored but the form's field label is displayed instead. Each value must be no more than 200 characters.", "properties": { "en": { "type": "string", "description": "Title in English. Required when `title` is provided." }, "zh": { "type": "string", "description": "Title in Chinese." }, "fr": { "type": "string", "description": "Title in French." }, "vi": { "type": "string", "description": "Title in Vietnamese." } } }, "description": { "type": "object", "description": "Custom description for a newly created question, keyed by language code. Supported languages are `en`, `zh`, `fr`, and `vi`. If `description` is provided, `en` is required. Same per-language fallback as `title`. Ignored for questions that reuse an existing question by `id`. Each value must be no more than 2000 characters.", "properties": { "en": { "type": "string", "description": "Description in English. Required when `description` is provided." }, "zh": { "type": "string", "description": "Description in Chinese." }, "fr": { "type": "string", "description": "Description in French." }, "vi": { "type": "string", "description": "Description in Vietnamese." } } }, "answer": { "type": "object", "required": [ "type" ], "description": "Expected response to the question, this is required if id is not passed.", "properties": { "type": { "type": "string", "description": "The expected type of response to the question.", "enum": [ "ADDRESS", "ATTACHMENT", "CONFIRMATION", "IDENTITY_DOCUMENT", "LIVENESS", "TEXT" ] } } }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the original RFI question, which will be reopened by this follow-up request." }, "sources": { "type": "array", "description": "In the case where a question is linked to a specific source (such as a cardholder) then the source should be specified.", "items": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the source." }, "type": { "type": "string", "description": "The type of the source. Valid values depend on the RFI type:: \n\n- `KYC`/`KYC_ONGOING`: `PERSON`\n- `CARDHOLDER`: `CARDHOLDER`\n- `MERCHANT_RISK`: `PAYMENT_INTENT`\n- `TRANSACTION`: `CHARGE`, `CONNECTED_ACCOUNT_TRANSFER`, `DIRECT_DEBIT`, `DEPOSIT`, `TRANSFER`." } } } } } } } } }, "examples": { "default": { "value": { "questions": [ { "answer": { "type": "TEXT" }, "id": "6f7f4efb-85bb-4bd9-a512-1a9a06c7f103", "sources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "TRANSFER" } ] } ] } } } } }, "description": "create RFI request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationRfiSession" }, "examples": { "default": { "value": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/rfis/request_for_information_rfi_id/follow_up", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "questions": [ { "answer": { "type": "TEXT" }, "id": "6f7f4efb-85bb-4bd9-a512-1a9a06c7f103", "sources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "TRANSFER" } ] } ] }, "response_body": { "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg", "active_request": { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" }, "answered_requests": [ { "created_at": "2023-04-12T07:29:36+0000", "expires_at": "2023-04-19T07:29:36+0000", "questions": [ { "answer": { "address": { "address_line1": "200 Collins Street", "address_line2": "200 Collins Street", "country_code": "AU", "postcode": "3000", "state": "VIC", "suburb": "Melbourne" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "identity_document": { "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3", "issuing_country": "AU", "number": "123456789", "type": "DRIVING_LICENSE" }, "type": "TEXT" }, "attachments": [ { "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ" } ], "comment": "Please provide more information", "description": { "en": "Information confirmation", "zh": "信息确认" }, "id": "ba7bfb51-77bc-4991-b651-0969ece1d263", "key": "PROOF_OF_ADDRESS", "liveness": { "status": "NOT_STARTED" }, "sources": [ { "id": "318ce9e9-c370-42bd-8192-e78283770c43", "person": { "first_name": "John", "last_name": "Smith" }, "type": "CARDHOLDER" } ], "title": { "en": "Information confirmation", "zh": "信息确认" }, "uploaded_orders": [ { "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec" } ] } ], "updated_at": "2023-04-14T07:29:36+0000" } ], "created_at": "2023-04-11T07:29:36+0000", "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92", "status": "ACTION_REQUIRED", "sub_type": "TRANSACTION_MONITORING", "type": "KYC", "updated_at": "2023-04-12T07:29:36+0000" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/pos/terminals/confirm_payment_intent": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Terminal Simulation" ], "summary": "4|Confirm Payment Using a Scenario", "description": "Confirm the current terminal's linked payment using a specific scenario.", "operationId": "simulation_confirrmPaymentIntent", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "payment_scenario_name", "terminal_id" ], "properties": { "payment_scenario_name": { "type": "string", "description": "Payment scenario name. You can retrieve supported values using the List payment scenarios API (/api/v1/simulation/pa/pos/terminals/payment_scenarios)." }, "terminal_id": { "type": "string", "description": "Terminal unique identifier." } } }, "examples": { "default": { "value": { "payment_scenario_name": "visa_chip_with_pin", "terminal_id": "ter_stnck59hc8ej0qujy" } } } } }, "description": "Confirm payment intent request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationConfirmPaymentIntent" }, "examples": { "default": { "value": { "payment_intent": { "id": "int_hkstfc294hc8ff7p1nn", "status": "REQUIRES_CAPTURE" }, "terminal_id": "ter_stnck59hc8ej0qujy" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/pos/terminals/confirm_payment_intent", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "payment_scenario_name": "visa_chip_with_pin", "terminal_id": "ter_stnck59hc8ej0qujy" }, "response_body": { "payment_intent": { "id": "int_hkstfc294hc8ff7p1nn", "status": "REQUIRES_CAPTURE" }, "terminal_id": "ter_stnck59hc8ej0qujy" } } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/pos/terminals/generate_activation_code": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Terminal Simulation" ], "summary": "1|Generate an Activation Code", "description": "Generates an activation code for the terminal owner to enter in the Airwallex web app to activate the terminal device.", "operationId": "simulation_geneerateActivationCode", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id" ], "properties": { "request_id": { "type": "string", "description": "UUID of the request." } } }, "examples": { "default": { "value": { "request_id": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "description": "Generate activation code request.", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationGenerateActivationCode" }, "examples": { "default": { "value": { "activation_code": "5W0D3E8L", "expires_at": 1761031320416 } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/pos/terminals/generate_activation_code", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "request_id": "123e4567-e89b-12d3-a456-426614174000" }, "response_body": { "activation_code": "5W0D3E8L", "expires_at": 1761031320416 } } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/pos/terminals/payment_scenarios": { "get": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Terminal Simulation" ], "summary": "5|List all Available Payment Scenarios", "description": "Retrieves all payment scenarios supported by the sandbox environment for in-person payment flows.", "operationId": "simulation_listPaymentScenarios", "x-oboSupported": false, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationAvailableScenarioNames" }, "examples": { "default": { "value": { "items": [ { "description": "Mastercard chip card without PIN verification.", "name": "mastercard_chip_no_pin" } ] } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/simulation/pa/pos/terminals/payment_scenarios", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "description": "Mastercard chip card without PIN verification.", "name": "mastercard_chip_no_pin" } ] } } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/pos/terminals/turn_off": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Terminal Simulation" ], "summary": "3|Turn Off a Terminal", "description": "Turns off the terminal device.", "operationId": "simulation_turnOff", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "terminal_id" ], "properties": { "terminal_id": { "type": "string", "description": "Terminal unique identifier." } } }, "examples": { "default": { "value": { "terminal_id": "ter_stnck59hc8ej0qujy" } } } } }, "description": "Turn off terminal request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTerminalStatus" }, "examples": { "default": { "value": { "connection_status": "CONNECTED", "terminal_id": "ter_stnck59hc8ej0qujy" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/pos/terminals/turn_off", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "terminal_id": "ter_stnck59hc8ej0qujy" }, "response_body": { "connection_status": "CONNECTED", "terminal_id": "ter_stnck59hc8ej0qujy" } } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/pa/pos/terminals/turn_on": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Terminal Simulation" ], "summary": "2|Turn on a Terminal", "description": "Turns on the terminal device.", "operationId": "simulation_turnOn", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "terminal_id" ], "properties": { "terminal_id": { "type": "string", "description": "Terminal unique identifier." } } }, "examples": { "default": { "value": { "terminal_id": "ter_stnck59hc8ej0qujy" } } } } }, "description": "Turn on terminal request.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTerminalStatus" }, "examples": { "default": { "value": { "connection_status": "CONNECTED", "terminal_id": "ter_stnck59hc8ej0qujy" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "404": { "description": "not_found" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/pa/pos/terminals/turn_on", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "terminal_id": "ter_stnck59hc8ej0qujy" }, "response_body": { "connection_status": "CONNECTED", "terminal_id": "ter_stnck59hc8ej0qujy" } } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/simulation/transfers/{id}/transition": { "post": { "servers": [ { "url": "https://api.sandbox.airwallex.com", "description": "Sandbox" } ], "tags": [ "Simulation (Sandbox Only) > Transfers" ], "summary": "1|Transition Transfer Status", "description": "You can use this endpoint to simulate the status transition of your transfer. This is only available in the Sandbox environment. Learn about the [transfer status lifecycle](/docs/payouts/transfers/create-a-transfer/transfer-statuses).", "operationId": "simulation_transition", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the transfer to transition the status of.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d8af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "transfer_id" } } }, { "name": "x-api-version", "in": "header", "description": "x-api-version.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "next_status" ], "properties": { "failure_type": { "type": "string", "description": "The type of failure to simulate.", "enum": [ "ACCOUNT_CLOSED", "ACCOUNT_CURRENCY_MISMATCH", "ACCOUNT_INACTIVE_OR_DORMANT", "ACCOUNT_UNDER_RESTRICTION", "BENEFICIARY_BANK_RETURNED", "BENEFICIARY_NAME_MISMATCH", "BENEFICIARY_REQUESTED", "CARD_ISSUER_ERROR", "CHANNEL_POLICY", "CHANNEL_TIMEOUT", "CLIENT_REQUESTED", "DUPLICATION_RETURN", "EXCEEDED_TRANSACTION_AMOUNT_OR_LIMIT", "INBOUND_2B_CARD_NOT_SUPPORTED", "INBOUND_BENFICIARY_VALIDATION_ERROR", "INBOUND_COMPANY_REGISTRATION_NUMBER_ERROR", "INBOUND_ORDER_ERROR", "INSUFFICIENT_FUNDS", "INVALID_ACCOUNT_NAME_OR_NUMBER", "INVALID_BANK_INFORMATION", "INVALID_BANK_OR_BRANCH_CODE", "INVALID_BENEFICIARY_DETAILS", "INVALID_CORRESPONDENT_BANK_INFORMATION", "INVALID_PAYMENT_PURPOSE", "INVALID_SPECIAL_CHARACTER", "INVALID_SWIFT_BIC_CODE", "OTHER", "RECALL_REQUESTED", "SYSTEM_ERROR", "TM_SUSPENDED", "TRANSACTION_AMOUNT_NOT_COVERING_FEE", "UNABLE_TO_APPLY" ] }, "next_status": { "type": "string", "description": "The next status to transition to. Status can be OVERDUE, PROCESSING, SENT, PAID, FAILED, and CANCELLED." } } }, "examples": { "default": { "value": { "failure_type": "INVALID_ACCOUNT_NAME_OR_NUMBER", "next_status": "SENT" } } } } }, "description": "payload", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimulationTransfer" }, "examples": { "default": { "value": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure_reason": "Insufficient funds", "failure_type": "UNKNOWN", "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } } } } }, "400": { "description": "invalid_argument" }, "401": { "description": "credentials_invalid" }, "500": { "description": "service_unavailable" } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/simulation/transfers/transfer_id/transition", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "failure_type": "INVALID_ACCOUNT_NAME_OR_NUMBER", "next_status": "SENT" }, "response_body": { "amount_beneficiary_receives": 99996, "amount_payer_pays": 10004, "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "batch_transfer_id": "d9df6d02-4116-4376-82c7-064159cc878e", "beneficiary": { "additional_info": { "business_area": "Travel", "business_phone_number": "689342234", "business_registration_number": "IT593003", "external_identifier": "", "legal_rep_bank_account_number": "44250100003700000000", "legal_rep_first_name_in_chinese": "小芳", "legal_rep_id_number": "110108199304203520", "legal_rep_last_name_in_chinese": "刘", "legal_rep_mobile_number": "13651362890", "personal_email": "john.walker@gmail.com", "personal_first_name_in_chinese": "大明", "personal_id_number": "1234567890", "personal_id_type": "NATIONAL_ID", "personal_last_name_in_chinese": "李", "personal_mobile_number": "13651362890", "recipient_account_id": "", "security_question": "What is the name of my second puppy?", "security_question_answer": "Scooby Doo" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "bank_details": { "account_currency": "AUD", "account_name": "Lee Da Ming", "account_name_alias": "Lee D M", "account_number": "12750852", "account_routing_type1": "bsb", "account_routing_type2": "sort_code", "account_routing_value1": "083064", "account_routing_value2": "123456", "bank_account_category": "Checking,Savings,Vista,Maestra", "bank_branch": "Melbourne", "bank_country_code": "AU", "bank_name": "National Australia Bank", "bank_state": "", "bank_street_address": "500 Bourke Street, Melbourne 3000, Australia", "binding_mobile_number": "654897612345", "fingerprint": "2e99758548972a8e8822ad47fa1017ff72f06f3ff6a016851f45c398732bc50c", "iban": "ES8023100001180000012345", "intermediary_bank_name": "National Australia Bank", "intermediary_bank_swift_code": "CTBAAU2S", "local_clearing_system": "ACH", "swift_code": "CTBAAU2S" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "digital_wallet": { "account_name": "John Walker Corporation", "country_code": "US", "id_type": "account_number", "id_value": "1033106816639334", "provider": "AIRWALLEX" }, "entity_type": "COMPANY", "first_name": "John", "last_name": "Walker", "type": "" }, "beneficiary_id": "", "conversion": { "currency_pair": "USDEUR", "rate": 0.761223 }, "created_at": "2017-03-22T16:08:02+1100", "dispatch_date": "2017-03-29", "dispatch_info": { "external_reference": "CHK-100012345", "external_reference_type": "PAPER_CHECK_NUMBER" }, "failure_reason": "Insufficient funds", "failure_type": "UNKNOWN", "fee_amount": 4, "fee_currency": "AUD", "fee_paid_by": "PAYER", "funding": { "deposit_type": "DIRECT_DEBIT", "failure_details": { "code": "insufficient_funds", "iso_code": "AM04", "provider_failure_details": { "code": "R01", "local_clearing_system": "US_ACH", "message": "INSUFFICIENT FUNDS" } }, "failure_reason": "regulatory_reason", "funding_source_id": "b3856846-31b0-44d8-855d-e0eedf532282", "status": "FUNDED" }, "id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "lock_rate_on_create": false, "metadata": { "order_id": "0123456789" }, "payer": { "additional_info": { "business_registration_number": "EU300503", "business_registration_type": "Partnership", "external_id": "1234567890", "personal_email": "james.smith@google.com", "personal_id_number": "1234567890" }, "address": { "city": "Melbourne", "country_code": "AU", "postcode": "3000", "state": "VIC", "street_address": "15 William Street" }, "company_name": "Complete Concrete Pty Ltd", "date_of_birth": "1976-08-26", "entity_type": "COMPANY", "first_name": "James", "last_name": "Smith" }, "payer_id": "", "prepayment": { "amount": 12.34, "currency": "USD" }, "reason": "travel", "reference": "PMT1936398", "remarks": "Any information", "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "short_reference_id": "20170322-9F6ML2", "source_amount": 10000, "source_currency": "AUD", "status": "PROCESSING", "swift_charge_option": "SHARED", "transfer_amount": 10000, "transfer_currency": "AUD", "transfer_date": "2017-03-24", "transfer_method": "SWIFT", "updated_at": "2017-03-24T18:00:02+1100" } } ], "x-scope": [ { "scope": "simulation:write", "group": "Simulations", "resource_name": "Simulations", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/spend/bills/create": { "post": { "tags": [ "Spend > Bills" ], "summary": "1|Create a Bill", "description": "Creates a new bill.", "operationId": "createBill", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "billing_currency", "due_date", "external_id", "invoice_number", "issued_date", "legal_entity_id", "line_items", "request_id", "sync_status", "tax_status", "vendor_id" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. To prevent accidental duplication, clients should generate a random UUID." }, "external_id": { "type": "string", "description": "External identifier for this bill in your system." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with the bill." }, "vendor_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the vendor associated with the bill." }, "invoice_number": { "type": "string", "description": "Invoice number associated with the bill." }, "issued_date": { "type": "string", "description": "Date when the bill was issued, in ISO8601 format." }, "due_date": { "type": "string", "description": "Date when the bill is due, in ISO8601 format." }, "billing_currency": { "type": "string", "description": "Currency of the bill, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "tax_status": { "type": "string", "description": "Tax status for bill creation.", "enum": [ "TAX_EXCLUSIVE", "TAX_INCLUSIVE" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "line_items": { "type": "array", "description": "List of line items on the bill.", "items": { "type": "object", "required": [ "quantity", "unit_price" ], "properties": { "description": { "type": "string", "description": "Description of the line item." }, "quantity": { "type": "string", "description": "Quantity of the line item." }, "unit_price": { "type": "string", "description": "Unit price of the line item (tax-exclusive). Tax is applied separately based on the selected tax rate." }, "accounting_field_selections": { "type": "array", "description": "List of accounting fields selected for the line item.", "items": { "type": "object", "required": [ "type", "source_id" ], "properties": { "type": { "type": "string", "description": "Type of accounting field selection.", "enum": [ "GENERAL_LEDGER_ACCOUNT", "TAX_CODE", "OTHER" ], "x-enumDescriptions": { "GENERAL_LEDGER_ACCOUNT": "General ledger (GL) account assigned to the line item.", "TAX_CODE": "Tax code applied to the line item.", "OTHER": "Custom accounting field defined in your ERP." } }, "source_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the general ledger (GL) account, tax code, or accounting field value to assign to this line item. The required `id` depends on `type`: use [List General Ledger Accounts](/docs/api/accounting/general_ledger_accounts/list) for `GENERAL_LEDGER_ACCOUNT`, [List Tax Codes](/docs/api/accounting/tax_codes/list) for `TAX_CODE`, or [List Accounting Field Values](/docs/api/accounting/accounting_field_values/list) for `OTHER`." } }, "description": "List of accounting fields selected for the line item." } }, "purchase_order_line_item_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the purchase order line item associated with this bill line item." } }, "description": "Bill line item request." } }, "description": { "type": "string", "description": "Description of the bill." }, "purchase_order_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the purchase order associated with the bill." }, "attachments": { "type": "array", "description": "List of file IDs to attach to the bill. Upload each file with [Upload a file](/docs/api/supporting_services/file_service/upload_files) first, setting `purpose` to `SPEND_ATTACHMENT`.", "items": { "type": "string", "format": "uuid", "description": "Unique identifier of an uploaded file." } } }, "description": "Bill creation payload." }, "examples": { "default": { "value": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "BILL-EXT-001", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "invoice_number": "INV-0001", "issued_date": "2025-01-10", "due_date": "2025-01-10", "billing_currency": "USD", "tax_status": "TAX_EXCLUSIVE", "sync_status": "SYNCED", "line_items": [ { "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "GENERAL_LEDGER_ACCOUNT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "description": "Office supplies for Q1 2025.", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e" } } } } }, "required": true }, "responses": { "201": { "description": "Bill created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/bills/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "BILL-EXT-001", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "invoice_number": "INV-0001", "issued_date": "2025-01-10", "due_date": "2025-01-10", "billing_currency": "USD", "tax_status": "TAX_EXCLUSIVE", "sync_status": "SYNCED", "line_items": [ { "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "GENERAL_LEDGER_ACCOUNT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "description": "Office supplies for Q1 2025.", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e" }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.bill:write", "group": "Spend", "resource_name": "Bills", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/bills": { "get": { "tags": [ "Spend > Bills" ], "summary": "3|List all Bills", "description": "Returns a list of bills filtered by the specified query parameters.", "operationId": "listBills", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "from_created_at", "in": "query", "description": "Filter by bills created after this timestamp (inclusive) in ISO8601 format. If not specified, defaults to last 30 days from `to_created_at`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "Filter by bills created before this timestamp (exclusive) in ISO8601 format. If not specified, defaults to now.", "required": false, "schema": { "type": "string" } }, { "name": "from_updated_at", "in": "query", "description": "Filter by bills updated after this timestamp (inclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "to_updated_at", "in": "query", "description": "Filter by bills updated before this timestamp (exclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by bill status.", "required": false, "schema": { "type": "string", "enum": [ "DRAFT", "AWAITING_APPROVAL", "AWAITING_PAYMENT", "PAYMENT_IN_PROGRESS", "PAID", "REJECTED", "SCHEDULED" ] } }, { "name": "sync_status", "in": "query", "description": "Filter by sync status.", "required": false, "schema": { "type": "string", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity unique identifier.", "required": false, "schema": { "type": "string" } }, { "name": "purchase_order_id", "in": "query", "description": "Filter by purchase order unique identifier.", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/bills", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.bill:read", "group": "Spend", "resource_name": "Bills", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/bills/{id}/mark_as_paid": { "post": { "tags": [ "Spend > Bills" ], "summary": "4|Mark Bill As Paid", "description": "Marks a bill as paid outside of Airwallex.", "operationId": "markBillAsPaid", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the bill.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "bill_id" } } } ], "responses": { "200": { "description": "Bill marked as paid successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/bills/bill_id/mark_as_paid", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.bill:write", "group": "Spend", "resource_name": "Bills", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/bills/{id}": { "get": { "tags": [ "Spend > Bills" ], "summary": "2|Retrieve a Bill", "description": "Retrieves the details of an existing bill.", "operationId": "retrieveBill", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the bill.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "bill_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/bills/bill_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.bill:read", "group": "Spend", "resource_name": "Bills", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/bills/{id}/sync": { "post": { "tags": [ "Spend > Bills" ], "summary": "5|Update Bill Sync Status", "description": "Updates the sync status of a bill.", "operationId": "syncBills", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the bill.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "bill_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message for sync failures. Only applicable when sync_status is `SYNC_FAILED`." } }, "description": "Bill Update Sync Status Payload." }, "examples": { "default": { "value": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency." } } } } }, "required": true }, "responses": { "200": { "description": "Bill sync status updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/bills/bill_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency." }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "invoice_number": "INV-0001", "billing_amount": "551.0", "billing_currency": "USD", "status": "AWAITING_PAYMENT", "sync_status": "SYNCED", "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.", "tax_status": "TAX_EXCLUSIVE", "description": "Office supplies for Q1 2025.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "issued_date": "2025-01-10", "due_date": "2025-01-10", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e", "bill_payments": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "type": "CARD_TRANSACTION", "amount": "300.00", "currency": "USD", "card_transaction": { "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "card_funding_type": "CREDIT", "source_amount": "300.00", "source_currency": "USD", "transacted_at": "2025-01-02T00:00:00Z" }, "created_at": "2025-01-02T00:00:00Z" }, { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "type": "TRANSFER", "amount": "251.00", "currency": "USD", "transfer": { "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "multi_bill": false, "source_amount": "251.00", "source_currency": "USD", "transfer_date": "2025-01-01" }, "created_at": "2025-01-01T00:00:00Z" } ], "external_id": "BILL-EXT-001", "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "invoice.pdf", "file_url": "https://www.airwallex.com/invoice.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "unit_price": "100.0", "quantity": "5", "description": "Office supplies.", "total_amount": "500.0", "tax_amount": "51.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.bill:write", "group": "Spend", "resource_name": "Bills", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/expenses": { "get": { "tags": [ "Spend > Expenses" ], "summary": "2|List all Expenses", "description": "List expenses based on the query parameters.", "operationId": "listExpenses", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "from_created_at", "in": "query", "description": "Filter by expenses created after this timestamp (inclusive) in ISO8601 format.\n\nIf not specified, defaults to last 30 days from `to_created_at`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "Filter by expenses created before this timestamp (exclusive) in ISO8601 format.\n\nIf not specified, defaults to now.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by expense statuses. Additional values may appear; implementations should handle unknown values gracefully.", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "AWAITING_APPROVAL", "REJECTED", "APPROVED", "ARCHIVED", "DELETED" ] } } }, { "name": "card_transaction", "in": "query", "description": "Filter by card transaction properties.", "required": false, "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "status": { "description": "Filter by card transaction statuses. Possible values are `AUTHORIZED`, `CLEARED`, `REVERSED`.", "type": "array", "items": { "type": "string", "enum": [ "AUTHORIZED", "CLEARED", "REVERSED" ], "x-enumDescriptions": { "AUTHORIZED": "Transaction has been authorized by the card network but not yet settled.", "CLEARED": "Transaction has been settled and cleared.", "REVERSED": "Transaction has been reversed or refunded." } } } } } }, { "name": "card_type", "in": "query", "description": "Filter by card types. `COMPANY` identifies company cards and `EMPLOYEE` identifies employee cards.", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "COMPANY", "EMPLOYEE" ], "x-enumDescriptions": { "COMPANY": "Filter to expenses made with company cards.", "EMPLOYEE": "Filter to expenses made with employee cards." } } } }, { "name": "sync_status", "in": "query", "description": "Filter by sync statuses.", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "description": "Expense sync status.", "enum": [ "NOT_SYNCED", "READY_TO_SYNC", "SYNCED", "SYNC_FAILED" ] } } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity identifier.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpensePagination" }, "examples": { "default": { "value": { "items": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "invoice_number": "INV-2026-001", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/expenses", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "invoice_number": "INV-2026-001", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/expenses/{id}": { "get": { "tags": [ "Spend > Expenses" ], "summary": "1|Retrieve an Expense", "description": "Retrieves the details of an existing expense.", "operationId": "retrieveExpense", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the expense.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "expense_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" }, "examples": { "default": { "value": { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "invoice_number": "INV-2026-001", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/expenses/expense_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "invoice_number": "INV-2026-001", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/expenses/{id}/sync": { "post": { "tags": [ "Spend > Expenses" ], "summary": "3|Update Expense Sync Status", "description": "Updates the sync status of an existing expense.\n\nA sync status can only move in the following directions:\n * `NOT_SYNCED` can move to `READY_TO_SYNC`, `SYNC_FAILED`, or `SYNCED`.\n * `READY_TO_SYNC` can move to `SYNCED` or `SYNC_FAILED`.\n * `SYNC_FAILED` can move to `SYNCED` or `READY_TO_SYNC`.\n * `SYNCED` is a final state and cannot move to any other status.\n\n`NOT_SYNCED` is the initial status of an expense and cannot be set through this endpoint.", "operationId": "syncExpenses", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the expense.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "expense_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Expense sync status.", "enum": [ "READY_TO_SYNC", "SYNCED", "SYNC_FAILED" ] } }, "description": "Expense Update Payload." }, "examples": { "default": { "value": { "sync_status": "SYNCED" } } } } }, "description": "Update expense payload.", "required": true }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Expense" }, "examples": { "default": { "value": { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } } } } } }, "400": { "description": "Invalid request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/expenses/expense_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNCED" }, "response_body": { "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "card_id": "93eed14b-104d-4f40-ae1d-3633c6538276", "card_type": "EMPLOYEE", "status": "AWAITING_APPROVAL", "card_transaction": { "card_transaction_id": "43aec951-3204-4b1a-9e77-8f2c1d0a1b2c", "status": "CLEARED", "amount": "105.50", "currency": "USD" }, "sync_status": "SYNCED", "billing_currency": "USD", "billing_amount": "105.5", "description": "Client dinner at restaurant for Q4 planning meeting.", "merchant": "Starbucks Coffee #1234", "approvers": [ "manager@company.com", "finance@company.com" ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "settled_at": "2025-03-03T10:15:30Z", "accounting_field_selections": [ { "type": "MERCHANT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": null, "external_id": null, "value": "Starbucks Coffee #1234", "value_label": "Starbucks Coffee #1234" } ], "attachments": [ { "id": "0fd62109-cfc0-4c94-86a5-d01c42506b76", "content_type": "image/jpeg", "file_name": "receipt.jpg", "file_url": "https://files.airwallex.com/receipt.jpg", "created_at": "2024-12-16T09:22:00Z" } ], "line_items": [ { "id": "a12fca5e-4aeb-4adb-85b0-428b4f078aba", "transaction_amount": "105.50", "description": "Client dinner", "accounting_field_selections": [ { "source_id": "c9fcfdee-f943-45c9-abaa-45df1601ae04", "type": "GENERAL_LEDGER_ACCOUNT", "external_id": "6000", "value": "Travel & Entertainment", "value_label": "Travel & Entertainment" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:write", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/purchase_orders/create": { "post": { "tags": [ "Spend > Purchase Orders" ], "summary": "1|Create a Purchase Order", "description": "Creates a new purchase order.", "operationId": "createPurchaseOrder", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "billing_currency", "external_id", "legal_entity_id", "line_items", "purchase_order_number", "request_id", "sync_status", "vendor_id" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. To prevent accidental duplication, clients should generate a random UUID." }, "external_id": { "type": "string", "description": "External identifier for this purchase order in your system." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with the purchase order." }, "vendor_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the vendor associated with the purchase order." }, "purchase_order_number": { "type": "string", "description": "Unique reference number for the purchase order." }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "billing_currency": { "type": "string", "description": "Currency code for the purchase order.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "owner_email": { "type": "string", "description": "Email of the purchase order owner." }, "recurrence": { "type": "object", "required": [ "frequency", "iterations" ], "properties": { "frequency": { "type": "string", "description": "Frequency for recurring purchase orders.", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ] }, "iterations": { "type": "integer", "format": "int32", "description": "Number of occurrences for recurring purchase orders." } }, "description": "Defines the schedule and duration for a recurring purchase order." }, "line_items": { "type": "array", "description": "List of line items in the purchase order.", "items": { "type": "object", "required": [ "quantity", "unit_price" ], "properties": { "description": { "type": "string", "description": "Description of the line item." }, "quantity": { "type": "string", "description": "Unit quantity of the line item." }, "unit_price": { "type": "string", "description": "Unit price of the line item (tax-exclusive). Tax is applied separately based on the selected tax rate." }, "accounting_field_selections": { "type": "array", "description": "List of accounting fields selected for the line item.", "items": { "type": "object", "required": [ "type", "source_id" ], "properties": { "type": { "type": "string", "description": "Type of accounting field selection.", "enum": [ "GENERAL_LEDGER_ACCOUNT", "TAX_CODE", "OTHER" ], "x-enumDescriptions": { "GENERAL_LEDGER_ACCOUNT": "General ledger (GL) account assigned to the line item.", "TAX_CODE": "Tax code applied to the line item.", "OTHER": "Custom accounting field defined in your ERP." } }, "source_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the general ledger (GL) account, tax code, or accounting field value to assign to this line item. The required `id` depends on `type`: use [List General Ledger Accounts](/docs/api/accounting/general_ledger_accounts/list) for `GENERAL_LEDGER_ACCOUNT`, [List Tax Codes](/docs/api/accounting/tax_codes/list) for `TAX_CODE`, or [List Accounting Field Values](/docs/api/accounting/accounting_field_values/list) for `OTHER`." } }, "description": "List of accounting fields selected for the line item." } } }, "description": "Purchase order line item request." } }, "description": { "type": "string", "description": "Description of the purchase order." }, "note": { "type": "string", "description": "Note for the purchase order." }, "net_payment_terms_in_days": { "type": "integer", "format": "int32", "description": "Net payment terms in days." }, "promise_date": { "type": "string", "description": "Date when the vendor will deliver the goods or services. This can be either ISO8601 Date or DateTime format. Dates without time are interpreted as midnight UTC." }, "contacts": { "type": "object", "properties": { "vendor_contact": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Name of the contact person." }, "company_name": { "type": "string", "description": "Name of the company." }, "email": { "type": "string", "description": "Email address." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." }, "address": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Street address line." }, "city": { "type": "string", "description": "City, district, suburb, or town." }, "state": { "type": "string", "description": "State, province, or region." }, "postcode": { "type": "string", "description": "Postal/ZIP code." }, "country_code": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] } }, "description": "Address." } }, "description": "Purchase Order Contact Details." }, "shipping_contact": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Name of the contact person." }, "company_name": { "type": "string", "description": "Name of the company." }, "email": { "type": "string", "description": "Email address." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." }, "address": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Street address line." }, "city": { "type": "string", "description": "City, district, suburb, or town." }, "state": { "type": "string", "description": "State, province, or region." }, "postcode": { "type": "string", "description": "Postal/ZIP code." }, "country_code": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] } }, "description": "Address." } }, "description": "Purchase Order Contact Details." }, "billing_contact": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Name of the contact person." }, "company_name": { "type": "string", "description": "Name of the company." }, "email": { "type": "string", "description": "Email address." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." }, "address": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Street address line." }, "city": { "type": "string", "description": "City, district, suburb, or town." }, "state": { "type": "string", "description": "State, province, or region." }, "postcode": { "type": "string", "description": "Postal/ZIP code." }, "country_code": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] } }, "description": "Address." } }, "description": "Purchase Order Contact Details." } }, "description": "Purchase Order Contact Information." }, "attachments": { "type": "array", "description": "List of file IDs to attach to the purchase order. Upload each file with [Upload a file](/docs/api/supporting_services/file_service/upload_files) first, setting `purpose` to `SPEND_ATTACHMENT`.", "items": { "type": "string", "format": "uuid", "description": "Unique identifier of an uploaded file." } } }, "description": "Purchase Order Creation Payload." }, "examples": { "default": { "value": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "PO-EXT-001", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_number": "PO-0001", "sync_status": "SYNCED", "billing_currency": "USD", "owner_email": "example@airwallex.com", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "line_items": [ { "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "GENERAL_LEDGER_ACCOUNT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ] } ], "description": "This is a description of the purchase order.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } } } } } } }, "required": true }, "responses": { "201": { "description": "Purchase order created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spend_PurchaseOrder" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/purchase_orders/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "PO-EXT-001", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "purchase_order_number": "PO-0001", "sync_status": "SYNCED", "billing_currency": "USD", "owner_email": "example@airwallex.com", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "line_items": [ { "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "GENERAL_LEDGER_ACCOUNT", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d" } ] } ], "description": "This is a description of the purchase order.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } } }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.purchase_order:write", "group": "Spend", "resource_name": "Purchase Orders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/purchase_orders": { "get": { "tags": [ "Spend > Purchase Orders" ], "summary": "3|List all Purchase Orders", "description": "Returns a list of purchase orders filtered by the specified query parameters.", "operationId": "listPurchaseOrders", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "from_created_at", "in": "query", "description": "Filter by purchase orders created after this timestamp (inclusive) in ISO8601 format. If not specified, defaults to last 30 days from `to_created_at`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "Filter by purchase orders created before this timestamp (exclusive) in ISO8601 format. If not specified, defaults to now.", "required": false, "schema": { "type": "string" } }, { "name": "from_updated_at", "in": "query", "description": "Filter by purchase orders updated after this timestamp (inclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "to_updated_at", "in": "query", "description": "Filter by purchase orders updated before this timestamp (exclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by purchase order status.", "required": false, "schema": { "type": "string", "enum": [ "OPEN", "COMPLETED", "ARCHIVED", "CLOSED" ] } }, { "name": "sync_status", "in": "query", "description": "Filter by sync status.", "required": false, "schema": { "type": "string", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity unique identifier.", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "Filter by purchase order external unique identifier.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderPagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/purchase_orders", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.purchase_order:read", "group": "Spend", "resource_name": "Purchase Orders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/purchase_orders/{id}": { "get": { "tags": [ "Spend > Purchase Orders" ], "summary": "2|Retrieve a Purchase Order", "description": "Retrieves the details of an existing purchase order.", "operationId": "retrievePurchaseOrder", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the purchase order.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "purchase_order_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spend_PurchaseOrder" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/purchase_orders/purchase_order_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.purchase_order:read", "group": "Spend", "resource_name": "Purchase Orders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/purchase_orders/{id}/sync": { "post": { "tags": [ "Spend > Purchase Orders" ], "summary": "4|Update Purchase Order Sync Status", "description": "Updates the sync status of a purchase order.", "operationId": "syncPurchaseOrders", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for the purchase order.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "purchase_order_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message for sync failures. Only applicable when sync_status is `SYNC_FAILED`." } }, "description": "Purchase Order Update Sync Status Payload." }, "examples": { "default": { "value": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists." } } } } }, "required": true }, "responses": { "200": { "description": "Purchase order sync status updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Spend_PurchaseOrder" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/purchase_orders/purchase_order_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists." }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "billing_currency": "USD", "recurring_amount": "5000.0", "total_amount": "60000.0", "billed_amount": "3000.0", "purchase_order_number": "PO-0001", "external_id": "PO-EXT-001", "status": "OPEN", "sync_status": "SYNCED", "sync_error_message": "Failed to sync purchase order: this purchase order number already exists.", "recurrence": { "frequency": "MONTHLY", "iterations": 12 }, "description": "Annual software license renewal for Q1 2025.", "note": "Please deliver between 9AM-5PM", "net_payment_terms_in_days": 30, "promise_date": "2025-01-10", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "contacts": { "vendor_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "shipping_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } }, "billing_contact": { "contact_name": "John Doe", "company_name": "Airwallex Pty Ltd", "email": "example@airwallex.com", "phone_number": "+61499999999", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" } } }, "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "purchase_quote.pdf", "file_url": "https://www.airwallex.com/purchase_quote.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "line_items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "description": "Office supplies.", "quantity": "10", "unit_price": "500.0", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.purchase_order:write", "group": "Spend", "resource_name": "Purchase Orders", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/reimbursements": { "get": { "tags": [ "Spend > Reimbursements" ], "summary": "4|List all Reimbursements", "description": "List reimbursements in a specific reimbursement report.", "operationId": "listReimbursements", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementPagination" }, "examples": { "default": { "value": { "items": [ { "accounting_field_selections": [], "attachments": [ { "content_type": "application/pdf", "created_at": "2025-11-27T10:00:00Z", "file_name": "receipt.pdf", "file_url": "https://example.com/receipt.pdf", "id": "1540326e-f828-4c16-9ef0-2e5045618637" } ], "billing_amount": "551.00", "comments": [], "created_at": "2025-11-10T12:00:00Z", "description": "Hotel stay for business trip.", "id": "1ae9f098-c845-4c31-a7b2-2fc65eb3bbbb", "line_items": [ { "accounting_field_selections": [ { "name": "Department", "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "value": "123456", "value_id": null, "value_label": "Communications" } ], "id": "1706880f-4257-4f6e-a714-ced27172fdf6", "tax_amount": "0.00", "transaction_amount": "551.00" } ], "merchant_name": "A Grand Hotel", "transaction_amount": "551.00", "transaction_currency": "USD", "transaction_date": "2024-12-15T00:00:00Z", "updated_at": "2025-11-10T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/reimbursements", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "accounting_field_selections": [], "attachments": [ { "content_type": "application/pdf", "created_at": "2025-11-27T10:00:00Z", "file_name": "receipt.pdf", "file_url": "https://example.com/receipt.pdf", "id": "1540326e-f828-4c16-9ef0-2e5045618637" } ], "billing_amount": "551.00", "comments": [], "created_at": "2025-11-10T12:00:00Z", "description": "Hotel stay for business trip.", "id": "1ae9f098-c845-4c31-a7b2-2fc65eb3bbbb", "line_items": [ { "accounting_field_selections": [ { "name": "Department", "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "value": "123456", "value_id": null, "value_label": "Communications" } ], "id": "1706880f-4257-4f6e-a714-ced27172fdf6", "tax_amount": "0.00", "transaction_amount": "551.00" } ], "merchant_name": "A Grand Hotel", "transaction_amount": "551.00", "transaction_currency": "USD", "transaction_date": "2024-12-15T00:00:00Z", "updated_at": "2025-11-10T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports": { "get": { "tags": [ "Spend > Reimbursements" ], "summary": "5|List all Reimbursement Reports", "description": "List reimbursement reports based on the query parameters.", "operationId": "listReimbursementReports", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "from_updated_at", "in": "query", "description": "Filter by reimbursement reports updated after this timestamp (inclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "to_updated_at", "in": "query", "description": "Filter by reimbursement reports updated before this timestamp (exclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by reimbursement report statuses.", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "AWAITING_APPROVAL", "AWAITING_PAYMENT", "PAYMENT_IN_PROGRESS", "PAID", "DELETED", "REJECTED", "MARKED_AS_PAID" ] } } }, { "name": "sync_status", "in": "query", "description": "Filter by sync statuses.", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity unique identifier.", "required": false, "schema": { "type": "string" } }, { "name": "approver", "in": "query", "description": "Filter by approver user email.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportSummaryPagination" }, "examples": { "default": { "value": { "items": [ { "approvers": [], "beneficiary_id": null, "billing_currency": "USD", "created_at": "2025-01-01T00:00:00Z", "created_by": "user1@airwallex.com", "id": "5ff441f8-1721-4148-b73a-bf690733f0f4", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Reimbursement report 2025-11-24", "status": "DRAFT", "sync_status": "NOT_SYNCED", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/reimbursement_reports", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "approvers": [], "beneficiary_id": null, "billing_currency": "USD", "created_at": "2025-01-01T00:00:00Z", "created_by": "user1@airwallex.com", "id": "5ff441f8-1721-4148-b73a-bf690733f0f4", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Reimbursement report 2025-11-24", "status": "DRAFT", "sync_status": "NOT_SYNCED", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/reimbursements/{reimbursement_id}": { "get": { "tags": [ "Spend > Reimbursements" ], "summary": "1|Retrieve a Reimbursement", "description": "Retrieves a specific reimbursement within a reimbursement report.", "operationId": "retrieveReimbursement", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } }, { "name": "reimbursement_id", "in": "path", "description": "Unique identifier of the reimbursement.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reimbursement" }, "examples": { "default": { "value": { "id": "2d0a09cc-0a33-4fbd-b132-d3aa858d5491", "description": "Business flight to San Francisco for client meeting - Q4 2024.", "merchant_name": "American Airlines", "transaction_amount": "1247.5", "transaction_currency": "EUR", "billing_amount": "1350.25", "transaction_date": "2024-12-15T14:30:00Z", "line_items": [ { "id": "c9dcab16-f66a-4b4f-bb86-3531187218c8", "billing_amount": "125.5", "transaction_amount": "120.0", "tax_amount": "12.5", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "attachments": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "content_type": "image/jpeg", "file_name": "flight_receipt_AA1234.jpg", "file_url": "https://files.example.com/receipts/985461d5-016f-4e1f-a387-5f1380b42d92", "created_at": "2024-12-15T14:45:00Z" }, { "id": "773621a8-912c-4b2d-8756-1e8946d12345", "content_type": "application/pdf", "file_name": "hotel_invoice_hyatt.pdf", "file_url": "https://files.example.com/receipts/773621a8-912c-4b2d-8756-1e8946d12345", "created_at": "2024-12-16T09:22:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/reimbursements/reimbursement_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "2d0a09cc-0a33-4fbd-b132-d3aa858d5491", "description": "Business flight to San Francisco for client meeting - Q4 2024.", "merchant_name": "American Airlines", "transaction_amount": "1247.5", "transaction_currency": "EUR", "billing_amount": "1350.25", "transaction_date": "2024-12-15T14:30:00Z", "line_items": [ { "id": "c9dcab16-f66a-4b4f-bb86-3531187218c8", "billing_amount": "125.5", "transaction_amount": "120.0", "tax_amount": "12.5", "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ] } ], "attachments": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "content_type": "image/jpeg", "file_name": "flight_receipt_AA1234.jpg", "file_url": "https://files.example.com/receipts/985461d5-016f-4e1f-a387-5f1380b42d92", "created_at": "2024-12-15T14:45:00Z" }, { "id": "773621a8-912c-4b2d-8756-1e8946d12345", "content_type": "application/pdf", "file_name": "hotel_invoice_hyatt.pdf", "file_url": "https://files.example.com/receipts/773621a8-912c-4b2d-8756-1e8946d12345", "created_at": "2024-12-16T09:22:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "accounting_field_selections": [ { "type": "OTHER", "source_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d", "name": "Cost Center", "external_id": "1036f6f7-87e4-4508-b865-f670b1926022", "value": "Office Expense", "value_label": "Office Expense" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}": { "get": { "tags": [ "Spend > Reimbursements" ], "summary": "2|Retrieve a Reimbursement Report", "description": "Retrieves the details of an existing reimbursement report.", "operationId": "retrieveReimbursementReports", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportSummary" }, "examples": { "default": { "value": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/transfers/{transfer_id}": { "get": { "tags": [ "Spend > Reimbursements" ], "summary": "3|Retrieve a Reimbursement Report Transfer", "description": "Retrieves the details of an existing reimbursement report transfer.", "operationId": "retrieveTransfers", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } }, { "name": "transfer_id", "in": "path", "description": "Unique identifier of the reimbursement report transfer.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "transfer_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportTransfer" }, "examples": { "default": { "value": { "id": "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "sync_status": "SYNCED", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "beneficiary_id": "a630598a-ad9c-48c6-a28e-a50ffcda7aa8", "transfer_id": "bc2bd9c5-c942-4117-ab65-a38708d16cde" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/transfers/transfer_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "sync_status": "SYNCED", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "beneficiary_id": "a630598a-ad9c-48c6-a28e-a50ffcda7aa8", "transfer_id": "bc2bd9c5-c942-4117-ab65-a38708d16cde" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:read", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/mark_as_paid": { "post": { "tags": [ "Spend > Reimbursements" ], "summary": "8|Mark Reimbursement Report As Paid", "description": "Marks a reimbursement report as paid outside of Airwallex.", "operationId": "spendReimbursementReportsMarkAsPaid", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportSummary" }, "examples": { "default": { "value": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/mark_as_paid", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:write", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/sync": { "post": { "tags": [ "Spend > Reimbursements" ], "summary": "6|Update Reimbursement Report Sync Status", "description": "Updates the sync status of an existing reimbursement report.", "operationId": "spendReimbursementReportsSync", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } }, "description": "Reimbursement report Update Payload." }, "examples": { "default": { "value": { "sync_status": "SYNCED" } } } } }, "description": "Update reimbursement report payload.", "required": true }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportSummary" }, "examples": { "default": { "value": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNCED" }, "response_body": { "id": "126ff4d1-737c-4a62-a862-f76b3f103357", "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg", "name": "Q4 2024 Business Travel - San Francisco", "status": "MARKED_AS_PAID", "sync_status": "SYNCED", "billing_currency": "USD", "approvers": [ "manager@company.com", "finance@company.com" ], "created_by": "employee@company.com", "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z", "beneficiary_id": "55458be4-271c-488d-a12b-5e0709f4a0c0", "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "reimbursement_report_transfer_ids": [ "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "8dd91c6c-65ba-4602-ab51-04fc000dd90b" ] } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:write", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/reimbursement_reports/{id}/transfers/{transfer_id}/sync": { "post": { "tags": [ "Spend > Reimbursements" ], "summary": "7|Update Reimbursement Report Transfer Sync Status", "description": "Updates the sync status of an existing reimbursement report transfer.", "operationId": "spendReimbursementReportsTransfersSync", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the reimbursement report.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "reimbursement_id" } } }, { "name": "transfer_id", "in": "path", "description": "Unique identifier of the reimbursement report transfer.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "transfer_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } }, "description": "Reimbursement report transfer update payload." }, "examples": { "default": { "value": { "sync_status": "SYNCED" } } } } }, "description": "Payload for updating the sync status of a reimbursement report transfer.", "required": true }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementReportTransfer" }, "examples": { "default": { "value": { "id": "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "sync_status": "SYNCED", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "beneficiary_id": "a630598a-ad9c-48c6-a28e-a50ffcda7aa8", "transfer_id": "bc2bd9c5-c942-4117-ab65-a38708d16cde" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/reimbursement_reports/reimbursement_id/transfers/transfer_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNCED" }, "response_body": { "id": "9ee00d7d-76ca-4713-bc62-15fc111eaa0c", "sync_status": "SYNCED", "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp", "beneficiary_id": "a630598a-ad9c-48c6-a28e-a50ffcda7aa8", "transfer_id": "bc2bd9c5-c942-4117-ab65-a38708d16cde" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.expense:write", "group": "Spend", "resource_name": "Expenses", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/vendors/create": { "post": { "tags": [ "Spend > Vendors" ], "summary": "1|Create a Vendor", "description": "Creates a new vendor.", "operationId": "createVendor", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "external_id", "legal_entity_ids", "name", "request_id", "status", "sync_status" ], "properties": { "request_id": { "type": "string", "description": "Unique identifier for this request to ensure idempotency. To prevent accidental duplication, clients should generate a random UUID." }, "external_id": { "type": "string", "description": "External identifier for this vendor in your system." }, "name": { "type": "string", "description": "Name of the vendor." }, "legal_entity_ids": { "type": "array", "description": "List of unique identifiers of the legal entities associated with the vendor.", "items": { "type": "string", "description": "List of unique identifiers of the legal entities associated with the vendor." } }, "status": { "type": "string", "description": "Vendor status.", "enum": [ "DRAFT", "AWAITING_APPROVAL", "ACTIVE", "ARCHIVED" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "owner_email": { "type": "string", "description": "Email of the vendor owner." }, "business_registration_number": { "type": "string", "description": "Business registration number of the vendor." }, "business_name": { "type": "string", "description": "Business/legal name of the vendor." }, "country_code": { "type": "string", "description": "Country code of the vendor (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "address": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Street address line." }, "city": { "type": "string", "description": "City, district, suburb, or town." }, "state": { "type": "string", "description": "State, province, or region." }, "postcode": { "type": "string", "description": "Postal/ZIP code." }, "country_code": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] } }, "description": "Address." }, "contacts": { "type": "array", "description": "List of vendor contacts associated with the vendor.", "items": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Full name of the vendor contact." }, "email": { "type": "string", "description": "Email address of the vendor contact." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." } }, "description": "Vendor Contact." } }, "attachments": { "type": "array", "description": "List of file IDs to attach to the vendor. Upload each file with [Upload a file](/docs/api/supporting_services/file_service/upload_files) first, setting `purpose` to `SPEND_ATTACHMENT`.", "items": { "type": "string", "format": "uuid", "description": "Unique identifier of an uploaded file." } } }, "description": "Vendor Creation Payload." }, "examples": { "default": { "value": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "VENDOR-EXT-001", "name": "Airwallex", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "status": "ACTIVE", "sync_status": "SYNCED", "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ] } } } } }, "required": true }, "responses": { "201": { "description": "Vendor created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/vendors/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "attachments": [ "cea842bd-b6b8-4f70-bfa5-4d28e7978db7" ], "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92", "external_id": "VENDOR-EXT-001", "name": "Airwallex", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "status": "ACTIVE", "sync_status": "SYNCED", "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ] }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.vendor:write", "group": "Spend", "resource_name": "Vendors", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/vendors": { "get": { "tags": [ "Spend > Vendors" ], "summary": "3|List all Vendors", "description": "Returns a list of vendors filtered by the specified query parameters.", "operationId": "listVendors", "parameters": [ { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call.", "required": false, "schema": { "type": "string" } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page, between 1 and 100. The default is 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "from_created_at", "in": "query", "description": "Filter by vendors created after this timestamp (inclusive) in ISO8601 format. If not specified, defaults to last 30 days from `to_created_at`.", "required": false, "schema": { "type": "string" } }, { "name": "to_created_at", "in": "query", "description": "Filter by vendors created before this timestamp (exclusive) in ISO8601 format. If not specified, defaults to now.", "required": false, "schema": { "type": "string" } }, { "name": "from_updated_at", "in": "query", "description": "Filter by vendors updated after this timestamp (inclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "to_updated_at", "in": "query", "description": "Filter by vendors updated before this timestamp (exclusive) in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by vendor status.", "required": false, "schema": { "type": "string", "enum": [ "DRAFT", "AWAITING_APPROVAL", "ACTIVE", "ARCHIVED" ] } }, { "name": "sync_status", "in": "query", "description": "Filter by sync status.", "required": false, "schema": { "type": "string", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] } }, { "name": "legal_entity_id", "in": "query", "description": "Filter by legal entity unique identifier.", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "Filter by vendor external unique identifier.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorPagination" }, "examples": { "default": { "value": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/vendors", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } ], "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=", "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.vendor:read", "group": "Spend", "resource_name": "Vendors", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/vendors/{id}": { "get": { "tags": [ "Spend > Vendors" ], "summary": "2|Retrieve a Vendor", "description": "Retrieves the details of an existing vendor.", "operationId": "retrieveVendor", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the vendor.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "vendor_id" } } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/spend/vendors/vendor_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.vendor:read", "group": "Spend", "resource_name": "Vendors", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/spend/vendors/{id}/sync": { "post": { "tags": [ "Spend > Vendors" ], "summary": "4|Update Vendor Sync Status", "description": "Updates the sync status of a vendor.", "operationId": "syncVendors", "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the vendor.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "vendor_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sync_status" ], "properties": { "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message for sync failures. Only applicable when sync_status is `SYNC_FAILED`." } }, "description": "Vendor Update Sync Status Payload." }, "examples": { "default": { "value": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists." } } } } }, "required": true }, "responses": { "200": { "description": "Vendor sync status updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vendor" }, "examples": { "default": { "value": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } } } } }, "400": { "description": "Invalid Request." }, "404": { "description": "Not found." }, "500": { "description": "Internal server error." } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/spend/vendors/vendor_id/sync", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "sync_status": "SYNC_FAILED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists." }, "response_body": { "id": "985461d5-016f-4e1f-a387-5f1380b42d92", "legal_entity_ids": [ "le_U3jlHqQRNHWn2zAKeeT8sg", "le_V4kmIrRSOMXo3bBLffU9th" ], "name": "Airwallex", "business_name": "Airwallex Pty Ltd", "country_code": "US", "address": { "street_address": "123 Main Street", "city": "San Francisco", "state": "California", "postcode": "94105", "country_code": "US" }, "status": "ACTIVE", "sync_status": "SYNCED", "sync_error_message": "Failed to sync vendor: a vendor with this name already exists.", "approvers": [ "approver1@airwallex.com", "approver2@airwallex.com" ], "owner_email": "example@airwallex.com", "business_registration_number": "123456789", "external_id": "VENDOR-EXT-001", "contacts": [ { "contact_name": "Airwallex", "email": "example@airwallex.com", "phone_number": "+61499999999" } ], "attachments": [ { "id": "cea842bd-b6b8-4f70-bfa5-4d28e7978db7", "content_type": "application/pdf", "file_name": "vendor_agreement.pdf", "file_url": "https://www.airwallex.com/vendor_agreement.pdf", "created_at": "2025-02-02T00:00:00Z" } ], "comments": [ { "content": "Expense approved - valid business purpose confirmed", "created_by": "manager@company.com", "created_at": "2025-01-01T00:00:00Z" } ], "created_at": "2025-01-01T00:00:00Z", "updated_at": "2025-02-02T00:00:00Z" } } ], "x-resourceLevel": "org", "x-oboSupported": false, "x-scope": [ { "scope": "spend.vendor:write", "group": "Spend", "resource_name": "Vendors", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-badges": [ { "name": "Beta" } ] } }, "/api/v1/ecosystem/connected_stores": { "get": { "tags": [ "Supporting Services > Connected Stores" ], "summary": "2|List all Connected Stores", "description": "Get a list of connected stores based on the query parameters.", "operationId": "listConnectedStores", "x-oboSupported": false, "parameters": [ { "name": "from_created_at", "in": "query", "description": "The start time of created_at in ISO8601 format.", "required": false, "schema": { "type": "string" } }, { "name": "page_num", "in": "query", "description": "The number of the page. Starts from 0. Defaults to 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "The number of items returned per page. Defaults to 20.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "to_created_at", "in": "query", "description": "The end time of created_at in ISO8601 format.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "The paginated connected store objects.", "items": { "$ref": "#/components/schemas/Store" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "default_currency": "USD", "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "airwallex shop", "platform": "`AMAZON`", "platform_seller_id": "A3HCQF5OX1HL0K", "status": "`CONNECTED`", "url": "https://www.amazon.com/shops/A3HCQF5OX1HL0K" } ] } } } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too many requests" }, "500": { "description": "Server Error" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/ecosystem/connected_stores", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "default_currency": "USD", "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "airwallex shop", "platform": "`AMAZON`", "platform_seller_id": "A3HCQF5OX1HL0K", "status": "`CONNECTED`", "url": "https://www.amazon.com/shops/A3HCQF5OX1HL0K" } ] } } ], "x-scope": [ { "scope": "commerce_store:read", "group": "Supporting Services", "resource_name": "Commerce Stores", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/ecosystem/connected_stores/{id}": { "get": { "tags": [ "Supporting Services > Connected Stores" ], "summary": "1|Retrieve a Connected Store", "description": "Gets the details of a Connected Store object by unique identifier.", "operationId": "retrieveConnectedStore", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the connected store object.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "connected_store_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" }, "examples": { "default": { "value": { "default_currency": "USD", "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "airwallex shop", "platform": "`AMAZON`", "platform_seller_id": "A3HCQF5OX1HL0K", "status": "`CONNECTED`", "url": "https://www.amazon.com/shops/A3HCQF5OX1HL0K" } } } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too many requests" }, "500": { "description": "Server Error" } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/ecosystem/connected_stores/connected_store_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "default_currency": "USD", "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "name": "airwallex shop", "platform": "`AMAZON`", "platform_seller_id": "A3HCQF5OX1HL0K", "status": "`CONNECTED`", "url": "https://www.amazon.com/shops/A3HCQF5OX1HL0K" } } ], "x-scope": [ { "scope": "commerce_store:read", "group": "Supporting Services", "resource_name": "Commerce Stores", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/files/download_links": { "post": { "tags": [ "Supporting Services > File Service" ], "summary": "2|List all File Download Links", "description": "Populate the download request with a list of file unique identifiers and the API responds with associated download links. Links will be valid for 1 day. Files do not exceed 20MB. Can also be used by Scale platforms to download files for connected accounts using the x-on-behalf-of header. ", "operationId": "filesDownloadLinks", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file_ids": { "type": "array", "description": "List of file unique identifiers to retrieve download links for.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "file_ids": [] } } } } }, "description": "fileIdsRequest", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadLinks" }, "examples": { "default": { "value": { "absent_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "files": [ { "content_type": "application/octet-stream", "download_link_valid_until": "2022-01-18T21:38:52Z", "file_id": "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==", "filename": "registration_certificate.pdf", "size": 120591, "url": "https://airwallex-upload-shenzhen-dev.oss-accelerate.aliyuncs.com/YmVkOI2MDIxOQ%3D%3D?Expires=1637271532&OSSAccessKeyId=&Signature=GNGvvv0%3D" } ] } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\",\"validation_failed\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/files/download_links", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "file_ids": [] }, "response_body": { "absent_files": [ "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==" ], "files": [ { "content_type": "application/octet-stream", "download_link_valid_until": "2022-01-18T21:38:52Z", "file_id": "YmVkODdkNGMtNWFiZC00MzM0LdGVzdC5wZGZfMTYxNTI2MDIxOQ==", "filename": "registration_certificate.pdf", "size": 120591, "url": "https://airwallex-upload-shenzhen-dev.oss-accelerate.aliyuncs.com/YmVkOI2MDIxOQ%3D%3D?Expires=1637271532&OSSAccessKeyId=&Signature=GNGvvv0%3D" } ] } } ], "x-scope": [ { "scope": "onboarding_file:read", "group": "Supporting Services", "resource_name": "Files", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/files/upload": { "post": { "tags": [ "Supporting Services > File Service" ], "summary": "1|Upload a File", "description": "Upload a file to Airwallex using this endpoint of the `files.airwallex.com` subdomain. The max size of upload file is up to 20MB. Supported file extensions are pdf, jpg, png, doc, docx, xls, xlsx, csv, jpeg, cer, bmp, tif, tiff, webm, mov, mp4, heic, m4a, weba, mp3, wav, aac, amr, and xml. When you upload a file, the API responds with a `file_id`. This file unique identifier can then be referenced as required as part of the attachments object in our other endpoints.", "operationId": "upload", "x-oboSupported": false, "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "The file to upload, max length of filename is 50 characters.", "type": "string", "format": "binary" }, "notes": { "description": "The notes of the uploaded file, max length is 50 characters.", "type": "string" }, "purpose": { "description": "The intended use case of the file. Files are general-purpose by default; set a purpose when the endpoint you'll pass the file to requires one, so the file is provisioned correctly for that use case. Omit otherwise.", "type": "string", "enum": [ "SPEND_ATTACHMENT" ], "x-enumDescriptions": { "SPEND_ATTACHMENT": "Attaching a supporting document to a Spend resource as evidence, such as an expense receipt or purchase order invoice." } } }, "required": [ "file" ] }, "examples": { "default": { "value": { "file": "@your_file.pdf", "notes": "" } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileInformation" }, "examples": { "default": { "value": { "created": 0, "file_id": "", "filename": "", "notes": "", "object_type": "", "size": 0 } } } } } }, "400": { "description": "[\"field_required\",\"invalid_argument\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/files/upload", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "multipart/form-data" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "file": "@your_file.pdf", "notes": "" }, "response_body": { "created": 0, "file_id": "", "filename": "", "notes": "", "object_type": "", "size": 0 } } ], "x-scope": [ { "scope": "file:write", "group": "Supporting Services", "resource_name": "Files", "oauthSupported": true, "apiKeySupported": true } ], "servers": [ { "url": "https://files.airwallex.com", "description": "Production" }, { "url": "https://files.sandbox.airwallex.com", "description": "Sandbox" } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/industry_categories": { "get": { "tags": [ "Supporting Services > Reference Data" ], "summary": "1|Industry Categories", "description": "Get a tree of industry categories and associated codes and questions.", "operationId": "listIndustryCategories", "x-oboSupported": false, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryCategoryV3Item" } }, "examples": { "default": { "value": [ { "answer": "Yes", "name": "Digital and tech", "question": "", "type": "LIST", "value": "", "values": [ { "name": "Financial data and research", "type": "code", "value": "ICCV3_0002XX" }, { "name": "Game", "type": "question", "question": "Does your product contain Transferable Virtual Assets (TVA) such as tools, ski...", "values": [ { "answer": "Yes", "type": "code", "value": "ICCV3_000300" }, { "answer": "No", "type": "code", "value": "ICCV3_000301" } ] } ] } ] } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/reference/industry_categories", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": [ { "answer": "Yes", "name": "Digital and tech", "question": "", "type": "LIST", "value": "", "values": [ { "name": "Financial data and research", "type": "code", "value": "ICCV3_0002XX" }, { "name": "Game", "type": "question", "question": "Does your product contain Transferable Virtual Assets (TVA) such as tools, ski...", "values": [ { "answer": "Yes", "type": "code", "value": "ICCV3_000300" }, { "answer": "No", "type": "code", "value": "ICCV3_000301" } ] } ] } ] } ], "x-oauthSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/invalid_conversion_dates": { "get": { "tags": [ "Supporting Services > Reference Data" ], "summary": "2|Invalid Conversion Dates", "description": "Gets a list of invalid conversion dates for a specified `currency_pair`.", "operationId": "listInvalidConversionDates", "parameters": [ { "name": "currency_pair", "in": "query", "description": "Currency pair to get the invalid conversion dates for.", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": "AUDUSD" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidConversionDates" }, "examples": { "default": { "value": { "currency_pair": "AUDUSD", "invalid_conversion_dates": [ { "date": "2017-12-25", "reason": "Christmas Day" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/reference/invalid_conversion_dates", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "currency_pair": "AUDUSD", "invalid_conversion_dates": [ { "date": "2017-12-25", "reason": "Christmas Day" } ] } } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/supported_currencies": { "get": { "tags": [ "Supporting Services > Reference Data" ], "summary": "3|Supported Currencies", "description": "Gets the client-specific list of currencies that can be bought or sold.", "operationId": "listSupportedCurrencies", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedCurrencies" }, "examples": { "default": { "value": { "conversion": { "buy_currencies": [ "AUD", "CAD", "EUR", "GBP", "HKD", "JPY", "NZD", "SGD", "USD", "CNY" ], "sell_currencies": [ "AUD", "CAD", "EUR", "GBP", "HKD", "JPY", "NZD", "SGD", "USD", "CNY" ] } } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/reference/supported_currencies", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "conversion": { "buy_currencies": [ "AUD", "CAD", "EUR", "GBP", "HKD", "JPY", "NZD", "SGD", "USD", "CNY" ], "sell_currencies": [ "AUD", "CAD", "EUR", "GBP", "HKD", "JPY", "NZD", "SGD", "USD", "CNY" ] } } } ], "x-scope": [ { "scope": "payouts.transfer:read", "group": "Payouts", "resource_name": "Transfers", "oauthSupported": false, "apiKeySupported": true }, { "scope": "transfer:read", "group": "Authentication", "resource_name": "Embedded Components - Transfers", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/order_items/expiring_quota": { "get": { "tags": [ "Supporting Services > Reference Data" ], "summary": "4|Retrieve the Expiring Transfer or Deposit Limit", "description": "Get available transfer or deposit limit that is about to expire in the next week.", "operationId": "retrieveExpiringQuota", "parameters": [ { "name": "type", "in": "query", "description": "type.", "required": false, "schema": { "type": "string", "enum": [ "CN_INBOUND", "ID_OUTBOUND", "VN_OUTBOUND" ], "default": "CN_INBOUND" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpiringQuota" }, "examples": { "default": { "value": { "currency": "CNY", "expire_by": "2021-09-16", "expiring_order_amount": 1000 } } } } } }, "400": { "description": "Bad request. Data provided is either incomplete or malformed." }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/reference/order_items/expiring_quota", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "currency": "CNY", "expire_by": "2021-09-16", "expiring_order_amount": 1000 } } ], "x-scope": [ { "scope": "reference.order_item:read", "group": "Supporting Services", "resource_name": "Order Items", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/order_items/quota": { "get": { "tags": [ "Supporting Services > Reference Data" ], "summary": "5|Retrieve the Transfer or Deposit Limit", "description": "Get available transfer or deposit limit.", "operationId": "retrieveQuota", "parameters": [ { "name": "type", "in": "query", "description": "type.", "required": false, "schema": { "type": "string", "enum": [ "CN_INBOUND", "ID_OUTBOUND", "VN_OUTBOUND" ], "default": "CN_INBOUND" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderQuota" }, "examples": { "default": { "value": { "available_order_amount": 1000, "currency": "CNY", "history_order_amount": 1000 } } } } } }, "400": { "description": "Bad request. Data provided is either incomplete or malformed." }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/reference/order_items/quota", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "available_order_amount": 1000, "currency": "CNY", "history_order_amount": 1000 } } ], "x-scope": [ { "scope": "reference.order_item:read", "group": "Supporting Services", "resource_name": "Order Items", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/reference/order_items/upload": { "post": { "tags": [ "Supporting Services > Reference Data" ], "summary": "6|Increase Transfer or Deposit Limit", "description": "Increase your transfer or deposit limit by providing cross-border sales order information. Before uploading, please learn about [payout limits](/docs/payouts/transfers/transfers-to-from-countries-with-regulatory-requirements) or [deposit limits](/docs/global-treasury/get-started/global-accounts/global-accounts-in-regulated-countriesregions).\n\nType CN_INBOUND needs to be enabled before calling this endpoint, please contact your Account Manager. You may provide up to 500 items with each request.", "operationId": "uploadOrderItems", "parameters": [ { "name": "allow_partial_success", "in": "query", "description": "Allow any order items that pass validation to be used for increasing the limit. If `false`, all order items must pass validation or the request will be rejected. Defaults to `false`.", "required": false, "allowEmptyValue": false, "schema": { "type": "boolean", "default": false } }, { "name": "types", "in": "query", "description": "Type of limit(s) to increase. Support any of `CN_INBOUND`, `ID_OUTBOUND`, defaults to `CN_INBOUND`.", "required": false, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CN_INBOUND", "ID_OUTBOUND", "VN_OUTBOUND" ] }, "enum": [ "CN_INBOUND", "ID_OUTBOUND", "VN_OUTBOUND" ], "default": "CN_INBOUND" } }, { "name": "x-jwt-oauth-client-id", "in": "header", "description": "x-jwt-oauth-client-id.", "required": false, "schema": { "type": "string" } }, { "name": "x-jwt-type", "in": "header", "description": "x-jwt-type.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "category", "currency", "item_name", "item_quantity", "item_unit_price", "item_url", "line_total", "order_datetime", "order_id", "shipment_provider", "shipment_tracking_number" ], "properties": { "category": { "type": "string", "description": "Category of your sales order. One of `goods_trade_online`, `goods_trade_offline`, `services_trade_education_and_training`, `services_trade_international_logistics`, `services_trade_software`, `services_trade_professional`, `services_trade_travel`, `services_trade_travel_and_hospitality`." }, "currency": { "type": "string", "description": "Order currency in ISO format, One of `AED`,`ALL`,`AMD`,`ANG`,`AOA`,`ARS`,`AUD`,`AWG`,`AZN`,`BAM`,`BBD`,`BDT`,`BGN`,`BIF`,`BMD`,`BND`,`BOB`,`BRL`,`BSD`,`BTN`,`BWP`,`BZD`,`CAD`,`CHF`,`CLP`,`COP`,`CRC`,`CVE`,`CZK`,`DJF`,`DKK`,`DOP`,`DZD`,`EGP`,`ERN`,`ETB`,`EUR`,`FJD`,`FKP`,`GBP`,`GEL`,`GHS`,`GIP`,`GMD`,`GNF`,`GTQ`,`GYD`,`HKD`,`HNL`,`HRK`,`HUF`,`IDR`,`ILS`,`INR`,`ISK`,`JMD`,`JOD`,`JPY`,`KES`,`KGS`,`KHR`,`KMF`,`KRW`,`KWD`,`KYD`,`KZT`,`LAK`,`LBP`,`LKR`,`LRD`,`LSL`,`LYD`,`MAD`,`MDL`,`MGA`,`MKD`,`MNT`,`MOP`,`MRU`,`MUR`,`MVR`,`MWK`,`MXN`,`MYR`,`NAD`,`NIO`,`NOK`,`NPR`,`NZD`,`OMR`,`PAB`,`PEN`,`PGK`,`PHP`,`PKR`,`PLN`,`PYG`,`QAR`,`RON`,`RSD`,`RWF`,`SAR`,`SBD`,`SCR`,`SEK`,`SGD`,`SHP`,`SLL`,`SRD`,`STN`,`SVC`,`SZL`,`THB`,`TJS`,`TMT`,`TND`,`TOP`,`TRY`,`TTD`,`TWD`,`TZS`,`UAH`,`UGX`,`USD`,`UYU`,`UZS`,`VND`,`VUV`,`WST`,`XAF`,`XCD`,`XOF`,`XPF`,`ZAR`,`ZMW`." }, "description": { "type": "string", "description": "Description of the order." }, "item_name": { "type": "string", "description": "Item name (min. 2 character and max. 256 characters)." }, "item_quantity": { "type": "number", "description": "Quantity of the item, must be an integer." }, "item_reference": { "type": "string", "description": "Short reference for reconciliation purposes, which will not be passed to external parties." }, "item_unit_price": { "type": "number", "description": "Item's unit price." }, "item_url": { "type": "string", "description": "URL of the item (min. 1 characters and max. 1000 characters)." }, "line_total": { "type": "number", "description": "Line total of the item." }, "order_datetime": { "type": "string", "description": "Order date time in ISO format, (formatted in ISO08601 datetime format), no more than 350 days old." }, "order_id": { "type": "string", "description": "Order unique identifier (min. 1 characters and max. 50 characters)." }, "shipment_provider": { "type": "string", "description": "Name of the logistics provider." }, "shipment_tracking_number": { "type": "string", "description": "Tracking number issued by the logistics provider (min. 5 characters and max. 35 characters)." } } } }, "examples": { "default": { "value": [ { "category": "goods_trade_online", "currency": "IDR", "description": "book", "item_name": "book", "item_quantity": 1, "item_reference": "ac3342a4a9434ba69a91bb1c9966b477", "item_unit_price": 19.38, "item_url": "", "line_total": 100, "order_datetime": "2021-09-16T03:52:34+0000", "order_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "shipment_provider": "", "shipment_tracking_number": "EG420386995JP" } ] } } } }, "description": "orderItemDtos", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/reference/order_items/upload", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": [ { "category": "goods_trade_online", "currency": "IDR", "description": "book", "item_name": "book", "item_quantity": 1, "item_reference": "ac3342a4a9434ba69a91bb1c9966b477", "item_unit_price": 19.38, "item_url": "", "line_total": 100, "order_datetime": "2021-09-16T03:52:34+0000", "order_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2", "shipment_provider": "", "shipment_tracking_number": "EG420386995JP" } ] } ], "x-scope": [ { "scope": "reference.order_item:write", "group": "Supporting Services", "resource_name": "Order Items", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversions/create": { "post": { "tags": [ "Transactional FX > Conversion" ], "summary": "1|Create a Conversion", "description": "Create a new conversion to be executed within your Airwallex wallet. To associate a conversion with a payout, use the Payment API. (Note: Some [exotic currencies](/docs/transactional-fx/supported-regions-and-currencies) require conversions to be associated with payouts.) \n \nIf using Quotes, users must provide a valid Quote ID in the conversion request. The key details of the conversion request such as buy_currency, sell_currency, and conversion_date (if specified) must match the quote details. Otherwise, users can leave the Quote ID field blank, resulting in the conversion being executed at the current market rate. \n \nOn a conversion, populate both `buy_currency` and `sell_currency`, but define only one of either `buy_amount` or `sell_amount`. This populated amount defines the dealt (also known as fixed) side of the conversion. The other amount will be computed by Airwallex based on the exchange rate of the conversion. The minimum conversion limit per conversion is USD $1.", "operationId": "createConversion", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "buy_currency", "request_id", "sell_currency" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transaction.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } } }, "buy_amount": { "type": "string", "description": "Amount in `buy_currency` that the client buys. Must be specified if `sell_amount` is not specified." }, "buy_currency": { "type": "string", "description": "Currency that the client buys (in 3-letter ISO-4217 format)." }, "conversion_date": { "type": "string", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified." }, "funding_source": { "type": "object", "required": [ "id" ], "description": "The funding information for this conversion. By default (when the funding object is not specified), conversions will source funds from the wallet.", "properties": { "debit_type": { "type": "string", "description": "The type of deposit you would like to create. If not specified, it will default to DIRECT_DEBIT.", "enum": [ "DIRECT_DEBIT", "FASTER_DIRECT_DEBIT" ] }, "id": { "type": "string", "description": "The funding source unique identifier only supports Linked Accounts. Please provide the unique identifier of your Linked Account as returned in [Create a Linked Account](/docs/api/core_resources/linked_accounts/create). Note that if not specified, the funding source will default to your Wallet." } } }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the conversion.", "additionalProperties": { "type": "string" } }, "quote_id": { "type": "string", "description": "Provide a valid Quote unique identifier if you want the conversion executed at the `client_rate` returned in the quote." }, "request_id": { "type": "string", "description": "Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same `request_id` will be rejected. Parameter supports a maximum of 64 characters." }, "sell_amount": { "type": "string", "description": "Amount in `sell_currency` that the client sells. Must be specified if `buy_amount` is not specified." }, "sell_currency": { "type": "string", "description": "Currency that the client sells (in 3-letter ISO-4217 format)." } } }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "buy_amount": "10000", "buy_currency": "USD", "conversion_date": "2017-03-22", "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "metadata": {}, "quote_id": "", "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": "", "sell_currency": "AUD" } } } } }, "description": "request", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": "10000", "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "funding": { "debit_type": "DIRECT_DEBIT", "failure_reason": "", "funding_source_id": "", "status": "" }, "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "mid_rate": 0.761223, "quote_id": "", "rate_details": [ { "buy_amount": "10000", "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } } } } } }, "400": { "description": "[\"amount_above_limit\"\n,\"amount_below_limit\"\n,\"conflict_original_ccy\"\n,\"expired_quote\"\n,\"field_required\"\n,\"invalid_argument\"\n,\"invalid_endpoint\"\n,\"invalid_quote_id\"\n,\"invalid_settlement_date\"\n,\"operation_failed\"\n,\"unsupported_currency\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/fx/conversions/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "buy_amount": "10000", "buy_currency": "USD", "conversion_date": "2017-03-22", "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "metadata": {}, "quote_id": "", "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": "", "sell_currency": "AUD" }, "response_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": "10000", "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "funding": { "debit_type": "DIRECT_DEBIT", "failure_reason": "", "funding_source_id": "", "status": "" }, "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "mid_rate": 0.761223, "quote_id": "", "rate_details": [ { "buy_amount": "10000", "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } } ], "x-scope": [ { "scope": "fx.conversion:write", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversions": { "get": { "tags": [ "Transactional FX > Conversion" ], "summary": "3|List all Conversions", "description": "Retrieve conversions, using any combination of optional queryable parameters below. You may specify none, one of, or both `from_created_at` or `to_created_at` parameters. If none of these parameters are specified, results for the last 31 days will be returned. If only one of these parameters are specified, we will assume a 31-day range to calculate the other, undefined parameter. The conversions are returned in descending order, with the most recent transactions appearing first. Each queryable parameter below supports only one defined value at a time.", "operationId": "listConversion", "parameters": [ { "name": "buy_currency", "in": "query", "description": "Currency that the client bought (in 3-letter ISO-4217 format).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "AUD" } }, { "name": "from_created_at", "in": "query", "description": "The starting value for specifying a date range for results to be returned. The date range is specific to conversion creation (a conversion's `created_at` date). Specify a starting `created_at` date (in ISO-8601 format). This starting date is inclusive of the range.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01" } }, { "name": "page_num", "in": "query", "description": "Page number, starts from 0.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Number of results per page. Default value is 100.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "request_id", "in": "query", "description": "Client-supplied conversion `request_id` (idempotency key).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "request_id" } }, { "name": "sell_currency", "in": "query", "description": "Currency that the client sold (in 3-letter ISO-4217 format).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } }, { "name": "status", "in": "query", "description": "Status of the conversion. Can be one of`SCHEDULED`, `OVERDUE`, `CANCELLED`, `SETTLED`.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "SCHEDULED" } }, { "name": "to_created_at", "in": "query", "description": "The ending value for specifying a date range for results to be returned. The date range is specific to conversion creation (a conversion's `created_at` date). Specify an ending `created_at` date (in ISO-8601 format). This ending date is inclusive of the range.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": "2017-04-01T03:52:34+0000" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Conversion" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": 10000, "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "mid_rate": 0.761223, "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } ] } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/conversions", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": 10000, "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "mid_rate": 0.761223, "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } ] } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversions/{conversion_id}": { "get": { "tags": [ "Transactional FX > Conversion" ], "summary": "2|Retrieve a Conversion", "description": "Get a specific conversion by specifying the Airwallex `conversion_id`.", "operationId": "retrieveConversion", "parameters": [ { "name": "conversion_id", "in": "path", "description": "Unique identifier of the conversion to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede" }, "examples": { "default": { "value": "conversion_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": 10000, "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "funding": { "debit_type": "DIRECT_DEBIT", "failure_reason": "", "funding_source_id": "", "status": "" }, "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "mid_rate": 0.761223, "quote_id": "", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } } } } } }, "400": { "description": "[\"field_required\"\n,\"invalid_argument\"\n,]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "404": { "description": "[\"not_found\"\n]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/conversions/conversion_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.781523, "buy_amount": 10000, "buy_currency": "USD", "client_rate": 0.781623, "conversion_date": "2017-03-22", "conversion_id": "d9af1614-a6a1-4d45-aae7-6858fc6d9ede", "created_at": "2017-03-20T10:08:12+1100", "currency_pair": "AUDUSD", "dealt_currency": "USD", "funding": { "debit_type": "DIRECT_DEBIT", "failure_reason": "", "funding_source_id": "", "status": "" }, "funding_source": { "debit_type": "DIRECT_DEBIT", "id": "" }, "mid_rate": 0.761223, "quote_id": "", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "request_id": "67f687fe-dcf4-4462-92fa-20335301d9d8", "sell_amount": 12794.27, "sell_currency": "AUD", "settlement_cutoff_at": "2017-03-22T14:00:00+1100", "short_reference_id": "20170608-AF3GJ9", "status": "SETTLED", "updated_at": "2017-03-20T14:00:01+1100" } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversion_amendments/create": { "post": { "tags": [ "Transactional FX > Conversion Amendments" ], "summary": "1|Create an Amendment", "description": "Create an amendment on a booked but unsettled conversion.", "operationId": "createConversionAmendment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "conversion_id", "request_id", "type" ], "properties": { "charge_currency": { "type": "string", "description": "Currency charged on the delta that arises with the amendment. Only the currencies from the original conversion are allowed. Default will be set to the non-fixed side of the original conversion." }, "conversion_id": { "type": "string", "description": "Unique identifier of the conversion to be amended." }, "metadata": { "type": "object", "description": "Persisted client-supplied metadata. A metadata JSON object with a maximum of 10 key-value pairs (each key and value must be less than 255 characters)." }, "request_id": { "type": "string", "description": "Client-generated idempotency key." }, "type": { "type": "string", "description": "Defines the type of amendment to be created. Only `CANCEL` is supported.", "enum": [ "CANCEL" ], "x-enumDescriptions": { "CANCEL": "Full cancellation of the original conversion." } } } }, "examples": { "default": { "value": { "charge_currency": "USD", "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "type": "CANCEL" } } } } }, "description": "request", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionAmendment" }, "examples": { "default": { "value": { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } } } } } }, "400": { "description": "[\"account_not_authorized\"\n,\"does_not_exist\"\n,\"field_required\"\n,\"invalid_status_for_operation\"\n,\"invalid_charge_currency\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/fx/conversion_amendments/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "charge_currency": "USD", "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "type": "CANCEL" }, "response_body": { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } } ], "x-scope": [ { "scope": "fx.conversion:write", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversion_amendments": { "get": { "tags": [ "Transactional FX > Conversion Amendments" ], "summary": "3|List all Amendments", "description": "Retrieve all amendments associated with a conversion unique identifier. (Right now, since only full cancellations are supported, a conversion will only have up to 1 associated amendment.).", "operationId": "listConversionAmendments", "parameters": [ { "name": "conversion_id", "in": "query", "description": "Unique identifier of the conversion.", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "A flag which identifies whether there are more results." }, "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/ConversionAmendment" } } } }, "examples": { "default": { "value": { "has_more": false, "items": [ { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } ] } } } } } }, "400": { "description": "[\"account_not_authorized\"\n,\"does_not_exist\"\n,\"field_required\"\n,\"invalid_status_for_operation\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/conversion_amendments", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "has_more": false, "items": [ { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } ] } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversion_amendments/quote": { "post": { "tags": [ "Transactional FX > Conversion Amendments" ], "summary": "4|Create an Amendment Quote", "description": "Create an amendment quote on a booked but unsettled conversion. Get an indicative quote for the charge fee. ", "operationId": "conversionAmendments_quote", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "conversion_id", "request_id", "type" ], "properties": { "charge_currency": { "type": "string", "description": "Currency charged on the delta that arises with the amendment. Only the currencies from the original conversion are allowed. Default will be set to the non-fixed side of the original conversion." }, "conversion_id": { "type": "string", "description": "Unique identifier of the conversion to be amended." }, "metadata": { "type": "object", "description": "Persisted client-supplied metadata. A metadata JSON object with a maximum of 10 key-value pairs (each key and value must be less than 255 characters)." }, "request_id": { "type": "string", "description": "Client-generated idempotency key." }, "type": { "type": "string", "description": "Defines the type of amendment to be created. Only `CANCEL` is supported.", "enum": [ "CANCEL" ], "x-enumDescriptions": { "CANCEL": "Full cancellation of the original conversion." } } } }, "examples": { "default": { "value": { "charge_currency": "USD", "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "type": "CANCEL" } } } } }, "description": "request", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionAmendmentQuote" }, "examples": { "default": { "value": { "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL" } } } } } }, "400": { "description": "[\"account_not_authorized\"\n,\"does_not_exist\"\n,\"field_required\"\n,\"invalid_status_for_operation\"\n,\"invalid_charge_currency\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/fx/conversion_amendments/quote", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "charge_currency": "USD", "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "type": "CANCEL" }, "response_body": { "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL" } } ], "x-scope": [ { "scope": "fx.conversion:write", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/conversion_amendments/{conversion_amendment_id}": { "get": { "tags": [ "Transactional FX > Conversion Amendments" ], "summary": "2|Retrieve an Amendment", "description": "Retrieve the details of a specific amendment using the amendment unique identifier.", "operationId": "retrieveConversionAmendment", "parameters": [ { "name": "conversion_amendment_id", "in": "path", "description": "Unique identifier of the amendment.", "required": true, "schema": { "type": "string", "default": "9593ca22-8933-4585-9a15-078c8ce654ad" }, "examples": { "default": { "value": "conversion_amendment_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionAmendment" }, "examples": { "default": { "value": { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } } } } } }, "400": { "description": "[\"account_not_authorized\"\n,\"does_not_exist\"\n,\"field_required\"\n,\"invalid_status_for_operation\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/conversion_amendments/conversion_amendment_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "amendment_id": "9593ca22-8933-4585-9a15-078c8ce654ad", "charges": [ { "amount": 1.36, "awx_rate": 1.383429, "client_rate": 1.390346, "currency": "USD", "currency_pair": "GBPUSD", "type": "FEE" } ], "conversion_id": "a74317c0-ed25-4e6e-82b2-82baa5cd9c20", "created_at": "2021-07-14T06:09:39+0000", "metadata": { "reason": "rejected_trade_attempt_968059869" }, "request_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "short_reference_id": "C220407-AF3GJ9F", "type": "CANCEL", "updated_at": "2021-07-14T06:09:39+0000" } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/quotes/create": { "post": { "tags": [ "Transactional FX > Quotes" ], "summary": "1|Create a Quote", "description": "The Quote endpoint gives the user a guaranteed rate for an agreed period of time.", "operationId": "createQuote", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "buy_currency", "sell_currency", "validity" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transaction.", "items": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } } }, "buy_amount": { "type": "number", "description": "Amount the client buys in `buy_currency` (must be blank if `sell_amount` is specified)." }, "buy_currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) the client buys." }, "conversion_date": { "type": "string", "format": "date", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified." }, "sell_amount": { "type": "number", "description": "Amount the client sells in `sell_currency` (must be blank if `buy_amount` is specified)." }, "sell_currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) the client sells. This is the currency you will need to send us by the settlement cutoff time." }, "validity": { "type": "string", "description": "Quote validity period.", "enum": [ "MIN_1", "MIN_15", "MIN_30", "HR_1", "HR_4", "HR_8", "HR_24" ] } } }, "examples": { "default": { "value": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "buy_amount": 10000, "buy_currency": "AUD", "conversion_date": "2017-04-01", "sell_amount": 100, "sell_currency": "USD", "validity": "HR_24" } } } } }, "description": "req", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FxQuote" }, "examples": { "default": { "value": { "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.7622, "buy_amount": 10000, "buy_currency": "AUD", "client_rate": 0.7632, "conversion_date": "2017-04-01", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "mid_rate": 0.7612, "quote_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_amount": 7632, "sell_currency": "USD", "usage": "SINGLE_USE", "valid_from_at": "2019-05-03T02:49:05+0000", "valid_to_at": "2019-05-04T02:49:05+0000", "validity": "HR_24" } } } } } }, "400": { "description": "[\"amount_below_limit\"\n,\"amount_above_limit\"\n,\"operation_failed\"\n,\"field_required\"\n,\"invalid_settlement_date\"\n,\"invalid_endpoint\"\n,\"invalid_argument\"\n,\"unsupported_currency\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/fx/quotes/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "application_fee_options": [ { "amount": "5", "currency": "AUD", "percentage": "0.1", "source_type": "TRANSFER", "type": "FIXED" } ], "buy_amount": 10000, "buy_currency": "AUD", "conversion_date": "2017-04-01", "sell_amount": 100, "sell_currency": "USD", "validity": "HR_24" }, "response_body": { "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.7622, "buy_amount": 10000, "buy_currency": "AUD", "client_rate": 0.7632, "conversion_date": "2017-04-01", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "mid_rate": 0.7612, "quote_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_amount": 7632, "sell_currency": "USD", "usage": "SINGLE_USE", "valid_from_at": "2019-05-03T02:49:05+0000", "valid_to_at": "2019-05-04T02:49:05+0000", "validity": "HR_24" } } ], "x-scope": [ { "scope": "fx.conversion:write", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/quotes/{quote_id}": { "get": { "tags": [ "Transactional FX > Quotes" ], "summary": "2|Retrieve a Quote", "description": "Get a specific quote by specifying the `quote_id`.", "operationId": "retrieveQuote", "parameters": [ { "name": "quote_id", "in": "path", "description": "Unique identifier of the quote to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" }, "examples": { "default": { "value": "quote_id" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FxQuote" }, "examples": { "default": { "value": { "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.7622, "buy_amount": 10000, "buy_currency": "AUD", "client_rate": 0.7632, "conversion_date": "2017-04-01", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "mid_rate": 0.7612, "quote_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_amount": 7632, "sell_currency": "USD", "usage": "SINGLE_USE", "valid_from_at": "2019-05-03T02:49:05+0000", "valid_to_at": "2019-05-04T02:49:05+0000", "validity": "HR_24" } } } } } }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "404": { "description": "[\"not_found\"\n]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/quotes/quote_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "application_fees": [ { "amount": "5", "currency": "AUD", "source_type": "TRANSFER" } ], "awx_rate": 0.7622, "buy_amount": 10000, "buy_currency": "AUD", "client_rate": 0.7632, "conversion_date": "2017-04-01", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "mid_rate": 0.7612, "quote_id": "a08c0f2f-3f26-4443-b5df-fad15582eb94", "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_amount": 7632, "sell_currency": "USD", "usage": "SINGLE_USE", "valid_from_at": "2019-05-03T02:49:05+0000", "valid_to_at": "2019-05-04T02:49:05+0000", "validity": "HR_24" } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/fx/rates/current": { "get": { "tags": [ "Transactional FX > Rates" ], "summary": "1|Retrieve a Current Rate", "description": "Retrieve a current rate for the buy/sell currency and amount. Note that the amount is validated against the upper conversion limit to ensure that a conversion for the specified amount can be executed.", "operationId": "retrieveCurrent", "parameters": [ { "name": "buy_amount", "in": "query", "description": "Amount the client buys in `buy_currency` (must be blank if `sell_amount` is specified). Defaults to 10000 if neither `buy_amount` or `sell_amount` is specified.", "required": false, "allowEmptyValue": false, "schema": { "type": "number", "default": 10000 } }, { "name": "buy_currency", "in": "query", "description": "Currency (3-letter ISO-4217 code) the client buys.", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": "AUD" } }, { "name": "conversion_date", "in": "query", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "format": "date", "default": "2017-04-01" } }, { "name": "sell_amount", "in": "query", "description": "Amount the client sells in `sell_currency` (must be blank if `buy_amount` is specified).", "required": false, "allowEmptyValue": false, "schema": { "type": "number" } }, { "name": "sell_currency", "in": "query", "description": "Currency (3-letter ISO-4217 code) the client sells. This is the currency you will need to send us by the settlement cutoff time.", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FxRates" }, "examples": { "default": { "value": { "buy_currency": "AUD", "conversion_date": "2017-04-01", "created_at": "2019-05-04T02:49:05+0000", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "rate": 7632, "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_currency": "USD" } } } } } }, "400": { "description": "[\"amount_above_limit\"\n,\"invalid_settlement_date\"\n,\"invalid_endpoint\"\n,\"invalid_argument\"\n,\"unsupported_currency\"]" }, "401": { "description": "[\"credentials_invalid\"\n,\"credentials_expired\"]" }, "429": { "description": "Too many requests" }, "500": { "description": "Service unavailable" } }, "deprecated": false, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/fx/rates/current", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "buy_currency": "AUD", "conversion_date": "2017-04-01", "created_at": "2019-05-04T02:49:05+0000", "currency_pair": "AUDUSD", "dealt_currency": "AUD", "rate": 7632, "rate_details": [ { "buy_amount": 10000, "level": "CLIENT", "rate": 0.781523, "sell_amount": 12794.27 } ], "sell_currency": "USD" } } ], "x-scope": [ { "scope": "fx.conversion:read", "group": "Transactional FX", "resource_name": "Conversion", "oauthSupported": true, "apiKeySupported": true } ], "x-oauthSupported": true, "x-oboSupported": true, "x-resourceLevel": "account" } }, "/api/v1/webhooks/create": { "post": { "tags": [ "Webhooks > Webhooks" ], "summary": "1|Create a Webhook", "description": "Creates a new Webhook and subscribes to a list of webhook events from Airwallex.", "operationId": "createWebhook", "x-oboSupported": false, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "events", "request_id", "url", "version" ], "properties": { "url": { "type": "string", "description": "The endpoint where events are sent to." }, "version": { "type": "string", "description": "The [API version](/docs/api/versioning) which controls the event payload structure. It should be in YYYY-MM-DD format, e.g. `2022-11-11`." }, "events": { "type": "array", "description": "A list of [events](/docs/developer-tools/webhooks/listen-for-webhook-events/event-types) subscribed by this webhook. Events cannot be modified after creation. Only events matching your [API key scopes](/docs/developer-tools/api/api-key-scopes) are allowed.", "items": { "type": "string", "description": "A list of [events](/docs/developer-tools/webhooks/listen-for-webhook-events/event-types) subscribed by this webhook. Events cannot be modified after creation. Only events matching your [API key scopes](/docs/developer-tools/api/api-key-scopes) are allowed." } }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client for idempotency. Up to 50 characters." } } }, "examples": { "default": { "value": { "url": "https://www.airwallex.com", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } } } }, "required": true }, "responses": { "201": { "description": "Create a webhook successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiWebhook" }, "examples": { "default": { "value": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } } } } }, "400": { "description": "Possible errors: `field_required`, `invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Possible errors: `unauthorized`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Possible errors: `already_exists`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/webhooks/create", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 201, "reason_phrase": "Created", "request_body": { "url": "https://www.airwallex.com", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" }, "response_body": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } ], "x-scope": [ { "scope": "webhook:write", "group": "Webhooks", "resource_name": "Webhooks", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/webhooks/{id}/delete": { "post": { "tags": [ "Webhooks > Webhooks" ], "summary": "5|Delete a Webhook", "description": "Deletes a Webhook. A deleted webhook will no longer receive webhook events of any Airwallex organisations or accounts.", "operationId": "deleteWebhook", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the Webhook object.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "webhook_id" } } } ], "responses": { "200": { "description": "Delete a webhook successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiWebhookDelete" }, "examples": { "default": { "value": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "deleted": false } } } } } }, "400": { "description": "Possible errors: `field_required`, `invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Possible errors: `credentials_invalid`, `credentials_expired`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The requested resource doesn't exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/webhooks/webhook_id/delete", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "deleted": false } } ], "x-scope": [ { "scope": "webhook:write", "group": "Webhooks", "resource_name": "Webhooks", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/webhooks": { "get": { "tags": [ "Webhooks > Webhooks" ], "summary": "3|List all Webhooks", "description": "Retrieves a list of Webhooks.", "operationId": "listWebhooks", "x-oboSupported": false, "parameters": [ { "name": "page_size", "in": "query", "description": "Number of Webhooks per page. Defaults to 20.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of `page_after` (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of `page_before` (if not null) from the response to a subsequent call.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a list of webhooks successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiWebhookPagination" }, "examples": { "default": { "value": { "items": [ { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } ], "page_before": "", "page_after": "" } } } } } }, "400": { "description": "Possible errors: `invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Possible errors: `credentials_invalid`, `credentials_expired`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/webhooks", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "items": [ { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } ], "page_before": "", "page_after": "" } } ], "x-scope": [ { "scope": "webhook:read", "group": "Webhooks", "resource_name": "Webhooks", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/webhooks/{id}": { "get": { "tags": [ "Webhooks > Webhooks" ], "summary": "2|Retrieve a Webhook", "description": "Retrieves the details of a Webhook.", "operationId": "retrieveWebhook", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the Webhook object.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "webhook_id" } } } ], "responses": { "200": { "description": "Retrieve a webhook successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiWebhook" }, "examples": { "default": { "value": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } } } } }, "400": { "description": "Possible errors: `invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Possible errors: `unauthorized`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The requested resource doesn't exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "GET", "uri": "/api/v1/webhooks/webhook_id", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "response_body": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } ], "x-scope": [ { "scope": "webhook:read", "group": "Webhooks", "resource_name": "Webhooks", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } }, "/api/v1/webhooks/{id}/update": { "post": { "tags": [ "Webhooks > Webhooks" ], "summary": "4|Update a Webhook", "description": "Updates the attributes of an existing Webhook. Only updates to `url` are currently supported.", "operationId": "updateWebhook", "x-oboSupported": false, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the Webhook object.", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "webhook_id" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The endpoint where events are sent to." } } }, "examples": { "default": { "value": { "url": "https://www.airwallex.com" } } } } }, "required": true }, "responses": { "200": { "description": "Update a webhook successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiWebhook" }, "examples": { "default": { "value": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } } } } }, "400": { "description": "Possible errors: `field_required`, `invalid_argument`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Possible errors: `unauthorized`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "The requested resource doesn't exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-examples": [ { "key": "default", "name": "", "method": "POST", "uri": "/api/v1/webhooks/webhook_id/update", "request_headers": { "Authorization": "Bearer {{ACCESS_TOKEN}}", "Content-Type": "application/json" }, "status_code": 200, "reason_phrase": "OK", "request_body": { "url": "https://www.airwallex.com" }, "response_body": { "id": "wh_E6JwepZbKpppjYftl3JUEXPI-ocQiSHS", "url": "https://www.airwallex.com", "secret": "whsec_RBS_GKogxv5PAdFUPABg94kjjLGRW50I", "version": "2022-11-11", "events": [ "account.active", "account.connected", "account.suspended" ], "created_at": "2022-12-23T02:57:29+0000", "updated_at": "2022-12-23T02:57:29+0000", "request_id": "c238a67b-75ae-446f-919c-e62c2a577631" } } ], "x-scope": [ { "scope": "webhook:write", "group": "Webhooks", "resource_name": "Webhooks", "oauthSupported": false, "apiKeySupported": true } ], "x-oauthSupported": false, "x-resourceLevel": "account" } } }, "webhooks": { "account_capability.disabled": { "post": { "tags": [ "Account Capability > Account Capability" ], "description": "Account capability disabled.", "operationId": "account_capability.disabled" } }, "account_capability.enabled": { "post": { "tags": [ "Account Capability > Account Capability" ], "description": "Account capability enabled.", "operationId": "account_capability.enabled" } }, "account_capability.pending": { "post": { "tags": [ "Account Capability > Account Capability" ], "description": "Account capability pending.", "operationId": "account_capability.pending" } }, "auto.payment.execute.fail": { "post": { "tags": [ "Auto Payments > Auto Payments" ], "description": "Auto payment task execution failed.", "operationId": "auto.payment.execute.fail" } }, "auto.payment.execute.success": { "post": { "tags": [ "Auto Payments > Auto Payments" ], "description": "Auto payment task execution succeeds.", "operationId": "auto.payment.execute.success" } }, "auto.payment.will.expire": { "post": { "tags": [ "Auto Payments > Auto Payments" ], "description": "Auto payment scheduled plan will expire.", "operationId": "auto.payment.will.expire" } }, "billing_checkout.cancelled": { "post": { "tags": [ "Billing > Billing Checkouts" ], "description": "The Billing Checkout has been cancelled.", "operationId": "billing_checkout.cancelled" } }, "billing_checkout.completed": { "post": { "tags": [ "Billing > Billing Checkouts" ], "description": "The Billing Checkout has completed.", "operationId": "billing_checkout.completed" } }, "billing_checkout.created": { "post": { "tags": [ "Billing > Billing Checkouts" ], "description": "The Billing Checkout has been created.", "operationId": "billing_checkout.created" } }, "credit_note.created": { "post": { "tags": [ "Billing > Credit Notes" ], "description": "The credit note has been created.", "operationId": "credit_note.created" } }, "credit_note.finalized": { "post": { "tags": [ "Billing > Credit Notes" ], "description": "The credit note has been finalized.", "operationId": "credit_note.finalized" } }, "credit_note.voided": { "post": { "tags": [ "Billing > Credit Notes" ], "description": "The credit note has been voided.", "operationId": "credit_note.voided" } }, "invoice.created": { "post": { "tags": [ "Billing > Invoices" ], "description": "The invoice has been created.", "operationId": "invoice.created" } }, "invoice.finalized": { "post": { "tags": [ "Billing > Invoices" ], "description": "The invoice has been finalized.", "operationId": "invoice.finalized" } }, "invoice.payment.paid": { "post": { "tags": [ "Billing > Invoices" ], "description": "The invoice has been paid.", "operationId": "invoice.payment.paid" } }, "invoice.updated": { "post": { "tags": [ "Billing > Invoices" ], "description": "The invoice has been updated.", "operationId": "invoice.updated" } }, "invoice.voided": { "post": { "tags": [ "Billing > Invoices" ], "description": "The invoice has been voided.", "operationId": "invoice.voided" } }, "subscription.active": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "The subscription transits to ACTIVE status.", "operationId": "subscription.active" } }, "subscription.cancelled": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "The subscription is cancelled.", "operationId": "subscription.cancelled" } }, "subscription.created": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "A subscription has been created.", "operationId": "subscription.created" } }, "subscription.in_trial": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "The subscription transits to IN_TRIAL status.", "operationId": "subscription.in_trial" } }, "subscription.modified": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "The subscription is updated.", "operationId": "subscription.modified" } }, "subscription.unpaid": { "post": { "tags": [ "Billing > Subscriptions" ], "description": "The subscription transits to UNPAID status.", "operationId": "subscription.unpaid" } }, "billing_transaction.cancelled": { "post": { "tags": [ "Billing > Billing Transactions" ], "description": "The Billing Transaction has been cancelled.", "operationId": "billing_transaction.cancelled" } }, "billing_transaction.created": { "post": { "tags": [ "Billing > Billing Transactions" ], "description": "The Billing Transaction has been created.", "operationId": "billing_transaction.created" } }, "billing_transaction.failed": { "post": { "tags": [ "Billing > Billing Transactions" ], "description": "The Billing Transaction has failed.", "operationId": "billing_transaction.failed" } }, "billing_transaction.succeeded": { "post": { "tags": [ "Billing > Billing Transactions" ], "description": "The Billing Transaction has succeeded.", "operationId": "billing_transaction.succeeded" } }, "usage_event.aggregation_failed": { "post": { "tags": [ "Billing > Usage Events" ], "description": "The Failed Billing Usage Events have been aggregated.", "operationId": "usage_event.aggregation_failed" } }, "balance.adjustment": { "post": { "tags": [ "Core Resources > Balances" ], "description": "Balance change due to adjustment.", "operationId": "balance.adjustment" } }, "balance.ga.top_up": { "post": { "tags": [ "Core Resources > Balances" ], "description": "Balance increase. Collection via global account settled to wallet.", "operationId": "balance.ga.top_up" } }, "balance.va.top_up": { "post": { "tags": [ "Core Resources > Balances" ], "description": "Balance increase. Deposit via virtual account settled to wallet.", "operationId": "balance.va.top_up" } }, "deposit.pending": { "post": { "tags": [ "Core Resources > Deposits" ], "description": "A deposit is pending.", "operationId": "deposit.pending" } }, "deposit.rejected": { "post": { "tags": [ "Core Resources > Deposits" ], "description": "A deposit is rejected.", "operationId": "deposit.rejected" } }, "deposit.reversed": { "post": { "tags": [ "Core Resources > Deposits" ], "description": "A deposit is reversed.", "operationId": "deposit.reversed" } }, "deposit.settled": { "post": { "tags": [ "Core Resources > Deposits" ], "description": "A deposit is settled.", "operationId": "deposit.settled" } }, "direct_debit.created": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Direct debit payout instruction received.", "operationId": "direct_debit.created" } }, "direct_debit.in_review": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Direct debit payout is on hold for review.", "operationId": "direct_debit.in_review" } }, "direct_debit.pending": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Direct debit payout is pending for settlement.", "operationId": "direct_debit.pending" } }, "direct_debit.rejected": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Direct debit payout was rejected.", "operationId": "direct_debit.rejected" } }, "direct_debit.returned": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Payout has failed. You can retry or cancel it.", "operationId": "direct_debit.returned" } }, "direct_debit.settled": { "post": { "tags": [ "Core Resources > Direct Debits" ], "description": "Direct debit payout has been debited from your Wallet balance.", "operationId": "direct_debit.settled" } }, "global_account.active": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA is not immediately created after the API call, asynchronous webhooks concerning successful creation are sent.", "operationId": "global_account.active" } }, "global_account.alias.active": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias registration is completed, webhooks are triggered.", "operationId": "global_account.alias.active" } }, "global_account.alias.cancelled": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias is cancelled, webhooks are triggered.", "operationId": "global_account.alias.cancelled" } }, "global_account.alias.failed": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias registration is failed, webhooks are triggered.", "operationId": "global_account.alias.failed" } }, "global_account.alias.ported": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias is ported, webhooks are triggered.", "operationId": "global_account.alias.ported" } }, "global_account.alias.requires_action": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias requires action, webhooks are triggered.", "operationId": "global_account.alias.requires_action" } }, "global_account.alias.suspended": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA alias is suspended, webhooks are triggered.", "operationId": "global_account.alias.suspended" } }, "global_account.closed": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When customers or the Ops team close a GA for any closure reasons, webhooks are triggered.", "operationId": "global_account.closed" } }, "global_account.failed": { "post": { "tags": [ "Core Resources > Global Accounts" ], "description": "When the GA is not immediately created, and is failed asynchronously, webhooks are triggered.", "operationId": "global_account.failed" } }, "linked_account.failed": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "description": "A linked account is in FAILED status.", "operationId": "linked_account.failed" } }, "linked_account.processing": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "description": "A linked account is in PROCESSING status.", "operationId": "linked_account.processing" } }, "linked_account.requires_action": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "description": "A linked account is in REQUIRES_ACTION status.", "operationId": "linked_account.requires_action" } }, "linked_account.succeeded": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "description": "A linked account is in SUCCEEDED status.", "operationId": "linked_account.succeeded" } }, "linked_account.suspended": { "post": { "tags": [ "Core Resources > Linked Accounts" ], "description": "A linked account is in SUSPENDED status.", "operationId": "linked_account.suspended" } }, "issuing.card_transaction_event.enriched": { "post": { "tags": [ "Issuing > Card Transaction Events" ], "description": "A card transaction event has been enriched.", "operationId": "issuing.card_transaction_event.enriched" } }, "issuing.card_transaction_event.failed": { "post": { "tags": [ "Issuing > Card Transaction Events" ], "description": "A card transaction event has failed.", "operationId": "issuing.card_transaction_event.failed" } }, "issuing.card_transaction_event.success": { "post": { "tags": [ "Issuing > Card Transaction Events" ], "description": "A card transaction event has succeeded.", "operationId": "issuing.card_transaction_event.success" } }, "issuing.card_transaction_lifecycle.created": { "post": { "tags": [ "Issuing > Card Transaction Lifecycles" ], "description": "A card transaction lifecycle has been created.", "operationId": "issuing.card_transaction_lifecycle.created" } }, "issuing.card_transaction_lifecycle.modified": { "post": { "tags": [ "Issuing > Card Transaction Lifecycles" ], "description": "A card transaction lifecycle has been modified.", "operationId": "issuing.card_transaction_lifecycle.modified" } }, "issuing.card_transaction.authorized": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been authorized.", "operationId": "issuing.card_transaction.authorized" } }, "issuing.card_transaction.cleared": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been cleared.", "operationId": "issuing.card_transaction.cleared" } }, "issuing.card_transaction.declined": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been declined.", "operationId": "issuing.card_transaction.declined" } }, "issuing.card_transaction.expired": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has expired.", "operationId": "issuing.card_transaction.expired" } }, "issuing.card_transaction.modified": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been modified.", "operationId": "issuing.card_transaction.modified" } }, "issuing.card_transaction.reversed": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been reversed.", "operationId": "issuing.card_transaction.reversed" } }, "issuing.card_transaction.verified": { "post": { "tags": [ "Issuing > Card Transactions" ], "description": "A card transaction has been verified.", "operationId": "issuing.card_transaction.verified" } }, "issuing.cardholder.deleted": { "post": { "tags": [ "Issuing > Cardholders" ], "description": "Cardholder has been deleted.", "operationId": "issuing.cardholder.deleted" } }, "issuing.cardholder.disabled": { "post": { "tags": [ "Issuing > Cardholders" ], "description": "Cardholder KYC rejected/failed.", "operationId": "issuing.cardholder.disabled" } }, "issuing.cardholder.incomplete": { "post": { "tags": [ "Issuing > Cardholders" ], "description": "Cardholder pending information for submitting KYC.", "operationId": "issuing.cardholder.incomplete" } }, "issuing.cardholder.pending": { "post": { "tags": [ "Issuing > Cardholders" ], "description": "Cardholder has been created and pending kyc review or admin approval.", "operationId": "issuing.cardholder.pending" } }, "issuing.cardholder.ready": { "post": { "tags": [ "Issuing > Cardholders" ], "description": "Cardholder KYC passed and is ready to create cards.", "operationId": "issuing.cardholder.ready" } }, "issuing.3ds_notification.stepup_otp": { "post": { "tags": [ "Issuing > Cards" ], "description": "A transaction requiring 3DS OTP has occurred.", "operationId": "issuing.3ds_notification.stepup_otp" } }, "issuing.card.active": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card is active.", "operationId": "issuing.card.active" } }, "issuing.card.blocked": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card Blocked.", "operationId": "issuing.card.blocked" } }, "issuing.card.closed": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card Closed.", "operationId": "issuing.card.closed" } }, "issuing.card.expired": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card Expired.", "operationId": "issuing.card.expired" } }, "issuing.card.failed": { "post": { "tags": [ "Issuing > Cards" ], "description": "Failed to create card.", "operationId": "issuing.card.failed" } }, "issuing.card.inactive": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card Inactive.", "operationId": "issuing.card.inactive" } }, "issuing.card.lost": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card Lost.", "operationId": "issuing.card.lost" } }, "issuing.card.low_remaining_transaction_limit": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card low remaining transaction limit.", "operationId": "issuing.card.low_remaining_transaction_limit" } }, "issuing.card.modified": { "post": { "tags": [ "Issuing > Cards" ], "description": "The card has been modified.", "operationId": "issuing.card.modified" } }, "issuing.card.pending": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card is pending creation.", "operationId": "issuing.card.pending" } }, "issuing.card.stolen": { "post": { "tags": [ "Issuing > Cards" ], "description": "Card stolen.", "operationId": "issuing.card.stolen" } }, "issuing.card_notification.created": { "post": { "tags": [ "Issuing > Cards" ], "description": "A card has been created.", "operationId": "issuing.card_notification.created" } }, "issuing.card_notification.physical_activated": { "post": { "tags": [ "Issuing > Cards" ], "description": "A physical card has been activated.", "operationId": "issuing.card_notification.physical_activated" } }, "issuing.digital_wallet_notification.abandoned_provisioning": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet token has been abandoned during setup.", "operationId": "issuing.digital_wallet_notification.abandoned_provisioning" } }, "issuing.digital_wallet_notification.payment_reminder": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet token has not been used for an extended period.", "operationId": "issuing.digital_wallet_notification.payment_reminder" } }, "issuing.digital_wallet_notification.token_activated": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet token has been activated.", "operationId": "issuing.digital_wallet_notification.token_activated" } }, "issuing.digital_wallet_notification.token_activated_sms": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet token has been activated (SMS for EMEA).", "operationId": "issuing.digital_wallet_notification.token_activated_sms" } }, "issuing.digital_wallet_notification.token_provisioning_otp": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet token provisioning OTP request has occurred.", "operationId": "issuing.digital_wallet_notification.token_provisioning_otp" } }, "issuing.digital_wallet_notification.wallet_available": { "post": { "tags": [ "Issuing > Cards" ], "description": "A digital wallet has become available for a card.", "operationId": "issuing.digital_wallet_notification.wallet_available" } }, "issuing.reissue.succeeded": { "post": { "tags": [ "Issuing > Cards" ], "description": "A single card has been renewed successfully.", "operationId": "issuing.reissue.succeeded" } }, "issuing.digital_wallet_token.created": { "post": { "tags": [ "Issuing > Digital Wallet Tokens" ], "description": "A digital wallet token has been created.", "operationId": "issuing.digital_wallet_token.created" } }, "issuing.digital_wallet_token.provision_attempted": { "post": { "tags": [ "Issuing > Digital Wallet Tokens" ], "description": "A digital wallet token provisioning attempt occured.", "operationId": "issuing.digital_wallet_token.provision_attempted" } }, "issuing.digital_wallet_token.updated": { "post": { "tags": [ "Issuing > Digital Wallet Tokens" ], "description": "A digital wallet token has been updated.", "operationId": "issuing.digital_wallet_token.updated" } }, "issuing.transaction_dispute.accepted": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been submitted to VISA.", "operationId": "issuing.transaction_dispute.accepted" } }, "issuing.transaction_dispute.cancelled": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been cancelled.", "operationId": "issuing.transaction_dispute.cancelled" } }, "issuing.transaction_dispute.created": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute draft has been created successfully.", "operationId": "issuing.transaction_dispute.created" } }, "issuing.transaction_dispute.expired": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute draft has been expired.", "operationId": "issuing.transaction_dispute.expired" } }, "issuing.transaction_dispute.lost": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been lost.", "operationId": "issuing.transaction_dispute.lost" } }, "issuing.transaction_dispute.modified": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been updated.", "operationId": "issuing.transaction_dispute.modified" } }, "issuing.transaction_dispute.rejected": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been rejected.", "operationId": "issuing.transaction_dispute.rejected" } }, "issuing.transaction_dispute.submitted": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute draft has been submitted successfully.", "operationId": "issuing.transaction_dispute.submitted" } }, "issuing.transaction_dispute.won": { "post": { "tags": [ "Issuing > Transaction Disputes" ], "description": "A dispute has been won.", "operationId": "issuing.transaction_dispute.won" } }, "reserve_plan.requires_action": { "post": { "tags": [ "Payment Acceptance > Config" ], "description": "there is new reserve plan waiting customer accept.", "operationId": "reserve_plan.requires_action" } }, "reserve_plan.updated": { "post": { "tags": [ "Payment Acceptance > Config" ], "description": "reserve plan is updated.", "operationId": "reserve_plan.updated" } }, "customer_balance_transaction.applied_to_payment": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "Bank transfer funds have been applied to a payment.", "operationId": "customer_balance_transaction.applied_to_payment" } }, "customer_balance_transaction.bank_transfer.failed": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "Received bank transfer funds were rejected by Transaction Monitoring or the bank.", "operationId": "customer_balance_transaction.bank_transfer.failed" } }, "customer_balance_transaction.bank_transfer.pending_review": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "Received bank transfer funds are being reviewed by Transaction Monitoring.", "operationId": "customer_balance_transaction.bank_transfer.pending_review" } }, "customer_balance_transaction.bank_transfer.received": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "Bank transfer funds have been received.", "operationId": "customer_balance_transaction.bank_transfer.received" } }, "customer_balance_transaction.bank_transfer.succeeded": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "Received bank transfer funds have been accepted by Transaction Monitoring.", "operationId": "customer_balance_transaction.bank_transfer.succeeded" } }, "customer_balance_transaction.bank_transfer_reversal.created": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "A bank transfer reversal has been created.", "operationId": "customer_balance_transaction.bank_transfer_reversal.created" } }, "customer_balance_transaction.bank_transfer_reversal.failed": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "A bank transfer reversal was rejected by Transaction Monitoring or the bank.", "operationId": "customer_balance_transaction.bank_transfer_reversal.failed" } }, "customer_balance_transaction.bank_transfer_reversal.pending_review": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "A bank transfer reversal is being reviewed by Transaction Monitoring.", "operationId": "customer_balance_transaction.bank_transfer_reversal.pending_review" } }, "customer_balance_transaction.bank_transfer_reversal.succeeded": { "post": { "tags": [ "Payment Acceptance > Customer Balance Transactions" ], "description": "A bank transfer reversal has succeeded.", "operationId": "customer_balance_transaction.bank_transfer_reversal.succeeded" } }, "customer.created": { "post": { "tags": [ "Payment Acceptance > Customers" ], "description": "A customer has been created.", "operationId": "customer.created" } }, "customer.updated": { "post": { "tags": [ "Payment Acceptance > Customers" ], "description": "A customer has been updated.", "operationId": "customer.updated" } }, "funds_split.created": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "description": "A funds split has been created.", "operationId": "funds_split.created" } }, "funds_split.failed": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "description": "A funds split has failed.", "operationId": "funds_split.failed" } }, "funds_split.released": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "description": "A funds split has been released.", "operationId": "funds_split.released" } }, "funds_split.settled": { "post": { "tags": [ "Payment Acceptance > Funds Splits" ], "description": "A funds split has been settled.", "operationId": "funds_split.settled" } }, "payment_attempt.authentication_failed": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has failed authentication.", "operationId": "payment_attempt.authentication_failed" } }, "payment_attempt.authentication_redirected": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been redirected for authentication.", "operationId": "payment_attempt.authentication_redirected" } }, "payment_attempt.authorization_failed": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has failed authorization.", "operationId": "payment_attempt.authorization_failed" } }, "payment_attempt.authorized": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been authorized.", "operationId": "payment_attempt.authorized" } }, "payment_attempt.cancelled": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been cancelled.", "operationId": "payment_attempt.cancelled" } }, "payment_attempt.capture_failed": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has failed to be captured.", "operationId": "payment_attempt.capture_failed" } }, "payment_attempt.capture_requested": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has had a capture requested.", "operationId": "payment_attempt.capture_requested" } }, "payment_attempt.expired": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has expired.", "operationId": "payment_attempt.expired" } }, "payment_attempt.failed_to_process": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has failed to process.", "operationId": "payment_attempt.failed_to_process" } }, "payment_attempt.paid": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been paid.", "operationId": "payment_attempt.paid" } }, "payment_attempt.pending_authorization": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has become pending authorization.", "operationId": "payment_attempt.pending_authorization" } }, "payment_attempt.received": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been received.", "operationId": "payment_attempt.received" } }, "payment_attempt.risk_declined": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been declined by risk controls.", "operationId": "payment_attempt.risk_declined" } }, "payment_attempt.settled": { "post": { "tags": [ "Payment Acceptance > Payment Attempts" ], "description": "A payment attempt has been settled.", "operationId": "payment_attempt.settled" } }, "payment_consent.created": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has been created.", "operationId": "payment_consent.created" } }, "payment_consent.disabled": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has been disabled.", "operationId": "payment_consent.disabled" } }, "payment_consent.paused": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has been paused.", "operationId": "payment_consent.paused" } }, "payment_consent.pending": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has become pending.", "operationId": "payment_consent.pending" } }, "payment_consent.requires_customer_action": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has required customer action.", "operationId": "payment_consent.requires_customer_action" } }, "payment_consent.requires_payment_method": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has required a payment method.", "operationId": "payment_consent.requires_payment_method" } }, "payment_consent.updated": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has been updated.", "operationId": "payment_consent.updated" } }, "payment_consent.verification_failed": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has failed verification.", "operationId": "payment_consent.verification_failed" } }, "payment_consent.verified": { "post": { "tags": [ "Payment Acceptance > Payment Consents" ], "description": "A payment consent has been verified.", "operationId": "payment_consent.verified" } }, "payment_dispute.accepted": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has been accepted.", "operationId": "payment_dispute.accepted" } }, "payment_dispute.challenged": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has been challenged.", "operationId": "payment_dispute.challenged" } }, "payment_dispute.expired": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has expired.", "operationId": "payment_dispute.expired" } }, "payment_dispute.lost": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has been lost.", "operationId": "payment_dispute.lost" } }, "payment_dispute.pending_closure": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has become pending closure.", "operationId": "payment_dispute.pending_closure" } }, "payment_dispute.pending_decision": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has become pending a decision.", "operationId": "payment_dispute.pending_decision" } }, "payment_dispute.requires_response": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has required a response.", "operationId": "payment_dispute.requires_response" } }, "payment_dispute.reversed": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has been reversed.", "operationId": "payment_dispute.reversed" } }, "payment_dispute.won": { "post": { "tags": [ "Payment Acceptance > Payment Disputes" ], "description": "A payment dispute has been won.", "operationId": "payment_dispute.won" } }, "payment_intent.cancelled": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has been cancelled.", "operationId": "payment_intent.cancelled" } }, "payment_intent.created": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has been created.", "operationId": "payment_intent.created" } }, "payment_intent.payment_failed": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment failed for a payment intent.", "operationId": "payment_intent.payment_failed" } }, "payment_intent.pending": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has become pending.", "operationId": "payment_intent.pending" } }, "payment_intent.pending_review": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has become pending review.", "operationId": "payment_intent.pending_review" } }, "payment_intent.requires_capture": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent requires capture.", "operationId": "payment_intent.requires_capture" } }, "payment_intent.requires_customer_action": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent requires customer action.", "operationId": "payment_intent.requires_customer_action" } }, "payment_intent.requires_payment_method": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent requires a payment method.", "operationId": "payment_intent.requires_payment_method" } }, "payment_intent.succeeded": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has succeeded.", "operationId": "payment_intent.succeeded" } }, "payment_intent.updated": { "post": { "tags": [ "Payment Acceptance > Payment Intents" ], "description": "A payment intent has been updated.", "operationId": "payment_intent.updated" } }, "payment_link.created": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "description": "A payment link has been created.", "operationId": "payment_link.created" } }, "payment_link.paid": { "post": { "tags": [ "Payment Acceptance > Payment Links" ], "description": "A payment link has been paid.", "operationId": "payment_link.paid" } }, "payment_method.attached": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "description": "A payment method has been attached.", "operationId": "payment_method.attached" } }, "payment_method.created": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "description": "A payment method has been created.", "operationId": "payment_method.created" } }, "payment_method.detached": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "description": "A payment method has been detached.", "operationId": "payment_method.detached" } }, "payment_method.disabled": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "description": "A payment method has been disabled.", "operationId": "payment_method.disabled" } }, "payment_method.updated": { "post": { "tags": [ "Payment Acceptance > Payment Methods" ], "description": "A payment method has been updated.", "operationId": "payment_method.updated" } }, "refund.accepted": { "post": { "tags": [ "Payment Acceptance > Refunds" ], "description": "A refund has been accepted.", "operationId": "refund.accepted" } }, "refund.failed": { "post": { "tags": [ "Payment Acceptance > Refunds" ], "description": "A refund has failed.", "operationId": "refund.failed" } }, "refund.received": { "post": { "tags": [ "Payment Acceptance > Refunds" ], "description": "A refund has been received.", "operationId": "refund.received" } }, "refund.settled": { "post": { "tags": [ "Payment Acceptance > Refunds" ], "description": "A refund has been settled.", "operationId": "refund.settled" } }, "pos.terminal.activated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When a POS terminal is activated for one account.", "operationId": "pos.terminal.activated" } }, "pos.terminal.admin_password_status.activated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When admin password of a POS terminal is set for one account.", "operationId": "pos.terminal.admin_password_status.activated" } }, "pos.terminal.admin_password_status.locked": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When admin password of a POS terminal is locked for one account.", "operationId": "pos.terminal.admin_password_status.locked" } }, "pos.terminal.admin_password_status.reset_requested": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When admin password of a POS terminal is requested to reset for one account.", "operationId": "pos.terminal.admin_password_status.reset_requested" } }, "pos.terminal.deactivated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When a POS terminal is deactivated for one account.", "operationId": "pos.terminal.deactivated" } }, "pos.terminal.refund_password_status.activated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When refund password of a POS terminal is set for one account.", "operationId": "pos.terminal.refund_password_status.activated" } }, "pos.terminal.refund_password_status.locked": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When refund password of a POS terminal is locked for one account.", "operationId": "pos.terminal.refund_password_status.locked" } }, "pos.terminal.refund_password_status.opted_out": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When refund password of a POS terminal is opted out for one account.", "operationId": "pos.terminal.refund_password_status.opted_out" } }, "pos.terminal.refund_password_status.reset_requested": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When refund password of a POS terminal is requested to reset for one account.", "operationId": "pos.terminal.refund_password_status.reset_requested" } }, "pos.terminal.terminated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When a POS terminal is terminated for one account.", "operationId": "pos.terminal.terminated" } }, "pos.terminal.updated": { "post": { "tags": [ "Payment Acceptance > Terminals" ], "description": "When a POS terminal's information is updated for one account.", "operationId": "pos.terminal.updated" } }, "payout.batch_transfers.approval_blocked": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in approval_blocked status.", "operationId": "payout.batch_transfers.approval_blocked" } }, "payout.batch_transfers.approval_recalled": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in approval_recalled status.", "operationId": "payout.batch_transfers.approval_recalled" } }, "payout.batch_transfers.approval_rejected": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in approval_rejected status.", "operationId": "payout.batch_transfers.approval_rejected" } }, "payout.batch_transfers.booked": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in booked status.", "operationId": "payout.batch_transfers.booked" } }, "payout.batch_transfers.booking": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in booking status.", "operationId": "payout.batch_transfers.booking" } }, "payout.batch_transfers.cancellation_requested": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in cancellation_requested status.", "operationId": "payout.batch_transfers.cancellation_requested" } }, "payout.batch_transfers.cancelled": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in cancelled status.", "operationId": "payout.batch_transfers.cancelled" } }, "payout.batch_transfers.drafting": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in drafting status.", "operationId": "payout.batch_transfers.drafting" } }, "payout.batch_transfers.failed": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in failed status.", "operationId": "payout.batch_transfers.failed" } }, "payout.batch_transfers.funding.cancelled": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in cancelled status.", "operationId": "payout.batch_transfers.funding.cancelled" } }, "payout.batch_transfers.funding.failed": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in failed status.", "operationId": "payout.batch_transfers.funding.failed" } }, "payout.batch_transfers.funding.funded": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in funded status.", "operationId": "payout.batch_transfers.funding.funded" } }, "payout.batch_transfers.funding.processing": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in processing status.", "operationId": "payout.batch_transfers.funding.processing" } }, "payout.batch_transfers.funding.requires_funding_confirmation": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in requires_funding_confirmation status.", "operationId": "payout.batch_transfers.funding.requires_funding_confirmation" } }, "payout.batch_transfers.funding.reversed": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in reversed status.", "operationId": "payout.batch_transfers.funding.reversed" } }, "payout.batch_transfers.funding.scheduled": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer funding is in scheduled status.", "operationId": "payout.batch_transfers.funding.scheduled" } }, "payout.batch_transfers.in_approval": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in in_approval status.", "operationId": "payout.batch_transfers.in_approval" } }, "payout.batch_transfers.overdue": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in overdue status.", "operationId": "payout.batch_transfers.overdue" } }, "payout.batch_transfers.partially_booked": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in partially_booked status.", "operationId": "payout.batch_transfers.partially_booked" } }, "payout.batch_transfers.scheduled": { "post": { "tags": [ "Payouts > Batch Transfers" ], "description": "batch transfer is in scheduled status.", "operationId": "payout.batch_transfers.scheduled" } }, "payment.bank.statements.file": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Payment bank statement file is ready.", "operationId": "payment.bank.statements.file" } }, "payout.transfer.approval_blocked": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer approval flow is blocked.", "operationId": "payout.transfer.approval_blocked" } }, "payout.transfer.approval_recalled": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer has been recalled.", "operationId": "payout.transfer.approval_recalled" } }, "payout.transfer.approval_rejected": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer has been rejected.", "operationId": "payout.transfer.approval_rejected" } }, "payout.transfer.cancellation_requested": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Cancellation requested and waiting for the settlement of conversion.", "operationId": "payout.transfer.cancellation_requested" } }, "payout.transfer.cancelled": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer has been cancelled as requested. Funds have been returned to your wallet.", "operationId": "payout.transfer.cancelled" } }, "payout.transfer.failed": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer has failed. You can retry or cancel it.", "operationId": "payout.transfer.failed" } }, "payout.transfer.funding.cancelled": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding has been cancelled.", "operationId": "payout.transfer.funding.cancelled" } }, "payout.transfer.funding.failed": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding has failed.", "operationId": "payout.transfer.funding.failed" } }, "payout.transfer.funding.funded": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding has completed.", "operationId": "payout.transfer.funding.funded" } }, "payout.transfer.funding.processing": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding is being processed.", "operationId": "payout.transfer.funding.processing" } }, "payout.transfer.funding.requires_funding_confirmation": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding will not be triggered at transfer date. (for on-demand funding customers only).", "operationId": "payout.transfer.funding.requires_funding_confirmation" } }, "payout.transfer.funding.reversed": { "post": { "tags": [ "Payouts > Transfers" ], "description": "The funds have been clawed back.", "operationId": "payout.transfer.funding.reversed" } }, "payout.transfer.funding.scheduled": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Funding will be triggered at the transfer date.", "operationId": "payout.transfer.funding.scheduled" } }, "payout.transfer.in_approval": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer is in approval.", "operationId": "payout.transfer.in_approval" } }, "payout.transfer.overdue": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer is not funded beyond the payment date.", "operationId": "payout.transfer.overdue" } }, "payout.transfer.paid": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer has been accepted by the banking partner.", "operationId": "payout.transfer.paid" } }, "payout.transfer.processing": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer is funded and starts to process.", "operationId": "payout.transfer.processing" } }, "payout.transfer.scheduled": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer is submitted/approved and waiting for the transfer date arrives.", "operationId": "payout.transfer.scheduled" } }, "payout.transfer.sent": { "post": { "tags": [ "Payouts > Transfers" ], "description": "Transfer is sent by Airwallex.", "operationId": "payout.transfer.sent" } }, "rfi.action_required": { "post": { "tags": [ "Risk > Request for Information (RFI)" ], "description": "new RFI raised and waiting customer respond.", "operationId": "rfi.action_required" } }, "rfi.answered": { "post": { "tags": [ "Risk > Request for Information (RFI)" ], "description": "customer has answered RFI.", "operationId": "rfi.answered" } }, "rfi.closed": { "post": { "tags": [ "Risk > Request for Information (RFI)" ], "description": "RFI session is closed.", "operationId": "rfi.closed" } }, "risk.risk_reports.completed": { "post": { "tags": [ "Risk > Risk Reports" ], "description": "When an async risk report has been generated successfully.", "operationId": "risk.risk_reports.completed" } }, "risk.risk_reports.failed": { "post": { "tags": [ "Risk > Risk Reports" ], "description": "When async risk report generation has failed.", "operationId": "risk.risk_reports.failed" } }, "seller.active": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller became active.", "operationId": "seller.active" } }, "seller.in_review": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller in review.", "operationId": "seller.in_review" } }, "seller.inactive": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller became inactive.", "operationId": "seller.inactive" } }, "seller.pending_deactivation": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller pending deactivation.", "operationId": "seller.pending_deactivation" } }, "seller.rejected": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller rejected.", "operationId": "seller.rejected" } }, "seller.suspended": { "post": { "tags": [ "Risk > Sellers" ], "description": "Seller suspended.", "operationId": "seller.suspended" } }, "account.action_required": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account requires further action for kyc.", "operationId": "account.action_required" } }, "account.active": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account becomes active.", "operationId": "account.active" } }, "account.closed": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account is closed.", "operationId": "account.closed" } }, "account.connected": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account gets connected to platform account.", "operationId": "account.connected" } }, "account.dormant": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account becomes dormant.", "operationId": "account.dormant" } }, "account.submitted": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account gets submitted for KYC.", "operationId": "account.submitted" } }, "account.suspended": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account got suspended.", "operationId": "account.suspended" } }, "account_amendment.approved": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account amendment approved.", "operationId": "account_amendment.approved" } }, "account_amendment.pending": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account amendment created and reviewing by KYC.", "operationId": "account_amendment.pending" } }, "account_amendment.rejected": { "post": { "tags": [ "Embedded Finance > Accounts" ], "description": "Account amendment rejected.", "operationId": "account_amendment.rejected" } }, "charge.failed": { "post": { "tags": [ "Embedded Finance > Charges" ], "description": "Charge transaction has failed.", "operationId": "charge.failed" } }, "charge.new": { "post": { "tags": [ "Embedded Finance > Charges" ], "description": "Charge transaction created successfully.", "operationId": "charge.new" } }, "charge.pending": { "post": { "tags": [ "Embedded Finance > Charges" ], "description": "Charge transaction in progress.", "operationId": "charge.pending" } }, "charge.settled": { "post": { "tags": [ "Embedded Finance > Charges" ], "description": "Funds have been settled in the wallet.", "operationId": "charge.settled" } }, "charge.suspended": { "post": { "tags": [ "Embedded Finance > Charges" ], "description": "Charge transaction suspended.", "operationId": "charge.suspended" } }, "connected_account_transfer.failed": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "description": "Transfer transaction has failed.", "operationId": "connected_account_transfer.failed" } }, "connected_account_transfer.new": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "description": "Transfer transaction created successfully.", "operationId": "connected_account_transfer.new" } }, "connected_account_transfer.pending": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "description": "Transfer transaction in progress.", "operationId": "connected_account_transfer.pending" } }, "connected_account_transfer.settled": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "description": "Funds settled to the recipient wallet.", "operationId": "connected_account_transfer.settled" } }, "connected_account_transfer.suspended": { "post": { "tags": [ "Embedded Finance > Connected Account Transfers" ], "description": "Transfer transaction suspended.", "operationId": "connected_account_transfer.suspended" } }, "account.offboarding.cancelled": { "post": { "tags": [ "Embedded Finance > Offboardings" ], "description": "When an account offboarding case has been cancelled.", "operationId": "account.offboarding.cancelled" } }, "account.offboarding.completed": { "post": { "tags": [ "Embedded Finance > Offboardings" ], "description": "When an account offboarding case has been completed successfully.", "operationId": "account.offboarding.completed" } }, "account.offboarding.pending": { "post": { "tags": [ "Embedded Finance > Offboardings" ], "description": "When an account offboarding case is created and pending processing.", "operationId": "account.offboarding.pending" } }, "platform_liquidity_program.low_balance": { "post": { "tags": [ "Embedded Finance > Platform Liquidity Programs" ], "description": "Platform liquidity program balance is low.", "operationId": "platform_liquidity_program.low_balance" } }, "platform_report.completed": { "post": { "tags": [ "Embedded Finance > Platform Reports" ], "description": "Platform report is ready for downloading.", "operationId": "platform_report.completed" } }, "platform_report.failed": { "post": { "tags": [ "Embedded Finance > Platform Reports" ], "description": "Failed to generate the platform report.", "operationId": "platform_report.failed" } }, "psp_settlement_deposit.action_required": { "post": { "tags": [ "Embedded Finance > PSP Settlement Deposits" ], "description": "PSP settlement deposit does not correspond to any PSP settlement intent.", "operationId": "psp_settlement_deposit.action_required" } }, "psp_settlement_deposit.matched": { "post": { "tags": [ "Embedded Finance > PSP Settlement Deposits" ], "description": "PSP settlement deposits match the corresponding PSP settlement intent.", "operationId": "psp_settlement_deposit.matched" } }, "psp_settlement_deposit.new": { "post": { "tags": [ "Embedded Finance > PSP Settlement Deposits" ], "description": "Funds have been deposited into a holding account.", "operationId": "psp_settlement_deposit.new" } }, "psp_settlement_deposit.settled": { "post": { "tags": [ "Embedded Finance > PSP Settlement Deposits" ], "description": "All the PSP settlement splits associated with this PSP settlement deposit have been settled.", "operationId": "psp_settlement_deposit.settled" } }, "psp_settlement_intent.action_required": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "PSP settlement intent does not match the settlement deposits.", "operationId": "psp_settlement_intent.action_required" } }, "psp_settlement_intent.cancelled": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "PSP settlement intent cancelled successfully.", "operationId": "psp_settlement_intent.cancelled" } }, "psp_settlement_intent.matched": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "PSP settlement intent matches the corresponding settlement deposits.", "operationId": "psp_settlement_intent.matched" } }, "psp_settlement_intent.new": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "PSP settlement intent created successfully.", "operationId": "psp_settlement_intent.new" } }, "psp_settlement_intent.settled": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "All the PSP settlement splits in the PSP settlement intent have been settled.", "operationId": "psp_settlement_intent.settled" } }, "psp_settlement_intent.submitted": { "post": { "tags": [ "Embedded Finance > PSP Settlement Intents" ], "description": "PSP settlement intent is submitted successfully.", "operationId": "psp_settlement_intent.submitted" } }, "psp_settlement_split.cancelled": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split is cancelled successfully.", "operationId": "psp_settlement_split.cancelled" } }, "psp_settlement_split.create_failed": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split could not be created.", "operationId": "psp_settlement_split.create_failed" } }, "psp_settlement_split.failed": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split release fails transfer to target account.", "operationId": "psp_settlement_split.failed" } }, "psp_settlement_split.matched": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split is part of a PSP settlement intent that has the same amount as its corresponding PSP deposits.", "operationId": "psp_settlement_split.matched" } }, "psp_settlement_split.new": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split created successfully.", "operationId": "psp_settlement_split.new" } }, "psp_settlement_split.pending": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split is successfully queued for transfer to target account.", "operationId": "psp_settlement_split.pending" } }, "psp_settlement_split.settled": { "post": { "tags": [ "Embedded Finance > PSP Settlement Splits" ], "description": "PSP settlement split release succeeds transfer to target account.", "operationId": "psp_settlement_split.settled" } }, "spend.bill.awaiting_approval": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is awaiting approval.", "operationId": "spend.bill.awaiting_approval" } }, "spend.bill.awaiting_payment": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is awaiting payment.", "operationId": "spend.bill.awaiting_payment" } }, "spend.bill.deleted": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is deleted.", "operationId": "spend.bill.deleted" } }, "spend.bill.paid": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is paid.", "operationId": "spend.bill.paid" } }, "spend.bill.payment_in_progress": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill payment is in progress.", "operationId": "spend.bill.payment_in_progress" } }, "spend.bill.rejected": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is rejected.", "operationId": "spend.bill.rejected" } }, "spend.bill.scheduled": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is scheduled for payment.", "operationId": "spend.bill.scheduled" } }, "spend.bill.updated": { "post": { "tags": [ "Spend > Bills" ], "description": "When a bill is edited.", "operationId": "spend.bill.updated" } }, "spend.expense.approved": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense is approved.", "operationId": "spend.expense.approved" } }, "spend.expense.archived": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense is archived.", "operationId": "spend.expense.archived" } }, "spend.expense.awaiting_approval": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense is awaiting approval.", "operationId": "spend.expense.awaiting_approval" } }, "spend.expense.deleted": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense is deleted.", "operationId": "spend.expense.deleted" } }, "spend.expense.draft": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense draft is created or recalled.", "operationId": "spend.expense.draft" } }, "spend.expense.rejected": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense is rejected.", "operationId": "spend.expense.rejected" } }, "spend.expense.updated": { "post": { "tags": [ "Spend > Expenses" ], "description": "When an expense transaction is edited or transaction status is changed.", "operationId": "spend.expense.updated" } }, "spend.reimbursement_report.awaiting_approval": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is awaiting approval.", "operationId": "spend.reimbursement_report.awaiting_approval" } }, "spend.reimbursement_report.awaiting_payment": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is awaiting payment.", "operationId": "spend.reimbursement_report.awaiting_payment" } }, "spend.reimbursement_report.deleted": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is deleted.", "operationId": "spend.reimbursement_report.deleted" } }, "spend.reimbursement_report.draft": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report draft is created or recalled.", "operationId": "spend.reimbursement_report.draft" } }, "spend.reimbursement_report.mark_as_paid": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is marked as paid.", "operationId": "spend.reimbursement_report.mark_as_paid" } }, "spend.reimbursement_report.paid": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is paid.", "operationId": "spend.reimbursement_report.paid" } }, "spend.reimbursement_report.payment_in_progress": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report payment is in progress.", "operationId": "spend.reimbursement_report.payment_in_progress" } }, "spend.reimbursement_report.rejected": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is rejected.", "operationId": "spend.reimbursement_report.rejected" } }, "spend.reimbursement_report.updated": { "post": { "tags": [ "Spend > Reimbursements" ], "description": "When a reimbursement report is edited or comment is added.", "operationId": "spend.reimbursement_report.updated" } }, "conversion.cancelled": { "post": { "tags": [ "Transactional FX > Conversion" ], "description": "Conversion cancelled.", "operationId": "conversion.cancelled" } }, "conversion.overdue": { "post": { "tags": [ "Transactional FX > Conversion" ], "description": "Settlement failed, funds are now overdue.", "operationId": "conversion.overdue" } }, "conversion.scheduled": { "post": { "tags": [ "Transactional FX > Conversion" ], "description": "Conversion booked successfully, and settlement scheduled.", "operationId": "conversion.scheduled" } }, "conversion.settled": { "post": { "tags": [ "Transactional FX > Conversion" ], "description": "Funds have been settled in wallet.", "operationId": "conversion.settled" } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "details": { "type": "object" }, "message": { "type": "string" }, "source": { "type": "string" } } }, "Details": { "type": "object", "properties": { "reason_codes": { "type": "array", "description": "Specific codes that indicate the reason a capability is disabled. \nFor more information on the codes related to payment method capabilities, refer to this [page](/docs/payments-for-platforms/connected-accounts/onboard-connected-accounts/kyb-and-onboarding/native-api).", "items": { "type": "string" } }, "mcc": { "type": "string", "description": "The MCC applied by default for this payment method; the first of `mcc_candidates`. Only present for `payments_*` capabilities once an MCC has been assigned." }, "mcc_candidates": { "type": "array", "description": "The approved MCCs for this payment method. The first equals `mcc`; the rest are alternates with no priority order. Only present for `payments_*` capabilities once an MCC has been assigned.", "items": { "type": "string" } } }, "description": "Details of this capability." }, "Response": { "type": "object", "required": [ "comment", "id", "status", "updated_at" ], "properties": { "comment": { "type": "string", "description": "Additional details about the status of this capability." }, "details": { "$ref": "#/components/schemas/Details", "description": "Details of this capability." }, "entity_type": { "type": "string", "description": "The type of entity of your declarant, one of `INDIVIDUAL`, `BUSINESS`." }, "id": { "type": "string", "description": "A unique identifier of the requested capability." }, "status": { "type": "string", "description": "The status of this capability, one of `ENABLED`, `DISABLED`, `PENDING`." }, "updated_at": { "type": "string", "description": "Last time this capability has been updated." } } }, "FundingLimitResult": { "type": "object", "required": [ "currency", "limit", "status", "type" ], "properties": { "availables": { "type": "object", "description": "The remaining limit of direct debit schemas, possible keys are SAME_DAY_ACH, NEXT_DAY_ACH, FEDWIRE, BECS, NPP, BACS, SEPA, FPS, FAST, GIRO, BECS, EFT.", "additionalProperties": { "type": "number" } }, "currency": { "type": "string", "description": "Currency of the limit, it's the applied one, or default as per your owning entity." }, "effective_at": { "type": "string", "description": "the timestamp at which the customer's funding limit becomes effective." }, "limit": { "type": "number", "description": "The upper limit." }, "mandate_type": { "type": "string", "description": "the settlement method or clearing system." }, "requested_limit": { "type": "number", "description": "The under evaluating limit." }, "status": { "type": "string", "description": "Current setting status.", "enum": [ "ACTIVE", "REQUESTED" ] }, "type": { "type": "string", "description": "Deposit type, possible values are DIRECT_DEBIT, FASTER_DIRECT_DEBIT.", "enum": [ "DIRECT_DEBIT_DEPOSIT", "FASTER_DIRECT_DEBIT_DEPOSIT" ] }, "updated_at": { "type": "string", "description": "Last update time." } } }, "AccountingResourceStatus": { "type": "string", "description": "Status of an Accounting resource used in Airwallex Spend.", "enum": [ "ACTIVE", "ARCHIVED" ] }, "AccountingFieldValue": { "type": "object", "required": [ "id", "accounting_field_id", "value", "status", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the accounting field value." }, "accounting_field_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the parent accounting field." }, "value": { "type": "string", "description": "Accounting field value name." }, "value_label": { "type": "string", "description": "Airwallex display name for the accounting field value." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this accounting field value applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" }, "created_at": { "type": "string", "description": "Time at which the accounting field value was created, in ISO 8601 format." }, "updated_at": { "type": "string", "description": "Time at which the accounting field value was last updated, in ISO 8601 format." } }, "description": "Selectable value for a custom accounting field used when coding Airwallex Spend transactions." }, "AccountingFieldValuePagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of accounting field values returned.", "items": { "$ref": "#/components/schemas/AccountingFieldValue" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list used to retrieve the previous page of results." } }, "description": "Paginated list of accounting field values." }, "AccountingFieldName": { "type": "string", "description": "Accounting field name. Must be one of `Custom field 1` through `Custom field 20`, inclusive. Values are case-sensitive.", "enum": [ "Custom field 1", "Custom field 2", "Custom field 3", "Custom field 4", "Custom field 5", "Custom field 6", "Custom field 7", "Custom field 8", "Custom field 9", "Custom field 10", "Custom field 11", "Custom field 12", "Custom field 13", "Custom field 14", "Custom field 15", "Custom field 16", "Custom field 17", "Custom field 18", "Custom field 19", "Custom field 20" ] }, "AccountingField": { "type": "object", "required": [ "id", "name", "status", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the accounting field." }, "name": { "type": "string", "description": "Accounting field name." }, "name_label": { "type": "string", "description": "Airwallex display name for the accounting field." }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" }, "created_at": { "type": "string", "description": "Time at which the accounting field was created, in ISO 8601 format." }, "updated_at": { "type": "string", "description": "Time at which the accounting field was last updated, in ISO 8601 format." } }, "description": "Custom accounting field defining an additional accounting dimension for Airwallex Spend." }, "AccountingFieldPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of accounting fields returned.", "items": { "$ref": "#/components/schemas/AccountingField" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list used to retrieve the previous page of results." } }, "description": "Paginated list of accounting fields." }, "GLAccount": { "type": "object", "required": [ "id", "value", "status", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the general ledger account." }, "code": { "type": "string", "description": "General ledger account code." }, "value": { "type": "string", "description": "General ledger account name." }, "value_label": { "type": "string", "description": "Airwallex display name for the general ledger account." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this general ledger account applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" }, "created_at": { "type": "string", "description": "Time at which the general ledger account was created, in ISO 8601 format." }, "updated_at": { "type": "string", "description": "Time at which the general ledger account was last updated, in ISO 8601 format." } }, "description": "General Ledger (GL) account that can be selected when coding Airwallex Spend transactions." }, "GLAccountPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of general ledger accounts returned.", "items": { "$ref": "#/components/schemas/GLAccount" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list used to retrieve the previous page of results." } }, "description": "Paginated list of General Ledger (GL) accounts." }, "TaxCode": { "type": "object", "required": [ "id", "value", "rate_percent", "status", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the tax code." }, "value": { "type": "string", "description": "Tax code name as defined in the accounting system." }, "rate_percent": { "type": "string", "description": "Tax rate value as a decimal percentage." }, "value_label": { "type": "string", "description": "Airwallex display name for the tax code." }, "external_id": { "type": "string", "description": "External ID from the accounting system." }, "legal_entity_ids": { "type": "array", "description": "Legal entity IDs to which this tax code applies. Omit this field when it applies to all legal entities.", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/AccountingResourceStatus" }, "created_at": { "type": "string", "description": "Time at which the tax code was created, in ISO 8601 format." }, "updated_at": { "type": "string", "description": "Time at which the tax code was last updated, in ISO 8601 format." } }, "description": "Tax code that can be selected when coding Airwallex Spend transactions." }, "TaxCodePagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of tax codes returned.", "items": { "$ref": "#/components/schemas/TaxCode" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list used to retrieve the previous page of results." } }, "description": "Paginated list of tax codes." }, "DropInSDKAuthorizeRes": { "type": "object", "required": [ "authorization_code" ], "properties": { "authorization_code": { "type": "string", "description": "The authorization code generated by Airwallex. It is used to exchange tokens. The authorization code expires in 30 seconds and becomes invalid once an access token is exchanged." } } }, "Token": { "type": "object", "properties": { "expires_at": { "type": "string", "description": "Token expiration time in ISO8601 format." }, "token": { "type": "string", "description": "Authentication token returned." } } }, "BeneficiaryAdditionalInfo": { "type": "object", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } }, "description": "Additional information about the beneficiary." }, "BeneficiaryAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } }, "description": "Beneficiary's address details." }, "BankDetails": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } }, "description": "Beneficiary's bank account details where the payment will be credited." }, "DigitalWallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } }, "description": "Beneficiary's digital wallet details where the payment will be credited." }, "PayerAdditionalInfo": { "type": "object", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } }, "description": "Additional information about the payer." }, "PayerAddress": { "type": "object", "required": [ "country_code" ], "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } }, "description": "Payer's address details." }, "CustomerAddress": { "required": [ "country_code" ], "type": "object", "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "PostCode of the address." }, "state": { "type": "string", "description": "State or province of the address." }, "street": { "type": "string", "description": "Street of the address." } }, "description": "Address of the billing customer." }, "CouponDiscountDataRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "id of the Coupon object." } }, "description": "Coupon to redeem into a discount for this resource. Only required when `type` = `COUPON`." }, "DiscountInstruction": { "required": [ "type" ], "type": "object", "properties": { "coupon": { "$ref": "#/components/schemas/CouponDiscountDataRequest" }, "type": { "type": "string", "description": "Specifies how to obtain the discount. One of: `COUPON`." } } }, "CheckoutLineItem": { "required": [ "discounts" ], "type": "object", "properties": { "discounts": { "type": "array", "description": "List of discounts to be applied to the line items. Discounts of line items are applied before subscription or invoice discounts. Currently, only one element is supported.", "items": { "$ref": "#/components/schemas/DiscountInstruction" }, "maxItems": 1, "minItems": 0 }, "price_id": { "type": "string", "description": "ID of the [Price](/docs/api/billing/prices) object. Mutually exclusive with `rate_card_id`." }, "quantity": { "type": "integer", "description": "The quantity of the line item being purchased.", "format": "int32", "minimum": 1 }, "rate_card_id": { "type": "string", "description": "ID of the [Rate Card](/docs/api/billing/rate_cards) object. Mutually exclusive with `price_id`." }, "rate_card_version": { "type": "integer", "description": "Pinned Rate Card version number. Present when `rate_card_id` is set.", "format": "int32" }, "tax_percent": { "type": "number", "description": "The effective tax percent of this line item.", "maximum": 100, "minimum": 0 } } }, "CheckoutPaymentMethodSave": { "type": "object", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`. \n`ENABLED`: The payment method will be saved for future use. \n`DISABLED`: The payment method will not be saved. \n`COLLECT_CONSENT`: The checkout UI asks the customer whether they want to save the payment method." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`. \nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } }, "description": "Settings for saving this payment method for future use." }, "CheckoutPaymentOptionsResponse": { "type": "object", "properties": { "pay_by_invoice_enabled": { "type": "boolean", "description": "Enables the option to \"Request an invoice\" for payment. After the customer confirms to pay with this option, the status of Billing Checkout will transit to COMPLETED, and an invoice will be generated. The invoice will inherit the payment_options of this Billing Checkout, and other configurations in invoice_data. Only applicable when mode is `PAYMENT`, and the type of the customer is `BUSINESS`." }, "payment_method_save": { "$ref": "#/components/schemas/CheckoutPaymentMethodSave", "description": "Settings for saving this payment method for future use." }, "payment_method_types": { "type": "array", "description": "Specify which payment methods to display on the hosted checkout page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the hosted checkout page. \nPossible enum values when mode is `SUBSCRIPTION`: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`. \nPossible enum values when mode is `PAYMENT`: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`. \nPossible enum values when mode is `SETUP`: `card`.", "items": { "type": "string", "description": "Specify which payment methods to display on the hosted checkout page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the hosted checkout page. \nPossible enum values when mode is `SUBSCRIPTION`: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`. \nPossible enum values when mode is `PAYMENT`: `afterpay`, `airwallex_pay`, `alfamart`, `alipaycn`, `alipayhk`, `applepay`, `atome`, `au_pay`, `axs_kiosk`, `bancontact`, `bigc`,`bitpay`, `bkash`, `blik`, `boost`, `card`, `cash_app_pay`, `dana`, `doku_ewallet`, `dragonpay`, `duit_now`, `d_barai`, `enets`, `eps`, `esun`, `family_mart`, `fps`, `fpx`, `gcash`, `giropay`, `googlepay`, `go_pay`, `grabpay`, `hi_life`, `ideal`, `indomaret`, `jenius_pay`, `kakaopay`, `klarna`, `konbini`, `korean_local_card`, `laybuy`, `line_pay`, `linkaja`, `maxima`, `merpay`, `multibanco`, `mybank`, `narvesen`, `naver_pay`, `online_banking`, `ovo`, `p24`, `paybybankapp`, `payco`, `payeasy`, `payeasy_atm`, `payme`, `paypal`, `paypay`, `paypost`, `paysafecard`, `paysafecash`, `paysera`, `payu`, `pay_now`, `perlas_terminals`, `permatanet`, `permata_atm`, `pix`, `poli`, `prompt_pay`, `rabbit_line_pay`, `rakuten_pay`, `safetypay`, `samsung_pay`, `sam_kiosk`, `satispay`, `seven_eleven`, `shopee_pay`, `skrill`, `sofort`, `spei`, `tesco_lotus`, `tng`, `toss_pay`, `truemoney`, `trustly`, `twint`, `upi`, `venmo`, `verkkopankki`, `wechatpay`, `zip`. \nPossible enum values when mode is `SETUP`: `card`." } } }, "description": "Payment settings of this Billing Checkout." }, "SubscriptionDefaultInvoiceTemplate": { "type": "object", "properties": { "invoice_memo": { "type": "string", "description": "Memo to be used for the invoices that are generated by this Subscription." } }, "description": "Invoices for the Subscription will be created using the specified settings." }, "SubscriptionDuration": { "required": [ "period", "period_unit" ], "type": "object", "properties": { "period": { "type": "integer", "description": "The number of period units.", "format": "int32", "minimum": 1 }, "period_unit": { "type": "string", "description": "Specifies billing duration. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } }, "description": "The total duration of the subscription." }, "SubscriptionRecurring": { "required": [ "period", "period_unit" ], "type": "object", "properties": { "period": { "type": "integer", "description": "The number of period units between subscription billing cycles. For example, the billing cycle is bi-monthly if `period=2` and `period_unit=MONTH`.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } }, "description": "The billing cycle for recurring charges." }, "SubscriptionData": { "required": [ "days_until_due", "recurring" ], "type": "object", "properties": { "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due. Defaults to `0`.", "format": "int32" }, "default_invoice_template": { "$ref": "#/components/schemas/SubscriptionDefaultInvoiceTemplate", "description": "Invoices for the Subscription will be created using the specified settings." }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax rate between 0 and 100(%) to be applied to invoices to be generated. The tax will be exclusive. Defaults to 0." }, "duration": { "$ref": "#/components/schemas/SubscriptionDuration", "description": "The total duration of the subscription." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "recurring": { "$ref": "#/components/schemas/SubscriptionRecurring", "description": "The billing cycle for recurring charges." }, "starts_at": { "type": "string", "description": "Time when the subscription started or scheduled to start. Defaults to start immediately after creation." }, "trial_ends_at": { "type": "string", "description": "The end time of the trial if applicable." } }, "description": "The settings of subscription to be passed to the subscription creation upon completion of the Billing Checkout in `SUBSCRIPTION` mode." }, "Checkout": { "required": [ "automatic_tax_status", "created_at", "discounts", "enable_automatic_tax", "expires_at", "id", "line_items", "linked_payment_account_id", "mode", "status", "ui_mode", "updated_at" ], "type": "object", "properties": { "automatic_tax_status": { "type": "string", "description": "The automatic tax status of this checkout.", "enum": [ "APPLIED", "LOCATION_NOT_SUPPORTED", "LOCATION_NOT_REGISTERED_BY_MERCHANT", "ADDRESS_INCOMPLETE", "DISABLED" ], "x-enumDescriptions": { "APPLIED": "The automatic tax is applied.", "LOCATION_NOT_SUPPORTED": "Automatic tax calculation isn't supported in the customer's location.", "LOCATION_NOT_REGISTERED_BY_MERCHANT": "The merchant isn't registered to collect tax in the customer's location.", "ADDRESS_INCOMPLETE": "The customer address was insufficient or invalid to determine the correct tax.", "DISABLED": "The automatic tax is disabled." } }, "back_url": { "type": "string", "description": "If set, the hosted checkout page displays a back button which allows customers to cancel the flow and be directed to this URL." }, "billing_customer": { "$ref": "#/components/schemas/Billing_BillingCustomerSnapshot", "description": "Snapshot of the [Billing Customer](/docs/api/billing/billing_customers) captured on this Billing Checkout." }, "billing_customer_id": { "type": "string", "description": "ID of the associated billing customer. Billing Checkout will create a new Billing Customer based on information provided during the process, unless an existing billing customer ID was provided when the Billing Checkout was created." }, "cancelled_at": { "type": "string", "description": "Time when the Billing Checkout was cancelled." }, "client_secret": { "type": "string", "description": "The client secret used to initialize the Billing Checkout in `EMBEDDED` or `ELEMENTS` `ui_mode`. Only present when `ui_mode` is `EMBEDDED` or `ELEMENTS`." }, "completed_at": { "type": "string", "description": "Time when the Billing Checkout was completed." }, "created_at": { "type": "string", "description": "Time when the Billing Checkout was created." }, "currency": { "type": "string", "description": "The checkout currency in 3-letter ISO-4217 format." }, "customer_data": { "$ref": "#/components/schemas/Billing_PrefilledCustomerData", "description": "The prefilled information of the customer. Only applicable when `billing_customer_id` is not provided. \nNot applicable in `SETUP` mode." }, "customer_data_collection": { "$ref": "#/components/schemas/Billing_CustomerDataCollection", "description": "Provides configuration for the Billing Checkout to collect information from customers." }, "discounts": { "type": "array", "description": "List of discounts to be applied to the subscription. Discounts of subscription items are applied before subscription discounts. Currently, only one element is supported.", "items": { "$ref": "#/components/schemas/DiscountInstruction" } }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this checkout. When enabled, the system attempts to calculate taxes for this checkout's invoice automatically." }, "expires_at": { "type": "string", "description": "Time when the Billing Checkout expires." }, "hosted_completion_page": { "$ref": "#/components/schemas/Billing_HostedCompletionPage", "description": "Configuration for the Airwallex-hosted completion page. Only applicable when `ui_mode` is `HOSTED`." }, "id": { "type": "string", "description": "ID of the Billing Checkout object." }, "invoice_data": { "$ref": "#/components/schemas/Billing_InvoiceDataResponse", "description": "The settings of invoice to be passed to the invoice creation upon completion of the Billing Checkout in `PAYMENT` mode." }, "invoice_id": { "type": "string", "description": "ID of the invoice for the Billing Checkout in `PAYMENT` mode. Only applicable when the Billing Checkout is in `COMPLETED` status." }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity, which can be retrieved from the `legal_entity_id` field in the [Retrieve account details API](/docs/api/scale/accounts/retrieve) response." }, "line_items": { "type": "array", "description": "A list of items the customer is purchasing.", "items": { "$ref": "#/components/schemas/CheckoutLineItem" } }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section." }, "locale": { "type": "string", "description": "A code, in IETF language format, that determines the language and formatting displayed to customers on the checkout UI, and can be one of: `AUTO`, `EN`, `ZH`. \nIf set to `AUTO` the customer's browser locale is used." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "mode": { "type": "string", "description": "The mode of the Billing Checkout object, can be one of: \n`SUBSCRIPTION`: Set up subscriptions. \n`PAYMENT`: Accept one-off payments.`SETUP`: Collect payment details to charge your customers later." }, "payment_options": { "$ref": "#/components/schemas/CheckoutPaymentOptionsResponse", "description": "Payment settings of this Billing Checkout." }, "payment_source_id": { "type": "string", "description": "ID of the Payment Source created when the Billing Checkout is completed." }, "return_url": { "type": "string", "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site, with payment status not confirmed." }, "status": { "type": "string", "description": "The status of the Billing Checkout object, can be one of: \n`ACTIVE`: The Billing Checkout is available for the customer to complete a purchase. \n`COMPLETED`: The Billing Checkout has been completed. \n`CANCELLED`: The Billing Checkout has been cancelled. \n`EXPIRED`: The Billing Checkout has expired. \nThe status automatically changes from `ACTIVE` to `EXPIRED` after 1 hour if purchase has not been completed." }, "subscription_data": { "$ref": "#/components/schemas/SubscriptionData", "description": "The settings of subscription to be passed to the subscription creation upon completion of the Billing Checkout in `SUBSCRIPTION` mode." }, "subscription_id": { "type": "string", "description": "ID of the subscription for the Billing Checkout in `SUBSCRIPTION` mode. Only applicable when the Billing Checkout is in `COMPLETED` status." }, "success_url": { "type": "string", "description": "The URL the customer will be directed to after the checkout completion." }, "ui_options": { "type": "object", "description": "UI configuration for the hosted checkout page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this billing checkout, overriding the theme configured for its legal entity." } } }, "ui_mode": { "type": "string", "description": "The UI mode of the Billing Checkout, can be one of: \n`HOSTED`: Customers complete the checkout on an Airwallex-hosted page. \n`EMBEDDED`: Embed the checkout UI directly in your website or app. \n`ELEMENTS`: Build a custom checkout UI using Airwallex Elements." }, "updated_at": { "type": "string", "description": "Time when the Billing Checkout was last updated." }, "url": { "type": "string", "description": "The URL to the Billing Checkout. The value is only present when the status is `ACTIVE`." } } }, "CursorPaginationClientApiResponseBillingCheckout": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Checkout" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "CouponDuration": { "required": [ "period", "period_unit" ], "type": "object", "properties": { "period": { "type": "integer", "description": "The number of period units.", "format": "int32", "minimum": 1 }, "period_unit": { "type": "string", "description": "Specifies duration. One of `DAY`, `WEEK`, `MONTH`, `YEAR`.", "pattern": "^(DAY|WEEK|MONTH|YEAR)$" } }, "description": "The duration of the coupon to apply, when `duration_type`is `CUSTOM`. `null` if `duration_type` is `ONCE` or `INDEFINITELY`." }, "Coupon": { "required": [ "active", "created_at", "discount_model", "duration_type", "id", "name", "times_redeemed", "updated_at" ], "type": "object", "properties": { "active": { "type": "boolean", "description": " `true` if the coupon is available to be applied to objects. `false` otherwise." }, "amount_off": { "type": "number", "description": "The fixed amount to deduct when `discount_model` is `FLAT`." }, "created_at": { "type": "string", "description": "Time when the coupon was created.", "format": "date-time" }, "currency": { "type": "string", "description": "The currency of `amount_off` when `discount_model` is `FLAT`." }, "description": { "type": "string", "description": "Description of the coupon providing business context." }, "discount_model": { "type": "string", "description": "Specified how to calculate the discount amount when applied, one of \n- `FLAT`: fixed amount off.\n- `PERCENTAGE`: percentage off." }, "duration": { "$ref": "#/components/schemas/CouponDuration", "description": "The duration of the coupon to apply, when `duration_type`is `CUSTOM`. `null` if `duration_type` is `ONCE` or `INDEFINITELY`." }, "duration_type": { "type": "string", "description": "Determines how long the coupon's discount remains active after being applied. Possible values: \n- `ONCE`: Applies only to the first charge of a subscription or a one-off invoice.\n- `CUSTOM`: Applies to all charges within a specified number of billing cycles, as defined by duration.\n- `INDEFINITELY`: Applies to all future charges for the subscription until it is removed." }, "expires_at": { "type": "string", "description": "Time after which the coupon can no longer be redeemed." }, "id": { "type": "string", "description": "ID of the Coupon object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Name of the coupon." }, "percentage_off": { "type": "number", "description": "The percentage between 0 to 100 to be applied to deduct when `discount_model` is `PERCENTAGE`." }, "times_redeemed": { "type": "integer", "description": "The number of times this coupon has been redeemed.", "format": "int32" }, "updated_at": { "type": "string", "description": "Time when the coupon was updated.", "format": "date-time" } } }, "CursorPaginationClientApiResponseCoupon": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Coupon" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "DiscountAmount": { "required": [ "amount", "applied_discount_id" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the applied discount." }, "applied_discount_id": { "type": "string", "description": "ID of the Discount object which is applied." } } }, "CreditNote": { "required": [ "adjustment_amount", "billing_customer_id", "created_at", "currency", "id", "invoice_id", "number", "out_of_band_amount", "reason", "refund_amount", "status", "total_amount", "total_discount_amounts", "total_tax_amount", "type", "updated_at" ], "type": "object", "properties": { "adjustment_amount": { "type": "number", "description": "Amount credited to decrease the amount of an unpaid invoice." }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers)." }, "created_at": { "type": "string", "description": "Time when this credit note was created." }, "currency": { "type": "string", "description": "The currency of the credit note (in 3-letter ISO-4217 format)." }, "custom_reason": { "type": "string", "description": "An explanation for issuing the credit note when the reason enum is set to `OTHER`. This field is required if the reason is `OTHER` and must be omitted or `null` for all other reason values." }, "e_invoicing_document_id": { "type": "string", "description": "The ID of the [E-Invoicing Document](/docs/api/billing/e-invoicing_documents) associated with this Credit Note. `null` when no E-Invoicing Document has been created." }, "finalized_at": { "type": "string", "description": "Time at which the credit note was finalized." }, "id": { "type": "string", "description": "ID of the Credit Note object." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices)." }, "memo": { "type": "string", "description": "Customer-facing text that appears on the credit note PDF." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "number": { "type": "string", "description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice." }, "out_of_band_amount": { "type": "number", "description": "Amount credited outside of Airwallex." }, "pdf_url": { "type": "string", "description": "The link to download the PDF for the credit note. The URL will be valid for 35 days. If the credit note has not been finalized yet, this will be `null`." }, "reason": { "type": "string", "description": "Reason for issuing this credit note, one of: `PRODUCT_RETURN`, `ORDER_CHANGE`, `PRODUCT_OR_SERVICE_UNSATISFACTORY`, `BILLING_ERROR`, `GOODWILL_GESTURE`, `OTHER`." }, "refund_amount": { "type": "number", "description": "Amount credited with refund." }, "refund_status": { "type": "string", "description": "Status of the refund, one of `CREATED`, `SUCCEEDED` or `FAILED`. If no refund was created by this Credit Note, the status will be `null`." }, "status": { "type": "string", "description": "Status of the credit note, one of `DRAFT`, `FINALIZED`, and `VOIDED`." }, "total_amount": { "type": "number", "description": "The total amount of the credit note, including tax." }, "total_discount_amounts": { "type": "array", "description": "The aggregate amounts calculated per discount across all credit note line items and the credit note.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "total_tax_amount": { "type": "number", "description": "The aggregate amounts calculated per tax rate for all line items." }, "type": { "type": "string", "description": "The type of the credit note, one of: `BEFORE_PAYMENT`, `AFTER_PAYMENT`." }, "updated_at": { "type": "string", "description": "Time when this credit note was last updated." }, "voided_at": { "type": "string", "description": "Time at which the credit note was voided." } } }, "CreditNoteDeleted": { "required": [ "deleted", "id" ], "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the delete command was executed successfully." }, "id": { "type": "string", "description": "ID of the Credit Note object." } } }, "CursorPaginationClientApiResponseCreditNote": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/CreditNote" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "InvoiceItemPriceTier": { "required": [ "level" ], "type": "object", "properties": { "flat_amount": { "type": "number", "description": "The flat amount to be charged for this tier when pricing model is `GRADUATED`, or the overall flat amount to be charged when pricing model is `VOLUME`." }, "level": { "type": "integer", "description": "The sequential position of the tier within the price definition. Starts from 1.", "format": "int32" }, "lower_bound": { "type": "number", "description": "The lower quantity limit of this tier (inclusive). For the first tier, the lower bound is 0." }, "unit_amount": { "type": "number", "description": "The per-unit amount to be charged for this tier when pricing model is `GRADUATED`, or the overall per-unit amount to be charged when pricing model is `VOLUME`." }, "upper_bound": { "type": "number", "description": "The upper quantity limit of this tier (exclusive). For the last tier, the upper bound is null." } }, "description": "The price tier this line item belongs to. Only present for graduated or volume pricing." }, "TaxBreakdownItem": { "required": [ "name", "tax_amount", "tax_percent", "taxable_amount" ], "type": "object", "properties": { "name": { "type": "string", "description": "The display name of this tax component." }, "tax_amount": { "type": "number", "description": "The amount of tax charged for this component." }, "tax_percent": { "type": "number", "description": "The tax percent applied for this component." }, "taxable_amount": { "type": "number", "description": "The portion of the subtotal that this tax component applies to." } } }, "CreditNoteLineItem": { "required": [ "amount", "created_at", "credit_note_id", "currency", "discount_amounts", "id", "tax_breakdown", "tax_percent", "updated_at" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the Credit Note Line Item." }, "created_at": { "type": "string", "description": "Time when the Credit Note Line Item was created." }, "credit_note_id": { "type": "string", "description": "ID of the [Credit Note](/docs/api/billing/credit_notes) that this Credit Note Line Item belongs to." }, "currency": { "type": "string", "description": "The currency of the Credit Note Line Item in 3-letter ISO-4217 format." }, "description": { "type": "string", "description": "Description of the Credit Note Line Item." }, "discount_amounts": { "type": "array", "description": "The amount of discount calculated per discount for this credit note line item. The Discount applied to the credit note will be apportioned to the discount_amounts of each credit note line item.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "id": { "type": "string", "description": "ID of the Credit Note Line Item object." }, "invoice_line_item_id": { "type": "string", "description": "ID of the Invoice Line Item that this credit note line item references." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "price_tier": { "$ref": "#/components/schemas/InvoiceItemPriceTier" }, "quantity": { "type": "integer", "description": "The product quantity.", "format": "int32" }, "tax_amount": { "type": "number", "description": "The tax amount of this line item." }, "tax_breakdown": { "type": "array", "description": "The tax breakdown details the exact taxes that apply to this line item.", "items": { "$ref": "#/components/schemas/TaxBreakdownItem" } }, "tax_percent": { "type": "number", "description": "The effective tax percent applied to this line item." }, "unit_amount": { "type": "number", "description": "The unit amount of the Credit Note Line Item." }, "updated_at": { "type": "string", "description": "Time when the Credit Note Line Item was last updated." } } }, "CursorPaginationClientApiResponseCreditNoteLineItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/CreditNoteLineItem" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "CreditNoteLineItemPreview": { "required": [ "amount", "currency", "discount_amounts", "tax_breakdown", "tax_percent" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the Credit Note Line Item." }, "currency": { "type": "string", "description": "The currency of the Credit Note Line Item in 3-letter ISO-4217 format." }, "description": { "type": "string", "description": "Description of the Credit Note Line Item." }, "discount_amounts": { "type": "array", "description": "The amount of discount calculated per discount for this credit note line item. The Discount applied to the credit note will be apportioned to the discount_amounts of each credit note line item.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "invoice_line_item_id": { "type": "string", "description": "ID of the Invoice Line Item that this credit note line item references." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "quantity": { "type": "integer", "description": "The product quantity.", "format": "int32" }, "tax_amount": { "type": "number", "description": "The tax amount of this line item." }, "tax_breakdown": { "type": "array", "description": "The tax breakdown details the exact taxes that apply to this line item.", "items": { "$ref": "#/components/schemas/TaxBreakdownItem" } }, "tax_percent": { "type": "number", "description": "The effective tax percent applied to this line item." }, "unit_amount": { "type": "number", "description": "The unit amount of the Credit Note Line Item." } } }, "CreditNotePreview": { "required": [ "billing_customer_id", "currency", "invoice_id", "line_items", "total_amount", "total_discount_amounts", "total_tax_amount" ], "type": "object", "properties": { "adjustment_amount": { "type": "number", "description": "Amount credited to decrease the amount of an unpaid invoice." }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers)." }, "currency": { "type": "string", "description": "The currency of the credit note (in 3-letter ISO-4217 format)." }, "custom_reason": { "type": "string", "description": "An explanation for issuing the credit note when the reason enum is set to `OTHER`. This field is required if the reason is `OTHER` and must be omitted or `null` for all other reason values." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices)." }, "line_items": { "type": "array", "description": "The list of credit note line items in the preview.", "items": { "$ref": "#/components/schemas/CreditNoteLineItemPreview" } }, "memo": { "type": "string", "description": "Customer-facing text that appears on the credit note PDF." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "reason": { "type": "string", "description": "Reason for issuing this credit note, one of: `PRODUCT_RETURN`, `ORDER_CHANGE`, `PRODUCT_OR_SERVICE_UNSATISFACTORY`, `BILLING_ERROR`, `GOODWILL_GESTURE`, `OTHER`." }, "refund_amount": { "type": "number", "description": "Amount credited with refund." }, "total_amount": { "type": "number", "description": "The total amount of the credit note, including tax." }, "total_discount_amounts": { "type": "array", "description": "The aggregate amounts calculated per discount across all credit note line items and the credit note.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "total_tax_amount": { "type": "number", "description": "The total tax amount of the credit note." }, "type": { "type": "string", "description": "The type of the credit note, one of: `BEFORE_PAYMENT`, `AFTER_PAYMENT`." } } }, "CustomerResponse": { "required": [ "automatic_tax_eligibility", "created_at", "id", "updated_at" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/CustomerAddress", "description": "Address of the billing customer." }, "automatic_tax_eligibility": { "type": "string", "description": "Indicates whether automatic tax can be applied for this customer based on the customer's current address data and the seller’s tax registration for that jurisdiction.", "enum": [ "ELIGIBLE", "LOCATION_NOT_SUPPORTED", "ADDRESS_INCOMPLETE" ], "x-enumDescriptions": { "ELIGIBLE": "Customer is in a jurisdiction where the seller is registered, and automatic tax can be applied.", "LOCATION_NOT_SUPPORTED": "The customer's jurisdiction can be determined from the current address data, but automatic tax calculation isn't supported there.", "ADDRESS_INCOMPLETE": "The customer's jurisdiction can't be determined from the provided address data." } }, "created_at": { "type": "string", "description": "Time when the billing customer was created." }, "default_billing_currency": { "type": "string", "description": "Default currency to use when billing this customer in 3-letter ISO-4217 format." }, "default_legal_entity_id": { "type": "string", "description": "ID of the default legal entity to use when billing this customer." }, "description": { "type": "string", "description": "Additional description about the billing customer." }, "email": { "type": "string", "description": "Email address of the billing customer." }, "id": { "type": "string", "description": "ID of the billing customer object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Name of the billing customer." }, "nickname": { "type": "string", "description": "Internal nickname for the billing customer." }, "phone_number": { "type": "string", "description": "Phone number of the billing customer." }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the billing customer." }, "type": { "type": "string", "description": "Type of the billing customer.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "updated_at": { "type": "string", "description": "Time when the billing customer was last updated." } } }, "CursorPaginationClientApiResponseCustomer": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/CustomerResponse" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "BankTransferInstructions": { "required": [ "account_name", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Currency of the receiving account (3-letter ISO-4217 code)." }, "account_name": { "type": "string", "description": "Name of the account holder receiving the transfer." }, "account_number": { "type": "string", "description": "Bank account number." }, "account_category": { "type": "string", "description": "Category of the receiving bank account. One of `CHECKING`, `SAVINGS`, or `BUSINESS`.", "enum": [ "CHECKING", "SAVINGS", "BUSINESS" ] }, "bank_name": { "type": "string", "description": "Name of the financial institution in which the receiving account is domiciled." }, "iban": { "type": "string", "description": "IBAN number." }, "swift_code": { "type": "string", "description": "Bank SWIFT or BIC code." }, "routing_number": { "type": "string", "description": "Bank routing number. Applicable only to accounts in the United States." }, "sort_code": { "type": "string", "description": "Bank sort code. Applicable only to accounts in the United Kingdom." }, "bsb_number": { "type": "string", "description": "Bank State Branch (BSB) number. Applicable only to accounts in Australia." }, "bank_code": { "type": "string", "description": "Code identifying the bank. Applicable in markets including Singapore and Hong Kong." }, "branch_code": { "type": "string", "description": "Code identifying the bank branch. Used together with `bank_code`." }, "transit_number": { "type": "string", "description": "Bank transit number. Applicable only to accounts in Canada." }, "institution_number": { "type": "string", "description": "Institution number identifying the bank. Applicable only to accounts in Canada." }, "charge_type": { "type": "string", "description": "Indicates who bears the bank charges on the transfer. Returned only for international (SWIFT) transfers. Omitted for local transfers.\nPossible value:\n- `OUR`: The payer covers all transfer charges so the full amount is received.", "enum": [ "OUR" ] }, "merchant_address": { "required": [ "country_code" ], "type": "object", "description": "The recipient's registered business address, used when making an international (SWIFT) transfer. Returned only for SWIFT transfers. Omitted for local transfers.", "properties": { "country_code": { "type": "string", "description": "Two-letter ISO 3166-1 country code of the recipient's address." }, "state": { "type": "string", "description": "State, province, or region of the recipient's address." }, "suburb": { "type": "string", "description": "Suburb or city of the recipient's address." }, "postcode": { "type": "string", "description": "Postal or ZIP code of the recipient's address." }, "street_address": { "type": "array", "description": "Street address of the recipient, given as one or more address lines.", "items": { "type": "string" } } } } } }, "DiscountResponse": { "required": [ "applied_to", "applied_to_id", "billing_customer_id", "created_at", "discount_model", "duration_type", "id", "name", "source", "starts_at", "updated_at" ], "type": "object", "properties": { "amount_off": { "type": "number", "description": "The fixed amount to deduct when `discount_model` is `FLAT`." }, "applied_to": { "type": "string", "description": "Specifies the type of object this discount applies to. Possible values: \n- `SUBSCRIPTION`: Applies to an entire subscription. \n- `SUBSCRIPTION_ITEM`: Applies to a specific item within a subscription. \n- `INVOICE`: Applies to an entire invoice. \n- `INVOICE_LINE_ITEM`: Applies to a specific line item on an invoice." }, "applied_to_id": { "type": "string", "description": "ID of the specific target object the discount is applied to. Must correspond to the object type defined in applied_to." }, "billing_customer_id": { "type": "string", "description": "The ID of the billing customer to whom the coupon is applied." }, "checkout_id": { "type": "string", "description": "The ID of the Checkout where this discount was redeemed, if applicable." }, "created_at": { "type": "string", "description": "Time when the Discount was created.", "format": "date-time" }, "currency": { "type": "string", "description": "The currency of `amount_off` when `discount_model` is `FLAT`." }, "discount_model": { "type": "string", "description": "Specified how to calculate the discount amount when applied, one of \n- `FLAT`: fixed amount off.\n- `PERCENTAGE`: percentage off." }, "duration": { "$ref": "#/components/schemas/CouponDuration", "description": "The duration of the discount to apply, when `duration_type` is `CUSTOM`. `null` if `duration_type` is `ONCE` or `INDEFINITELY`." }, "duration_type": { "type": "string", "description": "Determines how long the coupon's discount remains active after being applied. Possible values: \n- `ONCE`: Applies only to the first charge of a subscription or a one-off invoice.\n- `CUSTOM`: Applies to all charges within a specified number of billing cycles, as defined by duration.\n- `INDEFINITELY`: Applies to all future charges for the subscription until it is removed." }, "ends_at": { "type": "string", "description": "The timestamp when the discount expires. Present only when the associated coupon's duration_type is CUSTOM." }, "id": { "type": "string", "description": "ID of the Discount object." }, "name": { "type": "string", "description": "Name of the discount. For discounts created from a coupon, defaults to the coupon name at creation time." }, "percentage_off": { "type": "number", "description": "The percentage between 0 to 100 to be applied to deduct when `discount_model` is `PERCENTAGE`." }, "source": { "type": "string", "description": "Source of the Discount. Possible values: \n- `COUPON`: the discount is applied through a coupon." }, "source_id": { "type": "string", "description": "ID of the creating source, e.g. is the ID of the coupon if source = COUPON." }, "starts_at": { "type": "string", "description": "Time when the discount takes effect. For discounts applied to a subscription or subscription item, this corresponds to the start date of the first billing period." }, "updated_at": { "type": "string", "description": "Time when the Discount was updated.", "format": "date-time" } } }, "InvoiceBankTransferInstructions": { "required": [ "account_name", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Currency of the receiving account (3-letter ISO-4217 code)." }, "account_name": { "type": "string", "description": "Name of the account holder receiving the transfer." }, "account_number": { "type": "string", "description": "Bank account number." }, "account_category": { "type": "string", "description": "Category of the receiving bank account. One of `CHECKING`, `SAVINGS`, or `BUSINESS`.", "enum": [ "CHECKING", "SAVINGS", "BUSINESS" ] }, "bank_name": { "type": "string", "description": "Name of the financial institution in which the receiving account is domiciled." }, "iban": { "type": "string", "description": "IBAN number." }, "swift_code": { "type": "string", "description": "Bank SWIFT or BIC code." }, "routing_number": { "type": "string", "description": "Bank routing number. Applicable only to accounts in the United States." }, "sort_code": { "type": "string", "description": "Bank sort code. Applicable only to accounts in the United Kingdom." }, "bsb_number": { "type": "string", "description": "Bank State Branch (BSB) number. Applicable only to accounts in Australia." }, "bank_code": { "type": "string", "description": "Code identifying the bank. Applicable in markets including Singapore and Hong Kong." }, "branch_code": { "type": "string", "description": "Code identifying the bank branch. Used together with `bank_code`." }, "transit_number": { "type": "string", "description": "Bank transit number. Applicable only to accounts in Canada." }, "institution_number": { "type": "string", "description": "Institution number identifying the bank. Applicable only to accounts in Canada." }, "charge_type": { "type": "string", "description": "Indicates who bears the bank charges on the transfer. Returned only for international (SWIFT) transfers. Omitted for local transfers.\nPossible value:\n- `OUR`: The payer covers all transfer charges so the full amount is received.", "enum": [ "OUR" ] }, "merchant_address": { "required": [ "country_code" ], "type": "object", "description": "The recipient's registered business address, used when making an international (SWIFT) transfer. Returned only for SWIFT transfers. Omitted for local transfers.", "properties": { "country_code": { "type": "string", "description": "Two-letter ISO 3166-1 country code of the recipient's address." }, "state": { "type": "string", "description": "State, province, or region of the recipient's address." }, "suburb": { "type": "string", "description": "Suburb or city of the recipient's address." }, "postcode": { "type": "string", "description": "Postal or ZIP code of the recipient's address." }, "street_address": { "type": "array", "description": "Street address of the recipient, given as one or more address lines.", "items": { "type": "string" } } } }, "reference": { "type": "string", "description": "Unique payment reference to include with the bank transfer to match the payment to this Invoice. Available after the Invoice is finalized." } } }, "InvoicePaymentMethodSave": { "type": "object", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`. \n`ENABLED`: The payment method will be saved for future use. \n`DISABLED`: The payment method will not be saved. \n`COLLECT_CONSENT`: The digital invoice UI asks the customer whether they want to save the payment method." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`. \nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } }, "description": "Settings for saving this payment method for future use." }, "InvoicePaymentOptions": { "type": "object", "properties": { "payment_method_save": { "$ref": "#/components/schemas/InvoicePaymentMethodSave", "description": "Settings for saving this payment method for future use." }, "payment_method_types": { "type": "array", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page.", "items": { "type": "string", "description": "Specify which payment methods to display on the digital invoice page and set their display order. Only methods supported for the specified currency and the customer's country code will appear on the digital invoice page." } } }, "description": "Payment settings of this Invoice. Only applicable if collection_method is `CHARGE_ON_CHECKOUT`." }, "Invoice": { "required": [ "amount_due", "applied_discounts", "automatic_tax_status", "billing_customer_id", "created_at", "currency", "enable_automatic_tax", "id", "paid_out_of_band", "payment_status", "status", "total_amount", "total_discount_amounts", "total_tax_amount", "updated_at" ], "type": "object", "properties": { "amount_due": { "type": "number", "description": "The total amount remaining to be paid on this invoice. When the amount due reaches 0, the invoice payment status transitions to `PAID`." }, "applied_discounts": { "type": "array", "description": "List of discounts that are applied to the invoice. Discounts of invoice line items are applied before invoice discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "automatic_tax_status": { "type": "string", "description": "The automatic tax status of this invoice.", "enum": [ "APPLIED", "LOCATION_NOT_SUPPORTED", "LOCATION_NOT_REGISTERED_BY_MERCHANT", "ADDRESS_INCOMPLETE", "DISABLED" ], "x-enumDescriptions": { "APPLIED": "The automatic tax is applied.", "LOCATION_NOT_SUPPORTED": "Automatic tax calculation isn't supported in the customer's location.", "LOCATION_NOT_REGISTERED_BY_MERCHANT": "The merchant isn't registered to collect tax in the customer's location.", "ADDRESS_INCOMPLETE": "The customer address was insufficient or invalid to determine the correct tax.", "DISABLED": "The automatic tax is disabled." } }, "bank_transfer_instructions": { "$ref": "#/components/schemas/InvoiceBankTransferInstructions", "description": "Bank transfer instructions for paying this Invoice. Included when bank transfer is enabled, the Invoice currency is supported, and the Billing Customer is eligible." }, "billing_customer": { "$ref": "#/components/schemas/Billing_BillingCustomerSnapshot", "description": "Snapshot of the [Billing Customer](/docs/api/billing/billing_customers) captured on this invoice." }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who this Invoice is issued to." }, "collection_method": { "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "created_at": { "type": "string", "description": "Time when this invoice was created." }, "credit_note_amount_after_payment": { "type": "number", "description": "The total amount of all credit notes issued for this invoice after invoice payment." }, "credit_note_amount_before_payment": { "type": "number", "description": "The total amount of all credit notes issued for this invoice before invoice payment." }, "currency": { "type": "string", "description": "The currency of the Invoice in 3-letter ISO-4217 format." }, "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due.", "format": "int32" }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to each Line Item's price. The tax will be exclusive." }, "due_at": { "type": "string", "description": "Due date set by the merchant for this invoice, if any." }, "e_invoicing_document_id": { "type": "string", "description": "The ID of the [E-Invoicing Document](/docs/api/billing/e-invoicing_documents) associated with this Invoice. `null` when no E-Invoicing Document has been created." }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this invoice. When enabled, the system attempts to calculate taxes automatically." }, "finalized_at": { "type": "string", "description": "The time that the invoice draft was finalized." }, "footer": { "type": "string", "description": "Additional payment instructions or supplementary information that merchants can share with their customers. Displayed in the Invoice PDF." }, "hosted_url": { "type": "string", "description": "URL of the hosted page where customers can view and pay this invoice. The URL is valid for 35 days." }, "id": { "type": "string", "description": "ID of the Invoice object." }, "last_payment_attempt_at": { "type": "string", "description": "Time of last payment attempt. Only applicable when `subscription_id` is not `null`." }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section." }, "memo": { "type": "string", "description": "String used to describe the object. Referenced as memo or invoice note in Webapp." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "next_payment_attempt_at": { "type": "string", "description": "Time of next payment attempt. Only applicable when `subscription_id` is not `null`." }, "number": { "type": "string", "description": "A unique, identifying string that appears on emails sent to the customer for this invoice." }, "paid_at": { "type": "string", "description": "The time that the invoice was paid." }, "paid_out_of_band": { "type": "boolean", "description": "Returns `true` if the invoice was manually marked paid, returns `false` if the invoice hasn't been paid yet or was paid on Airwallex." }, "past_payment_attempt_count": { "type": "integer", "description": "The number of payment attempts made on this invoice so far. Only applicable when `subscription_id` is not `null`.", "format": "int32" }, "payment_options": { "$ref": "#/components/schemas/InvoicePaymentOptions", "description": "Payment settings of this Invoice. Only applicable if collection_method is `CHARGE_ON_CHECKOUT`." }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the invoice. \nIf `collection_method` is `CHARGE_ON_CHECKOUT`, a Payment Source is automatically created during invoice payment when `payment_options.payment_method_save.next_triggered_by` is `MERCHANT` and `payment_options.payment_method_save.mode` is `ENABLED`, or when it is `COLLECT_CONSENT` and the customer has given consent." }, "payment_status": { "type": "string", "description": "Status of the payment for the invoice, one of `UNPAID` and `PAID`." }, "pdf_url": { "type": "string", "description": "The link to download the PDF for the invoice. The URL will be valid for 35 days. If the invoice has not been finalized yet, this will be `null`." }, "remaining_payment_attempt_count": { "type": "integer", "description": "The number of the remaining payment attempts. If `0`, no more payment attempts would be triggered automatically for this invoice. Only applicable when `subscription_id` is not `null`.", "format": "int32" }, "status": { "type": "string", "description": "Status of the invoice. Once the invoice is created, it will be defaulted to `DRAFT`, and once the invoice is finalized, it will turn to `FINALIZED`. When an invoice is voided, it will become `VOIDED`." }, "subscription_id": { "type": "string", "description": "ID of the [Subscription](/docs/api/billing/subscriptions) that generated this invoice, if any." }, "ui_options": { "type": "object", "description": "UI configuration for the digital invoice page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this invoice, overriding the theme configured for its legal entity." } } }, "total_amount": { "type": "number", "description": "The total amount of the invoice, including tax and discount if applicable." }, "total_discount_amounts": { "type": "array", "description": " The aggregate amounts calculated per discount across all Invoice Line Items and the Invoice.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "total_tax_amount": { "type": "number", "description": "The aggregate amounts calculated for all line items." }, "updated_at": { "type": "string", "description": "Time when this invoice was last updated." }, "voided_at": { "type": "string", "description": "The time that the invoice was voided." } } }, "InvoiceDeleted": { "required": [ "deleted", "id" ], "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the delete command was executed successfully." }, "id": { "type": "string", "description": "ID of the Invoice object." } } }, "CursorPaginationClientApiResponseInvoice": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Invoice" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "LineItemGroup": { "required": [ "id", "invoice_id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The id of the line item group." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices) object that this Invoice Line Item Group belongs to." }, "label": { "type": "string", "description": "Describes what this line item group charges for." }, "period_ends_at": { "type": "string", "description": "The end of the billing period associated with this Invoice Line Item Group. This value is exclusive." }, "period_starts_at": { "type": "string", "description": "The start of the billing period associated with this Invoice Line Item Group. This value is inclusive." }, "total_amount": { "type": "number", "description": "Total amount of all line items in this group." }, "total_discount_amount": { "type": "number", "description": "Total discount amount of all line items in this group." }, "total_quantity": { "type": "number", "description": "Total quantity across all line items in this group." }, "total_remaining_creditable_amount": { "type": "number", "description": "Total amount available for future credits in this group." }, "total_remaining_creditable_quantity": { "type": "number", "description": "Total quantity available for future credits in this group." }, "total_tax_amount": { "type": "number", "description": "Total tax amount of all line items in this group." } } }, "CursorPaginationClientApiResponseLineItemGroup": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/LineItemGroup" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "PriceLot": { "required": [ "rounding_mode", "size" ], "type": "object", "properties": { "rounding_mode": { "pattern": "^UP$", "type": "string", "description": "Specifies how to round the calculated lots when the total quantity is not an exact multiple of the size. One of `UP`." }, "size": { "minimum": 2, "type": "integer", "description": "The amount of quantity that constitutes a single billable lot.", "format": "int32" } }, "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT` price." }, "ProductResponse": { "required": [ "active", "created_at", "id", "name", "unit", "updated_at" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the product is available for new purchases, `false` otherwise." }, "created_at": { "type": "string", "description": "Time when this product was created." }, "description": { "type": "string", "description": "Product description." }, "id": { "type": "string", "description": "ID of the Product object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Product name." }, "tax_code": { "type": "string", "description": "The tax category of the product." }, "unit": { "type": "string", "description": "Product unit." }, "updated_at": { "type": "string", "description": "Time when this product was last updated." } }, "description": "Details of the [Product](/docs/api/billing/products) object this price is associated with." }, "PriceRecurring": { "required": [ "period", "period_unit" ], "type": "object", "properties": { "period": { "type": "integer", "description": "The number of period units between subscription billing cycles. For example, the billing cycle is bi-monthly if `period=2` and `period_unit=MONTH`.", "format": "int32" }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH` or `YEAR`." } }, "description": "The frequency at which the price is charged. null for one-time charge." }, "PriceTier": { "required": [ "level" ], "type": "object", "properties": { "flat_amount": { "type": "number", "description": "The flat amount to be charged for this tier when pricing model is `GRADUATED`, or the overall flat amount to be charged when pricing model is `VOLUME`.", "minimum": 0 }, "level": { "type": "integer", "description": "The sequential position of the tier within the price definition. Starts from 1.", "format": "int32" }, "lot": { "$ref": "#/components/schemas/PriceLot", "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `VOLUME` and `GRADUATED` prices." }, "unit_amount": { "type": "number", "description": "The per-unit amount to be charged for this tier when pricing model is `GRADUATED`, or the overall per-unit amount to be charged when pricing model is `VOLUME`.", "minimum": 0 }, "unit_description": { "type": "string", "description": "Description of the billable unit for the tier." }, "upper_bound": { "type": "number", "description": "The upper quantity limit of this tier. This tier is applicable when the quantity does not exceed the upper bound of this tier, and is greater than the upper bound of the tier below it(or `0` if this is the first tier). For the last tier, the upper bound must be left empty.", "minimum": 0 } } }, "PriceWithProduct": { "required": [ "active", "created_at", "currency", "id", "metered", "pricing_model", "product", "product_id", "tax_included", "type", "updated_at" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the price is available for new purchases, `false` otherwise." }, "billing_type": { "type": "string", "description": "Indicates when should the price be billed, one of \n- `IN_ADVANCE`: billed at the beginning of the billing cycle.\n- `IN_ARREARS`: billed at the end of the billing cycle." }, "created_at": { "type": "string", "description": "Time when the price was created." }, "currency": { "type": "string", "description": "Currency of the price (in 3-letter ISO-4217 format)." }, "description": { "type": "string", "description": "Price description." }, "flat_amount": { "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "id": { "type": "string", "description": "ID of the Price object." }, "lot": { "$ref": "#/components/schemas/PriceLot", "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT` price." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "meter_id": { "type": "string", "description": "ID of the Meter object specifying how to calculate the usage for this price." }, "metered": { "type": "boolean", "description": "Specify how to determine the quantity of the product used in each billing cycle for subscription payments. `true` if the quantity is dynamically determined during the billing cycle. The merchant should call the Ingest Usage Events API to submit usage data when the product is used. `false` if the quantity is determined when creating a subscription." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity.\n- `VOLUME`: the unit price is based on which tier the total quantity falls in.\n- `GRADUATED`: the unit price changes as the quantity increases." }, "product": { "$ref": "#/components/schemas/ProductResponse", "description": "Details of the [Product](/docs/api/billing/products) object this price is associated with." }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object this price is associated with." }, "recurring": { "$ref": "#/components/schemas/PriceRecurring" }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax." }, "tiers": { "type": "array", "description": "List of quantity-based pricing tiers for this price. Required when the pricing model is `VOLUME` or `GRADUATED`.", "items": { "$ref": "#/components/schemas/PriceTier" } }, "type": { "type": "string", "description": "One of `ONE_OFF` or `RECURRING` depending on whether the price is for a one-off purchase or a recurring (subscription) purchase." }, "unit_amount": { "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." }, "unit_description": { "type": "string", "description": "Description of the billable unit for the price." }, "updated_at": { "type": "string", "description": "Time when the price was last updated." } }, "description": "Price subscribed by the customer." }, "RateCardItemLot": { "required": [ "rounding_mode", "size" ], "type": "object", "properties": { "rounding_mode": { "pattern": "^UP$", "type": "string", "description": "Specifies how to round the calculated lots when the total quantity is not an exact multiple of the size. One of `UP`." }, "size": { "minimum": 2, "type": "integer", "description": "The amount of quantity that constitutes a single billable lot.", "format": "int32" } }, "description": "Defines how quantity is grouped into billable lots. The `unit_amount` is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT`." }, "RateCardItemTier": { "required": [ "level" ], "type": "object", "properties": { "flat_amount": { "type": "number", "description": "The flat amount to be charged for this tier when pricing model is `GRADUATED`, or the overall flat amount to be charged when pricing model is `VOLUME`.", "minimum": 0 }, "level": { "type": "integer", "description": "The sequential position of the tier within the item definition. Starts from 1.", "format": "int32" }, "lot": { "$ref": "#/components/schemas/RateCardItemLot", "description": "Defines how quantity is grouped into billable lots. The `unit_amount` is then applied per lot. Only applicable for `VOLUME` and `GRADUATED`." }, "unit_amount": { "type": "number", "description": "The per-unit amount to be charged for this tier when pricing model is `GRADUATED`, or the overall per-unit amount to be charged when pricing model is `VOLUME`.", "minimum": 0 }, "unit_description": { "type": "string", "description": "Description of the billable unit for the tier." }, "upper_bound": { "type": "number", "description": "The upper quantity limit of this tier. For the last tier, the upper bound must be left empty.", "minimum": 0 } }, "description": "A quantity-based pricing tier for a Rate Card Item." }, "RateCardItem": { "required": [ "created_at", "dimension_values", "id", "pricing_model", "rate_card_id" ], "type": "object", "properties": { "created_at": { "type": "string", "description": "Time when this rate card item was created." }, "dimension_values": { "type": "object", "additionalProperties": { "type": "string", "description": "A dimension value that this item applies to." }, "description": "The dimension values this item applies to. Each key must be one of the Rate Card Version's `dimension_keys` (a subset is allowed). Any key omitted here acts as a wildcard, matching any value for that dimension; an empty object matches all usage (a catch-all)." }, "id": { "type": "string", "description": "ID of the Rate Card Item object." }, "lot": { "$ref": "#/components/schemas/RateCardItemLot", "description": "Defines how quantity is grouped into billable lots. The `unit_amount` is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT`." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `PER_UNIT`: a fixed price per unit quantity.\n- `VOLUME`: the unit price is based on which tier the total quantity falls in.\n- `GRADUATED`: the unit price changes as the quantity increases." }, "rate_card_id": { "type": "string", "description": "ID of the Rate Card this item belongs to." }, "tiers": { "type": "array", "description": "List of quantity-based pricing tiers for this item. Only present when the pricing model is `VOLUME` or `GRADUATED`.", "items": { "$ref": "#/components/schemas/RateCardItemTier" } }, "unit_amount": { "type": "number", "description": "The amount to be charged per product unit. Only present when the pricing model is `PER_UNIT`." }, "unit_description": { "type": "string", "description": "Description of the billable unit for this item." } }, "description": "A Rate Card Item represents the price for one dimension combination within a Rate Card version." }, "InvoiceItem": { "required": [ "amount", "applied_discounts", "created_at", "currency", "discount_amounts", "id", "invoice_id", "updated_at" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the Invoice Line Item." }, "applied_discounts": { "type": "array", "description": "List of discounts that are applied to the invoice. Discounts of invoice line items are applied before invoice discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "created_at": { "type": "string", "description": "Time when the price was created." }, "currency": { "type": "string", "description": "The currency of the Invoice Line Item in 3-letter ISO-4217 format." }, "description": { "type": "string", "description": "Description of the Invoice Line Item." }, "discount_amounts": { "type": "array", "description": "The amount of discount calculated per discount for this line item. The Discount applied to the invoice will be apportioned to the [DiscountAmountResponse](/docs/api/billing/invoices)s of each invoice line item.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "id": { "type": "string", "description": "ID of the Invoice Line Item object." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices) object that this Invoice Line Item belongs to." }, "label": { "type": "string", "description": "String to describe what this line item charges for." }, "line_item_group_id": { "type": "string", "description": "The ID of the line item group this line item belongs to." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "period_ends_at": { "type": "string", "description": "The end of the billing period associated with this Invoice Line Item. This value is exclusive." }, "period_starts_at": { "type": "string", "description": "The start of the billing period associated with this Invoice Line Item. This value is inclusive." }, "price": { "$ref": "#/components/schemas/PriceWithProduct", "description": "Price subscribed by the customer. Mutually exclusive with `rate_card_item`." }, "quantity": { "type": "integer", "description": "The product quantity.", "format": "int32" }, "price_tier": { "$ref": "#/components/schemas/InvoiceItemPriceTier", "description": "The price tier this line item belongs to. Only present for graduated or volume pricing. Mutually exclusive with `rate_card_item_tier`." }, "rate_card_item": { "$ref": "#/components/schemas/RateCardItem", "description": "Rate Card Item billed to the customer. Mutually exclusive with `price`." }, "rate_card_item_tier": { "$ref": "#/components/schemas/InvoiceItemPriceTier", "description": "The Rate Card Item tier this line item belongs to. Only present for graduated or volume pricing. Mutually exclusive with `price_tier`." }, "remaining_creditable_amount": { "type": "number", "description": "The total amount currently available to be credited for this invoice line item, excluding tax and discount." }, "remaining_creditable_quantity": { "type": "number", "description": "Defines the maximum quantity of this line item available for future credits." }, "tax_amount": { "type": "number", "description": "The tax amount for this line item." }, "tax_breakdown": { "type": "array", "description": "The tax breakdown details the exact taxes that apply to this line item.", "items": { "$ref": "#/components/schemas/TaxBreakdownItem" } }, "tax_percent": { "type": "number", "description": "The effective tax percent of this invoice line item." }, "updated_at": { "type": "string", "description": "Time when the price was last updated." } } }, "CursorPaginationClientApiResponseInvoiceItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/InvoiceItem" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "Price": { "required": [ "active", "created_at", "currency", "id", "metered", "pricing_model", "product_id", "tax_included", "type", "updated_at" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the price is available for new purchases, `false` otherwise." }, "billing_type": { "type": "string", "description": "Indicates when should the price be billed, one of \n- `IN_ADVANCE`: billed at the beginning of the billing cycle.\n- `IN_ARREARS`: billed at the end of the billing cycle." }, "created_at": { "type": "string", "description": "Time when the price was created." }, "currency": { "type": "string", "description": "Currency of the price (in 3-letter ISO-4217 format)." }, "description": { "type": "string", "description": "Price description." }, "flat_amount": { "type": "number", "description": "The fixed amount to be charged. Only required when the pricing model is `FLAT`." }, "id": { "type": "string", "description": "ID of the Price object." }, "lot": { "$ref": "#/components/schemas/PriceLot", "description": "Defines how quantity is grouped into billable lots. The unit_amount is then applied per lot. If not set, quantity is treated as the number of billable lots. Only applicable for `PER_UNIT` price." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "meter_id": { "type": "string", "description": "ID of the Meter object specifying how to calculate the usage for this price." }, "metered": { "type": "boolean", "description": "Specify how to determine the quantity of the product used in each billing cycle for subscription payments. `true` if the quantity is dynamically determined during the billing cycle. The merchant should call the Ingest Usage Events API to submit usage data when the product is used. `false` if the quantity is determined when creating a subscription." }, "pricing_model": { "type": "string", "description": "Specify how to calculate the total billing amount when a quantity is provided. One of\n- `FLAT`: a fixed price.\n- `PER_UNIT`: a fixed price per unit quantity.\n- `VOLUME`: the unit price is based on which tier the total quantity falls in.\n- `GRADUATED`: the unit price changes as the quantity increases." }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object this price is associated with." }, "recurring": { "$ref": "#/components/schemas/PriceRecurring", "description": "The frequency at which the price is charged. null for one-time charge." }, "tax_included": { "type": "boolean", "description": "Whether the price includes tax." }, "tiers": { "type": "array", "description": "List of quantity-based pricing tiers for this price. Required when the pricing model is `VOLUME` or `GRADUATED`.", "items": { "$ref": "#/components/schemas/PriceTier" } }, "type": { "type": "string", "description": "One of `ONE_OFF` or `RECURRING` depending on whether the price is for a one-off purchase or a recurring (subscription) purchase." }, "unit_amount": { "type": "number", "description": "The amount to be charged per product unit. Only required when the pricing model is `PER_UNIT`." }, "unit_description": { "type": "string", "description": "Description of the billable unit for the price." }, "updated_at": { "type": "string", "description": "Time when the price was last updated." } }, "description": "Price subscribed by the customer." }, "InvoiceItemPreview": { "required": [ "amount", "applied_discounts", "currency", "discount_amounts", "price", "quantity" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the Invoice Line Item." }, "applied_discounts": { "type": "array", "description": "List of discounts that are applied to the invoice. Discounts of invoice line items are applied before invoice discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "currency": { "type": "string", "description": "The currency of the Invoice Line Item in 3-letter ISO-4217 format." }, "discount_amounts": { "type": "array", "description": "The amount of discount calculated per discount for this line item. The Discount applied to the invoice will be apportioned to the [DiscountAmountResponse](/docs/api/billing/invoices)s of each invoice line item.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "period_ends_at": { "type": "string", "description": "The end of the billing period associated with this Invoice Line Item. This value is exclusive." }, "period_starts_at": { "type": "string", "description": "The start of the billing period associated with this Invoice Line Item. This value is inclusive." }, "price": { "$ref": "#/components/schemas/Price", "description": "Price subscribed by the customer." }, "quantity": { "type": "integer", "description": "The product quantity.", "format": "int32" }, "remaining_creditable_quantity": { "type": "number", "description": "Defines the maximum quantity of this line item available for future credits." }, "tax_amount": { "type": "number", "description": "The tax amount for this line item." }, "tax_breakdown": { "type": "array", "description": "The tax breakdown details the exact taxes that apply to this line item.", "items": { "$ref": "#/components/schemas/TaxBreakdownItem" } }, "tax_percent": { "type": "number", "description": "The effective tax percent of this invoice line item." } } }, "InvoicePreview": { "required": [ "applied_discounts", "automatic_tax_status", "billing_customer_id", "created_at", "currency", "enable_automatic_tax", "items", "total_amount", "total_discount_amounts", "total_tax_amount" ], "type": "object", "properties": { "applied_discounts": { "type": "array", "description": "List of discounts that are applied to the invoice. Discounts of invoice line items are applied before invoice discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "automatic_tax_status": { "type": "string", "description": "The automatic tax status of this invoice.", "enum": [ "APPLIED", "LOCATION_NOT_SUPPORTED", "LOCATION_NOT_REGISTERED_BY_MERCHANT", "ADDRESS_INCOMPLETE", "DISABLED" ], "x-enumDescriptions": { "APPLIED": "The automatic tax is applied.", "LOCATION_NOT_SUPPORTED": "Automatic tax calculation isn't supported in the customer's location.", "LOCATION_NOT_REGISTERED_BY_MERCHANT": "The merchant isn't registered to collect tax in the customer's location.", "ADDRESS_INCOMPLETE": "The customer address was insufficient or invalid to determine the correct tax.", "DISABLED": "The automatic tax is disabled." } }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who will be charged." }, "created_at": { "type": "string", "description": "Time when this invoice will be created." }, "currency": { "type": "string", "description": "The currency of the Invoice in 3-letter ISO-4217 format." }, "default_tax_percent": { "type": "number", "description": "The tax percent between `0` and `100` to be applied to each Line Item's price. The tax will be exclusive. Defaults to `0`.", "maximum": 100, "minimum": 0 }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this invoice. When enabled, the system attempts to calculate taxes automatically." }, "items": { "type": "array", "description": "The preview invoice items.", "items": { "$ref": "#/components/schemas/InvoiceItemPreview" } }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used for the Invoice as billing entity." }, "subscription_id": { "type": "string", "description": "ID of the [Subscription](/docs/api/billing/subscriptions) which generated this invoice, if any." }, "total_amount": { "type": "number", "description": "The total amount of the invoice." }, "total_discount_amounts": { "type": "array", "description": " The aggregate amounts calculated per discount across all Invoice Line Items and the Invoice.", "items": { "$ref": "#/components/schemas/DiscountAmount" } }, "total_tax_amount": { "type": "number", "description": "The aggregate amounts calculated for all line items." } } }, "Meter": { "required": [ "aggregation_method", "archived", "created_at", "event_name", "id", "name", "updated_at" ], "type": "object", "properties": { "aggregation_method": { "type": "string", "description": "Type of aggregation to perform, based on each event's `properties` value. One of\n- `COUNT`: count the number of events.\n- `LAST`: the value of the last event.\n- `MAX`: maximum of all event values.\n- `SUM`: sum up the value of each event.\n- `UNIQUE`: count the number of unique events." }, "aggregation_property": { "type": "string", "description": "The name of the property within the event to aggregate. Events will be ignored during aggregation if they are missing this property or if its value is invalid." }, "archived": { "type": "boolean", "description": "`false` if the Meter is available to be linked to new prices, `true` otherwise." }, "created_at": { "type": "string", "description": "Time when this meter was created." }, "description": { "type": "string", "description": "Meter description. Used for internal classification and identification." }, "dimension_keys": { "type": "array", "description": "Append-only list of event property keys. New keys can be appended; existing keys cannot be modified, removed, or renamed. Used for event grouping and filtering. A usage event may include any subset of these (or none).", "items": { "type": "string" } }, "event_name": { "type": "string", "description": "The name of the Usage Event to record for. Corresponds with the `event_name` field on [Usage Events](/docs/api/billing/usage_events)." }, "id": { "type": "string", "description": "ID of the Meter object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "name": { "type": "string", "description": "Meter name." }, "updated_at": { "type": "string", "description": "Time when this meter was last updated." } } }, "CursorPaginationClientApiResponseMeter": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Meter" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "MeterSummary": { "required": [ "billing_customer_id", "event_count", "from_happened_at", "meter_id", "to_happened_at", "value" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the Billing Customer object." }, "dimension_values": { "type": "object", "additionalProperties": { "type": "string", "description": "A dimension value that this summary is broken down by." }, "description": "The event property keys and values this summary is broken down by. Only present when `grouped_by_dimensions` is specified in the request." }, "event_count": { "type": "integer", "description": "The number of usage events that contributed to the value.", "format": "int64" }, "from_happened_at": { "type": "string", "description": "Start time of the summary period (inclusive)." }, "meter_id": { "type": "string", "description": "ID of the Meter object." }, "to_happened_at": { "type": "string", "description": "End time of the summary period (exclusive)." }, "value": { "type": "number", "description": "The aggregated value based on the meter's aggregation type." } } }, "CursorPaginationClientApiResponseMeterSummary": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/MeterSummary" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "CursorPaginationClientApiResponsePaymentSource": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Billing_PaymentSource" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "CursorPaginationClientApiResponsePrice": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Price" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "CursorPaginationClientApiResponseProduct": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/ProductResponse" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "RateCard": { "required": [ "active", "created_at", "currency", "id", "meter_id", "name", "product_id", "recurring", "tax_included", "updated_at" ], "type": "object", "properties": { "active": { "type": "boolean", "description": "`true` if the rate card is available for new purchases, `false` otherwise." }, "created_at": { "type": "string", "description": "Time when this rate card was created." }, "currency": { "type": "string", "description": "Currency of the items of this rate card (in 3-letter ISO-4217 format)." }, "description": { "type": "string", "description": "Rate card description. Used for internal classification and identification." }, "id": { "type": "string", "description": "ID of the Rate Card object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "meter_id": { "type": "string", "description": "ID of the [Meter](/docs/api/billing/meters) object specifying how to calculate the usage for the items of this rate card." }, "name": { "type": "string", "description": "Rate card name." }, "product_id": { "type": "string", "description": "ID of the [Product](/docs/api/billing/products) object this rate card is associated with." }, "recurring": { "$ref": "#/components/schemas/SubscriptionRecurring", "description": "The frequency at which the items of this rate card are charged." }, "tax_included": { "type": "boolean", "description": "Whether the item prices include tax." }, "updated_at": { "type": "string", "description": "Time when this rate card was last updated." } }, "description": "Represents a versioned container for multi-dimensional pricing that groups multiple Rate Card Items by dimension combinations under a shared set of billing fields." }, "SubscriptionPaymentMethodSave": { "type": "object", "properties": { "mode": { "type": "string", "description": "Controls whether the payment method can be saved for future use. Possible values: `ENABLED`, `DISABLED`, or `COLLECT_CONSENT`.\n- `ENABLED`: The payment method will be saved for future use.\n- `DISABLED`: The payment method will not be saved.\n- `COLLECT_CONSENT`: The invoice UI asks the customer whether they want to save the payment method. Only applicable to cards." }, "next_triggered_by": { "type": "string", "description": "Indicates who will use the saved payment source to trigger future payments. One of `MERCHANT` or `CUSTOMER`.\nIf `MERCHANT`, a Payment Source is created for future use. If `CUSTOMER`, the payment method is saved only with the payment provider." } }, "description": "Settings that control whether and how a payment method provided by a customer while paying a subscription invoice is saved for future use." }, "SubscriptionPaymentOptions": { "type": "object", "properties": { "payment_method_types": { "type": "array", "description": "The payment methods and their order for display on the digital invoice pages of this Subscription. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`.", "items": { "type": "string", "description": "The payment methods and their order for display on the digital invoice pages of this Subscription. \nPossible enum values: `card`, `applepay`, `googlepay`, `alipaycn`, `alipayhk`, `dana`, `gcash`, `kakaopay`, `klarna`, `rabbit_line_pay`, `tng`, `truemoney`." } }, "payment_method_save": { "$ref": "#/components/schemas/SubscriptionPaymentMethodSave", "description": "Settings that control whether and how a payment method provided by a customer while paying a subscription invoice is saved for future use." } }, "description": "Payment settings applied to invoices generated by this Subscription. Only applicable when `collection_method` is `CHARGE_ON_CHECKOUT` or `AUTO_CHARGE`." }, "Subscription": { "required": [ "applied_discounts", "automatic_tax_status", "billing_customer_id", "cancel_at_period_end", "collection_method", "created_at", "currency", "days_until_due", "enable_automatic_tax", "id", "recurring", "starts_at", "status", "updated_at" ], "type": "object", "properties": { "applied_discounts": { "type": "array", "description": "List of the discounts that are applied to the Subscription. Discounts of subscription items are applied before the subscription discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "automatic_tax_status": { "type": "string", "description": "The automatic tax status of this subscription.", "enum": [ "APPLIED", "LOCATION_NOT_SUPPORTED", "LOCATION_NOT_REGISTERED_BY_MERCHANT", "ADDRESS_INCOMPLETE", "DISABLED" ], "x-enumDescriptions": { "APPLIED": "The automatic tax is applied.", "LOCATION_NOT_SUPPORTED": "Automatic tax calculation isn't supported in the customer's location.", "LOCATION_NOT_REGISTERED_BY_MERCHANT": "The merchant isn't registered to collect tax in the customer's location.", "ADDRESS_INCOMPLETE": "The customer address was insufficient or invalid to determine the correct tax.", "DISABLED": "The automatic tax is disabled." } }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who subscribes to this subscription." }, "billing_cycle_anchor_at": { "type": "string", "description": "A future timestamp in the first billing cycle as the reference point to align the future billing date." }, "cancel_at_period_end": { "type": "boolean", "description": "`true` if the subscription is scheduled to be cancelled at the end of the current billing period, `false` otherwise." }, "cancel_requested_at": { "type": "string", "description": "Time when the cancellation request was received." }, "collection_method": { "type": "string", "description": "Specify how payment is collected, one of `AUTO_CHARGE`, `CHARGE_ON_CHECKOUT` or `OUT_OF_BAND`." }, "created_at": { "type": "string", "description": "Time when the subscription was created." }, "currency": { "type": "string", "description": "The currency of the Subscription in 3-letter ISO-4217 format." }, "current_period_ends_at": { "type": "string", "description": "The end time of the current period that the subscription has been invoiced for." }, "current_period_starts_at": { "type": "string", "description": "The start time of the current period that the subscription has been invoiced for." }, "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due.", "format": "int32" }, "default_invoice_template": { "$ref": "#/components/schemas/SubscriptionDefaultInvoiceTemplate", "description": "Invoices for this subscription will be created using the specified settings." }, "default_tax_percent": { "maximum": 100, "minimum": 0, "type": "number", "description": "The tax percent between `0` and `100` to be applied to invoices to be generated. The tax will be exclusive." }, "duration": { "$ref": "#/components/schemas/SubscriptionDuration", "description": "The duration of the subscription." }, "enable_automatic_tax": { "type": "boolean", "description": "Whether automatic tax is enabled for this subscription. When enabled, the system attempts to calculate taxes for this subscription's invoice automatically." }, "ends_at": { "type": "string", "description": "Time when the subscription ended or scheduled to end." }, "id": { "type": "string", "description": "ID of the Subscription object." }, "latest_invoice_id": { "type": "string", "description": "The ID of the latest invoice generated for this subscription." }, "legal_entity_id": { "type": "string", "description": "ID of the legal entity to be used as billing entity. You can find this ID in the Airwallex web app > Settings." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "next_billing_at": { "type": "string", "description": "Time of the next billing date." }, "payment_options": { "$ref": "#/components/schemas/SubscriptionPaymentOptions", "description": "Payment settings applied to invoices generated by this Subscription. Only applicable when `collection_method` is `CHARGE_ON_CHECKOUT` or `AUTO_CHARGE`." }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) to pay for the subscription at each billing period. Required if `collection_method` is `AUTO_CHARGE`." }, "recurring": { "$ref": "#/components/schemas/SubscriptionRecurring", "description": "The frequency at which the price is charged. null for one-time charge." }, "starts_at": { "type": "string", "description": "Time when the subscription started or scheduled to start." }, "status": { "type": "string", "description": "Status of the subscription.", "enum": [ "PENDING", "IN_TRIAL", "ACTIVE", "UNPAID", "CANCELLED" ] }, "trial_ends_at": { "type": "string", "description": "The end time of the trial period if applicable." }, "trial_starts_at": { "type": "string", "description": "The start time of the trial period if applicable." }, "updated_at": { "type": "string", "description": "Time when the subscription was last updated." } } }, "CursorPaginationClientApiResponseSubscription": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Subscription" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "RateCardVersionWithRateCard": { "required": [ "created_at", "dimension_keys", "rate_card", "rate_card_id", "version" ], "type": "object", "properties": { "created_at": { "type": "string", "description": "Time when this rate card version was created." }, "dimension_keys": { "type": "array", "description": "Subset of or equal to the Meter's `dimension_keys`. Defines which dimension keys are used in each item's `dimension_values`. Append-only across versions — a new version's set must contain all keys from the previous version.", "items": { "type": "string" } }, "rate_card": { "$ref": "#/components/schemas/RateCard", "description": "The Rate Card this version belongs to." }, "rate_card_id": { "type": "string", "description": "ID of the Rate Card this version belongs to." }, "version": { "type": "integer", "description": "The version number within the Rate Card, starting from `1`.", "format": "int32" } }, "description": "The pinned Rate Card Version on a Subscription Item, including the associated Rate Card." }, "SubscriptionItem": { "required": [ "applied_discounts", "created_at", "id", "subscription_id", "updated_at" ], "type": "object", "properties": { "applied_discounts": { "type": "array", "description": "List of the discounts that are applied to the Subscription Item. Discounts of subscription items are applied before the subscription discounts.", "items": { "$ref": "#/components/schemas/DiscountResponse" } }, "created_at": { "type": "string", "description": "Time when the Subscription Item was created." }, "current_period_ends_at": { "type": "string", "description": "The end time of the current period that the subscription item has been invoiced for." }, "current_period_starts_at": { "type": "string", "description": "The start time of the current period that the subscription item has been invoiced for." }, "id": { "type": "string", "description": "ID of the Subscription Item object." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "price": { "$ref": "#/components/schemas/PriceWithProduct", "description": "The price on a Subscription Item. Mutually exclusive with `rate_card_version`." }, "quantity": { "type": "number", "description": "The quantity of the product.", "minimum": 1 }, "rate_card_version": { "$ref": "#/components/schemas/RateCardVersionWithRateCard", "description": "The pinned Rate Card Version on a Subscription Item. Mutually exclusive with `price`." }, "subscription_id": { "type": "string", "description": "ID of the Subscription object that this Subscription Item belongs to." }, "tax_percent": { "type": "number", "description": "The effective tax percent of this subscription item.", "maximum": 100, "minimum": 0 }, "updated_at": { "type": "string", "description": "Time when the Subscription Item was updated." } } }, "CursorPaginationClientApiResponseSubscriptionItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/SubscriptionItem" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "Transaction": { "required": [ "amount", "billing_customer_id", "created_at", "currency", "id", "status", "updated_at" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The total amount of this billing transaction." }, "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) who is making this Billing Transaction." }, "cancelled_at": { "type": "string", "description": "Time when this billing transaction was cancelled." }, "created_at": { "type": "string", "description": "Time when this billing transaction was created." }, "currency": { "type": "string", "description": "The currency of the Billing Transaction in 3-letter ISO-4217 format." }, "external_id": { "type": "string", "description": "ID of the [Payment Intent](/docs/api/payments/payment_intents) associated with the Billing Transaction when type is `PAYMENT`, or ID of the [Refund](/docs/api/payments/refunds) when type is `REFUND`." }, "id": { "type": "string", "description": "ID of the Billing Transaction object." }, "invoice_id": { "type": "string", "description": "ID of the [Invoice](/docs/api/billing/invoices) this billing transaction is associated with." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "out_of_band": { "type": "boolean", "description": "Returns true if the billing transaction was manually marked as succeeded, returns false if the transaction hasn't succeeded yet or was processed on Airwallex." }, "payment_source_id": { "type": "string", "description": "ID of the [Payment Source](/docs/api/billing/payment_sources) for which this billing transaction is made." }, "status": { "type": "string", "description": "Status of the billing transaction, one of `CREATED`, `SUCCEEDED`, `CANCELLED` and `FAILED`." }, "succeeded_at": { "type": "string", "description": "The time that the billing transaction succeeded." }, "type": { "type": "string", "description": "Type of the billing transaction. One of `PAYMENT` or `REFUND`." }, "updated_at": { "type": "string", "description": "Time when this billing transaction was last updated." }, "credit_note_id": { "type": "string", "description": "ID of the [Credit Note](/docs/api/billing/credit_notes) this Billing Transaction is associated with." } } }, "CursorPaginationClientApiResponseTransaction": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Transaction" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "UsageEvent": { "required": [ "billing_customer_id", "event_name", "happened_at", "ingested_at", "merchant_event_id", "properties", "voided" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) related to this usage event." }, "event_name": { "type": "string", "description": "The name of the event. Corresponds with the `event_name` field on a meter." }, "happened_at": { "type": "string", "description": "Time when this event happened.", "format": "date-time" }, "ingested_at": { "type": "string", "description": "Time when this usage event was ingested.", "format": "date-time" }, "merchant_event_id": { "type": "string", "description": "Unique identifier of this event in the merchant's system. Maximum length is 64." }, "properties": { "type": "object", "additionalProperties": { "type": "object", "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." }, "description": "The payload of events, which contains arbitrary key-value pairs storing properties of the event." }, "voided": { "type": "boolean", "description": "Indicates the status of the event. If `true`, it means the event has been voided and would not be counted into meter result calculation." }, "voided_at": { "type": "string", "description": "Time when this usage event was voided." } } }, "Billing_BillingCustomerSnapshot": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/CustomerAddress", "description": "Address of the billing customer." }, "email": { "type": "string", "description": "Email address of the billing customer." }, "name": { "type": "string", "description": "Name of the billing customer." }, "phone_number": { "type": "string", "description": "Phone number of the billing customer." }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the billing customer." }, "type": { "type": "string", "description": "Type of the billing customer.", "enum": [ "BUSINESS", "INDIVIDUAL" ], "x-enumDescriptions": { "BUSINESS": "A business entity billing customer.", "INDIVIDUAL": "An individual billing customer." } } }, "description": "Snapshot of the billing customer." }, "Billing_PrefilledCustomerData": { "type": "object", "properties": { "email": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The prefilled email of the customer.\nIf this field or a `billing_customer_id` with an email on file is provided, the email will be prefilled and will not be editable during checkout.\nIf neither is provided, Billing Checkout will prompt the customer to enter their email during the checkout process." }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "The prefilled name of the customer.\nIf this field or a `billing_customer_id` with a name on file is provided, the name will be prefilled and will not be editable during checkout.\nIf neither is provided, Billing Checkout will prompt the customer to enter their name during checkout." }, "type": { "type": "string", "description": "Type of the billing customer, one of `BUSINESS` or `INDIVIDUAL`.\nIf not provided, an \"I am purchasing as a business\" checkbox will be displayed during checkout for the customer to self-select." } }, "description": "The prefilled information of the customer. Only applicable when `billing_customer_id` is not provided. \nNot applicable in `SETUP` mode." }, "Billing_CustomerDataCollection": { "type": "object", "properties": { "billing_address": { "pattern": "^(AUTO|REQUIRED)$", "type": "string", "description": "Controls whether the billing address will be collected during checkout.\n- `AUTO`: Billing address will only be collected when necessary. Specifically, when automatic tax is enabled, or tax_id is collected.\n- `REQUIRED`: Billing address will always be collected.\nDefaults to `AUTO`." }, "tax_id": { "pattern": "^(DISABLED|OPTIONAL_IF_SUPPORTED|REQUIRED_IF_SUPPORTED)$", "type": "string", "description": "Controls whether the tax ID will be collected for business customer during checkout. One of `OPTIONAL_IF_SUPPORTED`, `DISABLED`, `REQUIRED_IF_SUPPORTED`.\n- `DISABLED`: Tax id will not be collected.\n- `OPTIONAL_IF_SUPPORTED`: Tax id will be optionally collected in the supported countries, by displaying a checkbox \"I am purchasing as business\".\n- `REQUIRED_IF_SUPPORTED`: Tax id will always be collected if the country is in the supported list.\nDefaults to `OPTIONAL_IF_SUPPORTED`." } }, "description": "Provides configuration for the Billing Checkout to collect information from customers." }, "Billing_HostedCompletionPage": { "required": [ "display" ], "type": "object", "properties": { "display": { "type": "boolean", "description": "Whether to display the Airwallex-hosted completion page after checkout is completed and before the customer is redirected to `success_url`." } }, "description": "Configuration for the Airwallex-hosted completion page. Only applicable when `ui_mode` is `HOSTED`." }, "Billing_InvoiceDataResponse": { "type": "object", "properties": { "days_until_due": { "type": "integer", "description": "Number of days from invoice finalization until payment is due.", "format": "int32" }, "default_tax_percent": { "type": "number", "description": "The tax rate between 0 and 100(%) to be applied to invoices to be generated. The tax will be exclusive. Defaults to 0.", "maximum": 100, "minimum": 0 }, "due_at": { "type": "string", "description": "Due date set by the merchant for this invoice, if any." }, "memo": { "type": "string", "description": "String used for merchants to share a custom message to their customers. Referenced as memo or invoice note in Webapp.", "maxLength": 200, "minLength": 0 }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of key-value pairs that you can attach to this object for storing additional information." } }, "description": "The settings of invoice to be passed to the invoice creation upon completion of the Billing Checkout in `PAYMENT` mode." }, "Billing_PaymentSource": { "required": [ "billing_customer_id", "created_at", "external_id", "id", "linked_payment_account_id", "updated_at" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "ID of the [Billing Customer](/docs/api/billing/billing_customers) that this Payment Source belongs to." }, "created_at": { "type": "string", "description": "Time when this Payment Source was created." }, "external_id": { "type": "string", "description": "ID of the [Payment Method](/docs/api/payments/payment_methods) associated with the Payment Source." }, "id": { "type": "string", "description": "ID of the Payment Source object." }, "linked_payment_account_id": { "type": "string", "description": "ID of the linked payment account to collect payment. You can find this ID in the Airwallex web app > Settings > Account details, within the Account Information section." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "updated_at": { "type": "string", "description": "Time when this Payment Source was last updated." } } }, "CoreBankingWalletBalance": { "type": "object", "properties": { "account_type": { "type": "string", "description": "Account Type. One of: `cash`, `yield`, or `credit`." }, "available_amount": { "type": "number", "description": "For account type **CASH**, Available balance. Customer deposits will be added to the available balance once processed, including any settled conversions bought in this currency\n\nFor account type **CREDIT**, the Available amount reflects the remaining credit you can use.\n\nFor account type **YIELD**, Total market value of all holdings." }, "currency": { "type": "string", "description": "Currency of the account balance." }, "pending_amount": { "type": "number", "description": "For account type **CASH**, amount that will become available once currency conversion(s) have been settled.\n\nFor account type **YIELD**, amount that will become available once Yield order(s) have been settled." }, "prepayment_amount": { "type": "number", "description": "Prepayment balance. Amount of money that is held in your Airwallex account as collateral for future transfer/conversion.\n\nFor account type **CASH** only." }, "reserved_amount": { "type": "number", "description": "Reserved balance. Amount of money that is held in your Airwallex account.\n\nFor account type **CASH**, consist of pending outbound payment.\n\nFor account type **CREDIT**, consist of card transactions authorized but not yet captured." }, "total_amount": { "type": "number", "description": "For account type **CASH**, Total account balance (Available + Pending + Reserved).\n\nFor account type **CREDIT**, the total outstanding balance on the credit account. Negative sign indicates the amount owed.\n\nFor account type **YIELD**, Total market value of all holdings. Equal to available amount." } } }, "CoreBankingBalanceHistory": { "type": "object", "properties": { "account_type": { "type": "string", "description": "Account Type. One of: `cash`, `yield`, or `credit`." }, "amount": { "type": "number", "description": "The amount of this balance change." }, "balance": { "type": "number", "description": "The balance after this balance change occurred.\n\nFor account type **CASH** and **YIELD**, tracks spendable amount.\n\nFor account type **CREDIT**, tracks utilized credit balance." }, "currency": { "type": "string", "description": "The currency of this balance change." }, "description": { "type": "string", "description": "The description for this balance change." }, "fee": { "type": "number", "description": "The fee amount occurred with same currency, the account who paid this fee will receive this field." }, "id": { "type": "string", "description": "The Unique identifier of the balance activity." }, "posted_at": { "type": "string", "description": "The time this change posted to balance." }, "reference": { "type": "string", "description": "Reference associated with the originating transaction. The value is derived from the appropriate reference field on the source transaction and may vary depending on the transaction type. See [`reference` mappings](/docs/banking-as-a-service/reporting/reporting-api/balance-history-mappings)." }, "source": { "type": "string", "description": "The unique identifier of the source transaction." }, "source_type": { "type": "string", "description": "The original transaction type. One of: `DEPOSIT`, `CONVERSION`, `PAYMENT`, `CHARGE`, `TRANSFER`, `ADJUSTMENT`, `FEE`, `ISSUING`, `PAYMENT_SETTLEMENT`, `PAYMENT_RESERVE`, `PAYMENT_REFUND`, `PAYMENT_REFUND_FAILED`, `DIRECT_DEBIT`, `PAYOUT`, `PURCHASE`, `BATCH_PAYOUT`, `YIELD`, `REPAYMENT`, `WITHHOLDING_TAX`." }, "transaction_type": { "type": "string", "description": "The transaction type of the balance history. One of: `PAYMENT`, `PRE_CHARGEBACK_ACCEPTED`, `REFUND_CHARGEBACK_RECEIVED`, `REFUND_CHARGEBACK_WITHDRAWN`, `SECOND_CAPTURE_WITHDRAWN`, `DISPUTE`, `SECOND_DISPUTE`, `DISPUTE_REVERSAL`, `DISPUTE_LOST`, `DISPUTE_WON`, `REFUND`, `REFUND_REVERSAL`, `REFUND_FAILURE`, `PAYMENT_RESERVE_HOLD`, `PAYMENT_RESERVE_RELEASE`, `PAYOUT`, `PAYOUT_FAILURE`, `PAYOUT_REVERSAL`, `CONVERSION_SELL`, `CONVERSION_BUY`, `CONVERSION_REVERSAL`, `DEPOSIT`, `DEPOSIT_REVERSAL`, `ADJUSTMENT`, `FEE`, `DD_CREDIT`, `DD_DEBIT`, `DC_CREDIT`, `DC_DEBIT`, `DC_DEBIT_REVERSAL`, `ISSUING_AUTHORISATION_HOLD`, `ISSUING_AUTHORISATION_RELEASE`, `ISSUING_CAPTURE`, `ISSUING_REFUND`, `SPLIT`, `SPLIT_REVERSAL`, `LENDER_FUNDS_BORROWED`, `LENDER_FUNDS_RETURNED`, `DIRECT_DEBIT`, `DIRECT_DEBIT_REVERSAL`, `HOLD`, `HOLD_RELEASE`, `RETURN_TO_FUNDING_SOURCE`, `PURCHASE`, `PURCHASE_REVERSAL`, `TRANSFER`, `PREPAYMENT`, `PREPAYMENT_RELEASE`, `REPAYMENT_DEDUCTION`, `REPAYMENT_FUNDING`, `TRANSFER_OUT`, `TRANSFER_IN`, `TRANSFER_OUT_REVERSAL`, `TRANSFER_IN_REVERSAL`, `WITHHOLDING_TAX`, `WITHHOLDING_TAX_REVERSAL`, `null`." } } }, "ProviderFailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "The original error code received from the local clearing system." }, "local_clearing_system": { "type": "string", "description": "The local clearing system used for the direct debit deposit. Possible values are `AU_BECS`, `US_ACH`, `GB_BACS`, `EU_SEPA`." }, "message": { "type": "string", "description": "The original error message received from the local clearing system." } }, "description": "A set of original information received from the local clearing system." }, "DepositFee": { "type": "object", "properties": { "amount": { "type": "number", "description": "Fee amount of this deposit." }, "currency": { "type": "string", "description": "Fee `currency` (3-letter ISO-4217 code) of this deposit." } }, "description": "Deposit fee." }, "BankAccountAUBsb": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bsb": { "type": "string", "description": "BSB code." } }, "description": "Australia BSB information." }, "BankAccountAUPayid": { "type": "object", "properties": { "account_identifier_type": { "type": "string", "description": "Identifier of PayID." }, "account_number": { "type": "string", "description": "Financial account number." }, "bsb": { "type": "string", "description": "BSB code." }, "payid": { "type": "string", "description": "Australian NPP PayID." } }, "description": "Australian NPP PayID information." }, "BankAccountBRBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "bankCode" }, "branch_code": { "type": "string", "description": "branchCode" }, "ispb": { "type": "string", "description": "ispb code." } }, "description": "Brazil bank code information." }, "BankAccountCAInstitutionNumber": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "institution_number": { "type": "string", "description": "Institution number." }, "transit_number": { "type": "string", "description": "Branch transit number." } }, "description": "Canada institution number information." }, "BankAccountCNCnapsCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "cnaps_code": { "type": "string", "description": "Cnaps code." } }, "description": "China cnaps code information." }, "BankAccountDKBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." } }, "description": "Denmark bank code information." }, "BankAccountGBSortCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "sort_code": { "type": "string", "description": "Sort code." } }, "description": "Greate Britain sort code information." }, "BankAccountHKBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_code": { "type": "string", "description": "Branch code." } }, "description": "Hong Kong bank code information." }, "BankAccountIban": { "type": "object", "properties": { "iban": { "type": "string", "description": "International Bank Account Number." } }, "description": "IBAN information." }, "BankAccountInstitution": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country of the institution (2-letter ISO 3166-2 country code)." }, "name": { "type": "string", "description": "Institution name." }, "swift_code": { "type": "string", "description": "Bank SWIFT code." } }, "description": "The institution of the financial account." }, "BankAccountJPBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_code": { "type": "string", "description": "Branch code." } }, "description": "Japan bank code information." }, "BankAccountKRBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_code": { "type": "string", "description": "Branch code." } }, "description": "Korea bank code information." }, "BankAccountMXBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_office_code": { "type": "string", "description": "Branch office code." }, "control_digit": { "type": "string", "description": "Control digit." } }, "description": "Mexico bank code information." }, "BankAccountNZBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_code": { "type": "string", "description": "Branch code." }, "suffix": { "type": "string", "description": "Financial account number suffix." } }, "description": "New Zealand bank code information." }, "BankAccountPartial": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code type value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." } }, "description": "Partial bank information." }, "BankAccountPHBankCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "bank_code": { "type": "string", "description": "Bank code." } }, "description": "Philippines bank code information." }, "BankAccountSwiftCode": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "swift_code": { "type": "string", "description": "SWIFT code." } }, "description": "SWIFT information." }, "BankAccountUSAch": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "ach": { "type": "string", "description": "ACH routing number." } }, "description": "United States ACH information." }, "BankAccountUSWire": { "type": "object", "properties": { "account_number": { "type": "string", "description": "Financial account number." }, "wire": { "type": "string", "description": "Wire routing number." } }, "description": "United States wire information." }, "DepositPayerBankAccount": { "type": "object", "properties": { "au_bsb": { "$ref": "#/components/schemas/BankAccountAUBsb", "description": "Australia BSB information." }, "au_payid": { "$ref": "#/components/schemas/BankAccountAUPayid", "description": "Australian NPP PayID information." }, "br_bank_code": { "$ref": "#/components/schemas/BankAccountBRBankCode", "description": "Brazil bank code information." }, "ca_institution_number": { "$ref": "#/components/schemas/BankAccountCAInstitutionNumber", "description": "Canada institution number information." }, "cn_cnaps_code": { "$ref": "#/components/schemas/BankAccountCNCnapsCode", "description": "China cnaps code information." }, "dk_bank_code": { "$ref": "#/components/schemas/BankAccountDKBankCode", "description": "Denmark bank code information." }, "gb_sort_code": { "$ref": "#/components/schemas/BankAccountGBSortCode", "description": "Greate Britain sort code information." }, "hk_bank_code": { "$ref": "#/components/schemas/BankAccountHKBankCode", "description": "Hong Kong bank code information." }, "iban": { "$ref": "#/components/schemas/BankAccountIban", "description": "IBAN information." }, "institution": { "$ref": "#/components/schemas/BankAccountInstitution", "description": "The institution of the financial account." }, "jp_bank_code": { "$ref": "#/components/schemas/BankAccountJPBankCode", "description": "Japan bank code information." }, "kr_bank_code": { "$ref": "#/components/schemas/BankAccountKRBankCode", "description": "Korea bank code information." }, "mx_bank_code": { "$ref": "#/components/schemas/BankAccountMXBankCode", "description": "Mexico bank code information." }, "name": { "type": "string", "description": "Financial account name." }, "nz_bank_code": { "$ref": "#/components/schemas/BankAccountNZBankCode", "description": "New Zealand bank code information." }, "partial": { "$ref": "#/components/schemas/BankAccountPartial", "description": "Partial bank information." }, "ph_bank_code": { "$ref": "#/components/schemas/BankAccountPHBankCode", "description": "Philippines bank code information." }, "swift_code": { "$ref": "#/components/schemas/BankAccountSwiftCode", "description": "SWIFT information." }, "type": { "type": "string", "description": "The type of the bank account identifier.", "enum": [ "AU_BSB", "AU_PAYID", "BR_BANK_CODE", "CA_INSTITUTION_NUMBER", "GB_SORT_CODE", "HK_BANK_CODE", "JP_BANK_CODE", "NZ_BANK_CODE", "US_ACH", "US_WIRE", "CN_CNAPS_CODE", "PARTIAL", "IBAN", "MX_BANK_CODE", "SWIFT_CODE", "KR_BANK_CODE", "DK_BANK_CODE", "PH_BANK_CODE" ] }, "us_ach": { "$ref": "#/components/schemas/BankAccountUSAch", "description": "United States ACH information." }, "us_wire": { "$ref": "#/components/schemas/BankAccountUSWire", "description": "United States wire information." } }, "description": "The bank account of the payer." }, "DepositPayerDigitalWallet": { "type": "object", "required": [ "account_name", "provider" ], "properties": { "account_name": { "type": "string", "description": "Account holder name of the payer's digital wallet." }, "id_type": { "type": "string", "description": "Account identifier type of the payer's digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the payer's digital wallet." }, "provider": { "type": "string", "description": "Service provider of the payer's digital wallet." } }, "description": "The digital wallet of the payer." }, "DepositStablecoinWallet": { "type": "object", "properties": { "address": { "type": "string", "description": "The blockchain address of the sender." }, "asset": { "type": "string", "description": "The stablecoin asset." }, "network": { "type": "string", "description": "The blockchain network." } }, "description": "Stablecoin wallet details for the payer." }, "DepositPayer": { "type": "object", "properties": { "bank_account": { "$ref": "#/components/schemas/DepositPayerBankAccount", "description": "The bank account of the payer." }, "country_code": { "type": "string", "description": "Country of the payer (2-letter ISO 3166-2 country code)." }, "digital_wallet": { "$ref": "#/components/schemas/DepositPayerDigitalWallet", "description": "The digital wallet of the payer." }, "name": { "type": "string", "description": "The name of the payer." }, "stablecoin_wallet": { "$ref": "#/components/schemas/DepositStablecoinWallet", "description": "The stablecoin wallet of the payer." } }, "description": "The payer of this transfer deposit." }, "DepositDtoV2": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of this deposit." }, "created_at": { "type": "string", "description": "The date time in ISO8601 format when this deposit was created." }, "currency": { "type": "string", "description": "The `currency` (3-letter ISO-4217 code) of this deposit." }, "estimated_settled_at": { "type": "string", "description": "Estimated settlement time of this deposit. With ISO8601 format." }, "failure_details": { "$ref": "#/components/schemas/Core_Resources_FailureDetails", "description": "Empty unless the deposit is in a failure status (`REJECTED`, `REVERSED`)." }, "fee": { "$ref": "#/components/schemas/DepositFee", "description": "Deposit fee." }, "funding_source_id": { "type": "string", "description": "Funding Source unique identifier of this deposit. Applies to `DIRECT_DEBIT` deposit type. This is the same as your Linked Account unique identifier." }, "global_account_id": { "type": "string", "description": "Global Account unique identifier of this deposit. Applies to `BANK_TRANSFER` deposit type. Nullable for deposits via DBS_HK GA." }, "id": { "type": "string", "format": "uuid", "description": "A unique identifier of this deposit." }, "payer": { "$ref": "#/components/schemas/DepositPayer", "description": "The payer of this transfer deposit." }, "provider_transaction_id": { "type": "string", "description": "The unique identifier on this deposit provided by the banking provider. Duplicates may occur in edge cases." }, "reference": { "type": "string", "description": "A user specific reference that will be displayed to the bank account owner on the bank statement." }, "settled_at": { "type": "string", "description": "Actual settlement time of this deposit. With ISO8601 format." }, "status": { "type": "string", "description": "Status of this deposit.", "enum": [ "PENDING", "SETTLED", "REJECTED", "REVERSED" ] }, "type": { "type": "string", "description": "Type of this deposit.", "enum": [ "BANK_TRANSFER", "DIRECT_DEBIT", "DIGITAL_WALLET_TRANSFER", "AGGREGATE_FUNDS", "STABLECOIN_TRANSFER" ] } } }, "DirectDebit": { "required": [ "amount", "created_at", "currency", "global_account_id", "transaction_id" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of this direct debit." }, "created_at": { "type": "string", "description": "The timestamp this direct debit was created.", "format": "date-time" }, "currency": { "type": "string", "description": "The currency (3-letter ISO-4217 code) of this direct debit." }, "transaction_id": { "type": "string", "description": "A unique id of this direct debit." }, "global_account_id": { "type": "string", "description": "The global account id of this direct debit." }, "status": { "type": "string", "description": "The status of direct debit transaction.", "enum": [ "NEW", "IN_REVIEW", "PENDING", "SETTLED", "REJECTED", "RETURNED" ] }, "debtor_name": { "type": "string", "description": "The debtor's name of this direct debit." }, "statement_ref": { "type": "string", "description": "The statement reference of this direct debit." }, "mandate_id": { "type": "string", "description": "The unique identifier of the related mandate." } }, "description": "Paged results." }, "NextActionForGaAlias": { "type": "object", "required": [ "type" ], "properties": { "expires_at": { "type": "string", "description": "The expiration time of the verification code in ISO8601 format." }, "remaining_attempts": { "type": "integer", "format": "int32", "description": "Remaining attempts you have to submit the verification code. When this reaches 0, the code becomes invalid and you must call [Request new verification code for an alias](/docs/api/core_resources/global_accounts/aliases/request_new_verification_code) to generate a new one." }, "type": { "type": "string", "description": "Type of action to be taken.", "enum": [ "submit_verification_code", "request_new_verification_code", "complete_port" ] } }, "description": "Details of the next action to be taken." }, "GlobalAccountAliasClient": { "type": "object", "required": [ "global_account_id", "id", "local_clearing_system", "request_id", "status", "type", "value" ], "properties": { "global_account_id": { "type": "string", "description": "Global account ID." }, "id": { "type": "string", "description": "Alias ID." }, "local_clearing_system": { "type": "string", "description": "Local clearing system to be registered with.", "enum": [ "NPP" ] }, "next_action": { "$ref": "#/components/schemas/NextActionForGaAlias", "description": "Details of the next action to be taken." }, "reason": { "type": "string", "description": "Explanation for the status of the Alias. If there are no additional details, we will return null." }, "request_id": { "type": "string", "description": "Unique request ID specified in the request." }, "status": { "type": "string", "description": "Alias status.", "enum": [ "REQUIRES_ACTION", "PROCESSING", "ACTIVE", "PORT_INITIATED", "PORTED", "CANCELLATION_REQUESTED", "CANCELLED", "FAILED", "SUSPENSION_REQUESTED", "SUSPENDED" ] }, "type": { "type": "string", "description": "Alias type.", "enum": [ "EMAIL", "PHONE_NUMBER", "AUSTRALIAN_BUSINESS_NUMBER" ] }, "value": { "type": "string", "description": "Alias value." } } }, "PagedGlobalAccountAliasClient": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/GlobalAccountAliasClient" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "AlternateAccountIdentifiers": { "type": "object", "properties": { "email": { "type": "string", "description": "Applicable only for CA Global Accounts. [Supported Formats](/docs/global-treasury/get-started/global-accounts/manage-global-accounts#supported-email-format-under-alternate_account_identifiers)." } }, "description": "For a specific local clearing system, this serves as the unique alternate identifier for a global account." }, "ClientInstitution": { "type": "object", "required": [ "address", "city", "name" ], "properties": { "address": { "type": "string", "description": "Financial institution address line." }, "branch_name": { "type": "string", "description": "Financial institution branch name." }, "city": { "type": "string", "description": "Financial institution city/town." }, "name": { "type": "string", "description": "Financial institution in which your account is domiciled." }, "zip_code": { "type": "string", "description": "Financial institution zip code." } }, "description": "Details of the Financial institution of your global account." }, "GlobalAccountRequiredFeature": { "type": "object", "required": [ "currency" ], "properties": { "currency": { "type": "string", "description": "Currency of the global account (3-letter ISO-4217 code)." }, "transfer_method": { "type": "string", "description": "Transfer method in which a deposit can be received for the specified currency. Possible transfer methods are: `LOCAL`, `SWIFT`. Not applicable for stablecoin global accounts — field is absent from JSON for stablecoin entries." } } }, "ClientRoutingCode": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "Routing code type.", "enum": [ "ach", "bsb", "sort_code", "bank_code", "branch_code", "fedwire", "fedNow", "rtp", "transit_number", "institution_number", "swift", "citad_bank_code", "cnpj" ] }, "value": { "type": "string", "description": "Routing code value." } } }, "GlobalAccountSupportedFeature": { "type": "object", "required": [ "currency", "routing_codes", "type" ], "properties": { "alias_types": { "type": "array", "description": "Alias types that can be registered with the local clearing system via [Create alias](/docs/api/core_resources/global_accounts/create_aliases).", "items": { "type": "string", "enum": [ "EMAIL", "PHONE_NUMBER", "AUSTRALIAN_BUSINESS_NUMBER" ] } }, "currency": { "type": "string", "description": "Currency of the global account (3-letter ISO-4217 code)." }, "local_clearing_system": { "type": "string", "description": "Supported local clearing system.", "enum": [ "BANK_TRANSFER", "NPP", "OSKO", "DIRECT_ENTRY_TRANSFER", "BECS", "PAYTO", "EFT", "INTERAC", "SEPA", "SEPA_INSTANT", "TARGET2", "INTRADAGCLEARING", "KRONOS2", "STRAKSCLEARING", "BACS", "CHAPS", "FASTER_PAYMENTS", "ACH", "FPS", "RTGS", "ATM_PRIMA", "BI_FAST", "IPI", "SKN", "ZENGIN", "HOFINET", "SPEI", "DUITNOW", "GIRO", "RENTAS", "ELIXIR", "EXPRESS_ELIXIR", "SORBNET", "FAST", "FEDWIRE", "FEDNOW", "ZAHAV", "MASAV", "NAPAS", "CITAD", "TED", "PIX", "RTP", "INSTAPAY", "PESONET" ] }, "routing_codes": { "type": "array", "description": "Routing information.", "items": { "$ref": "#/components/schemas/ClientRoutingCode" } }, "transfer_method": { "type": "string", "description": "Transfer method in which a deposit can be received or a direct debit can be initiated. Not applicable for stablecoin global accounts — field is absent from JSON for stablecoin entries.", "enum": [ "LOCAL", "SWIFT" ] }, "type": { "type": "string", "description": "Type of the supported feature.", "enum": [ "DEPOSIT", "DIRECT_DEBIT" ] } } }, "GlobalAccountClient": { "type": "object", "required": [ "account_name", "country_code", "id", "institution", "required_features", "status", "supported_features" ], "properties": { "account_name": { "type": "string", "description": "Global account name." }, "account_number": { "type": "string", "description": "Global account number (fiat). For stablecoin global accounts this field is omitted, use stablecoin_address for the deposit wallet." }, "account_type": { "type": "string", "description": "Account type of the financial institution account.", "enum": [ "Checking", "Saving", "Current", "Payment" ] }, "alternate_account_identifiers": { "$ref": "#/components/schemas/AlternateAccountIdentifiers", "description": "For a specific local clearing system, this serves as the unique alternate identifier for a global account." }, "close_reason": { "type": "string", "description": "Global Account closure reason." }, "country_code": { "type": "string", "description": "Country of the global account specified in the request (2-letter ISO 3166-2 country code)." }, "deposit_conversion_currency": { "type": "string", "description": "Target currency that incoming funds will be converted to. Applicable only when Global Account country is ID. [Supported currencies](/docs/transactional-fx/supported-regions-and-currencies) (3-letter ISO-4217 code)." }, "failure_reason": { "type": "string", "description": "Global Account failure reason." }, "iban": { "type": "string", "description": "IBAN number." }, "id": { "type": "string", "description": "Global account unique identifier." }, "institution": { "$ref": "#/components/schemas/ClientInstitution", "description": "Details of the Financial institution of your global account." }, "nick_name": { "type": "string", "description": "Nickname of the global account ." }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request." }, "required_features": { "type": "array", "description": "Required features when creating the global account.", "items": { "$ref": "#/components/schemas/GlobalAccountRequiredFeature" } }, "status": { "type": "string", "description": "Status of global account.", "enum": [ "ACTIVE", "CLOSED", "PROCESSING", "FAILED" ] }, "supported_features": { "type": "array", "description": "Supported features of your global account.", "items": { "$ref": "#/components/schemas/GlobalAccountSupportedFeature" } }, "swift_code": { "type": "string", "description": "Bank SWIFT code." } } }, "ActiveGlobalAccount": { "type": "object", "required": [ "account_name", "country_code", "id", "institution", "required_features", "status", "supported_features" ], "properties": { "account_name": { "type": "string", "description": "Global account name." }, "account_number": { "type": "string", "description": "Global account number." }, "account_type": { "type": "string", "description": "Account type of the financial institution account.", "enum": [ "Checking", "Saving", "Current", "Payment" ] }, "alternate_account_identifiers": { "$ref": "#/components/schemas/AlternateAccountIdentifiers", "description": "For a specific local clearing system, this serves as the unique alternate identifier for a global account." }, "country_code": { "type": "string", "description": "Country of the global account specified in the request (2-letter ISO 3166-2 country code)." }, "deposit_conversion_currency": { "type": "string", "description": "Target currency that incoming funds will be converted to. Applicable only when Global Account country is ID. [Supported currencies](/docs/transactional-fx/supported-regions-and-currencies) (3-letter ISO-4217 code)." }, "iban": { "type": "string", "description": "IBAN number." }, "id": { "type": "string", "description": "Global account unique identifier." }, "institution": { "$ref": "#/components/schemas/ClientInstitution", "description": "Details of the Financial institution of your global account." }, "nick_name": { "type": "string", "description": "Nickname of the global account ." }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request." }, "required_features": { "type": "array", "description": "Required features when creating the global account.", "items": { "$ref": "#/components/schemas/GlobalAccountRequiredFeature" } }, "status": { "type": "string", "description": "Status of global account. One of `ACTIVE`, `PROCESSING` is returned." }, "supported_features": { "type": "array", "description": "Supported features of your global account.", "items": { "$ref": "#/components/schemas/GlobalAccountSupportedFeature" } }, "swift_code": { "type": "string", "description": "Bank SWIFT code." } } }, "PagedGlobalAccount": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/GlobalAccountClient" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "DirectDebitOutMandate": { "type": "object", "required": [ "created_at", "creditor_name", "currency", "debtor_name", "global_account_id", "id", "payment_scheme", "setup_time", "status" ], "properties": { "created_at": { "type": "string", "description": "Time when the mandate was created in Airwallex." }, "creditor_name": { "type": "string", "description": "Creditor who receives the direct debit payout under the mandate." }, "currency": { "type": "string", "description": "Currency supported by the mandate." }, "debtor_name": { "type": "string", "description": "Debtor who pays the direct debit payout under the mandate." }, "global_account_id": { "type": "string", "description": "The unique identifier of the Global Account with the mandate." }, "id": { "type": "string", "description": "The unique identifier of the mandate." }, "payment_scheme": { "type": "string", "description": "Payment scheme associated with the mandate." }, "setup_time": { "type": "string", "description": "The time when the mandate was lodged, format should be “yyyy-MM-dd’T’HH:mm:ssXXX”." }, "status": { "type": "string", "description": "Status of the mandate, possible values should be `ACTIVE`, `CANCELLED`." } } }, "GlobalAccountTransaction": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "Amount of the transaction in `transaction currency`." }, "create_time": { "type": "string", "description": "The time of the transaction created." }, "currency": { "type": "string", "description": "Currency of the transaction (3-letter ISO-4217 code)." }, "description": { "type": "string", "description": "Description of the transaction." }, "fee_amount": { "type": "number", "description": "Fee amount of the transaction in `transaction currency`." }, "fee_currency": { "type": "string", "description": "Fee currency of the transaction (3-letter ISO-4217 code)." }, "id": { "type": "string", "format": "uuid", "description": "Unique id of the transaction." }, "payer_country": { "type": "string", "description": "Payer country code of the transaction (2-letter ISO 3166-2 country code).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "payer_name": { "type": "string", "description": "Payer name of the transaction." }, "status": { "type": "string", "description": "Status of the transaction.", "enum": [ "PENDING", "SETTLED", "REJECTED", "CANCELLED" ] }, "type": { "type": "string", "description": "Type of the transaction.", "enum": [ "DEBIT", "CREDIT" ] } } }, "EgiroAuth": { "type": "object", "properties": { "auth_url": { "type": "string", "description": "The EGIRO Auth Link to authorize." } }, "description": "Required information to proceed with EGIRO authentication." }, "PlaidAuth": { "type": "object", "properties": { "expires_at": { "type": "string", "description": "The expiration time of the Link Token in ISO8601 format." }, "link_token": { "type": "string", "description": "The Plaid Link Token to open a Plaid Modal." } }, "description": "Required information to proceed with Plaid authentication." }, "TruelayerAuth": { "type": "object", "properties": { "auth_url": { "type": "string", "description": "The Truelayer Auth Link to authorize." } }, "description": "Required information to proceed with Truelayer authentication." }, "LinkedAccountAuth": { "type": "object", "properties": { "egiro": { "$ref": "#/components/schemas/EgiroAuth", "description": "Required information to proceed with EGIRO authentication." }, "plaid": { "$ref": "#/components/schemas/PlaidAuth", "description": "Required information to proceed with Plaid authentication." }, "truelayer": { "$ref": "#/components/schemas/TruelayerAuth", "description": "Required information to proceed with Truelayer authentication." }, "type": { "type": "string", "description": "The type of verification that has been generated.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } } }, "Unit": { "type": "object" }, "AUBank": { "type": "object", "required": [ "account_name", "account_number", "bsb", "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "bsb": { "type": "string", "description": "BSB code." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } }, "description": "Australia bank information." }, "AUPayid": { "type": "object", "required": [ "account_identifier_type", "currency", "entity_type", "payid" ], "properties": { "account_identifier_type": { "type": "string", "description": "Identifier of PayID.", "enum": [ "EMAIL_ADDRESS", "PHONE_NUMBER", "ABN", "ACN", "ARBN", "ARSN", "ORGANISATION_IDENTIFIER" ] }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "payid": { "type": "string", "description": "Australia NPP PayID." } }, "description": "Australia NPP PayID information." }, "CABank": { "type": "object", "required": [ "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "institution_number": { "type": "string", "description": "Institution number." }, "transit_number": { "type": "string", "description": "Branch transit number." } }, "description": "Canada bank information." }, "LinkedAccountCapability": { "type": "object", "properties": { "balance_check": { "type": "boolean", "description": "Whether the Linked Account supports balance checking." }, "direct_debit_deposit": { "type": "boolean", "description": "Whether the Linked Account supports direct debit deposit." } }, "description": "Capabilities of the Linked Account." }, "EUBank": { "type": "object", "required": [ "account_name", "currency", "entity_type", "iban", "swift_code" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "iban": { "type": "string", "description": "International Bank Account Number." }, "swift_code": { "type": "string", "description": "SWIFT code." } }, "description": "Europe bank information." }, "LAProviderFailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "The original error code received from the local clearing system." }, "local_clearing_system": { "type": "string", "description": "The local clearing system that reported the failure." }, "message": { "type": "string", "description": "The original error message received from the local clearing system." } }, "description": "A set of original information received from the local clearing system." }, "LAFailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code." }, "iso_code": { "type": "string", "description": "Error code [ISO 20022](https://www.iso20022.org/about-iso-20022)." }, "provider_failure_details": { "$ref": "#/components/schemas/LAProviderFailureDetails", "description": "A set of original information received from the local clearing system." } }, "description": "Empty unless the Linked Account is in a failure status (`REQUIRES_ACTION`, `FAILED`)." }, "GBBank": { "type": "object", "required": [ "account_name", "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "sort_code": { "type": "string", "description": "Sort code." } }, "description": "Great Britain bank information." }, "HKBank": { "type": "object", "required": [ "account_name", "account_number", "bank_code", "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } }, "description": "Hong Kong bank information." }, "CandidateAccount": { "type": "object", "properties": { "account_identity": { "type": "string", "description": "The unique identifier of the candidate account." }, "bank_country_code": { "type": "string", "description": "Two-letter [ISO 3166-2](http://en.wikipedia.org/wiki/ISO_3166-2) country code.", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "currency": { "type": "string", "description": "Three-letter [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "financial_institution_name": { "type": "string", "description": "The financial institution name of the candidate account." }, "iban": { "type": "string", "description": "International Bank Account Number." }, "name": { "type": "string", "description": "The name of the candidate account." }, "number": { "type": "string", "description": "The number of the candidate account." }, "sort_code": { "type": "string", "description": "Sort code." }, "type": { "type": "string", "description": "The verification type for your external account.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } } }, "NZBank": { "type": "object", "required": [ "account_name", "account_number", "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "bank_code": { "type": "string", "description": "Bank code." }, "branch_code": { "type": "string", "description": "Branch code." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } }, "description": "New Zealand bank information." }, "SGBank": { "type": "object", "required": [ "account_name", "account_number", "currency", "entity_type", "swift_code" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "swift_code": { "type": "string", "description": "SWIFT code." } }, "description": "Singapore bank information." }, "USBank": { "type": "object", "required": [ "currency", "entity_type" ], "properties": { "account_name": { "type": "string", "description": "Name of the external bank account owner." }, "account_number": { "type": "string", "description": "External bank account number." }, "account_type": { "type": "string", "description": "External bank account type.", "enum": [ "CHECKING", "SAVINGS" ] }, "ach": { "type": "string", "description": "ACH routing number." }, "currency": { "type": "string", "description": "Currency of your bank account.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "entity_type": { "type": "string", "description": "Type of entity which owns this external bank account.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "fedwire": { "type": "string", "description": "FEDWIRE routing number." } }, "description": "United States bank information." }, "LinkedAccount": { "type": "object", "required": [ "id", "status", "supported_currencies", "type" ], "properties": { "au_bank": { "$ref": "#/components/schemas/AUBank", "description": "Australia bank information." }, "au_payid": { "$ref": "#/components/schemas/AUPayid", "description": "Australia NPP PayID information." }, "ca_bank": { "$ref": "#/components/schemas/CABank", "description": "Canada bank information." }, "capabilities": { "$ref": "#/components/schemas/LinkedAccountCapability", "description": "Capabilities of the Linked Account." }, "eu_bank": { "$ref": "#/components/schemas/EUBank", "description": "Europe bank information." }, "failure_details": { "$ref": "#/components/schemas/LAFailureDetails", "description": "Empty unless the Linked Account is in a failure status (`REQUIRES_ACTION`, `FAILED`)." }, "gb_bank": { "$ref": "#/components/schemas/GBBank", "description": "Great Britain bank information." }, "hk_bank": { "$ref": "#/components/schemas/HKBank", "description": "Hong Kong bank information." }, "id": { "type": "string", "format": "uuid", "description": "A unique identifier of this Linked Account." }, "next_action": { "$ref": "#/components/schemas/Core_Resources_NextAction", "description": "Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null." }, "nz_bank": { "$ref": "#/components/schemas/NZBank", "description": "New Zealand bank information." }, "reason": { "type": "string", "description": "Explanation for the status of the Linked Account. If there are no additional details, we will return null." }, "sg_bank": { "$ref": "#/components/schemas/SGBank", "description": "Singapore bank information." }, "status": { "type": "string", "description": "The status of the Linked Account.", "enum": [ "REQUIRES_ACTION", "PROCESSING", "SUCCEEDED", "FAILED", "SUSPENDED" ] }, "supported_currencies": { "type": "array", "description": "A list of currencies supported by this Linked Account.", "items": { "type": "string", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] } }, "type": { "type": "string", "description": "Type of Linked Account.", "enum": [ "AU_BANK", "NZ_BANK", "US_BANK", "GB_BANK", "EU_BANK", "HK_BANK", "SG_BANK", "CA_BANK", "AU_PAYID" ] }, "us_bank": { "$ref": "#/components/schemas/USBank", "description": "United States bank information." } } }, "LinkedAccountBalance": { "type": "object", "properties": { "available_amount": { "type": "number", "description": "Amount of your available balance." }, "currency": { "type": "string", "description": "Currency of your available balance (3-letter ISO-4217 code)." } } }, "MandateSchedule": { "type": "object", "required": [ "period", "period_unit" ], "properties": { "period": { "type": "integer", "format": "int32", "description": "The number of period units between recurring transaction cycles. For example, the transaction cycle is every quarter if period = 3 and period_unit = MONTH." }, "period_unit": { "type": "string", "description": "Specifies transaction frequency.", "enum": [ "DAY", "WEEK", "MONTH", "YEAR" ] } }, "description": "The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited." }, "MandateTransactionControl": { "type": "object", "properties": { "amount_type": { "type": "string", "enum": [ "VARIABLE", "FIXED" ], "x-enumDescriptions": { "VARIABLE": "Amount to be paid from the Linked Account is variable. A max_amount_per_transaction is recommended.", "FIXED": "Amount to be paid from the Linked Account is fixed. A specific fixed_amount_per_transaction is required." } }, "end_date": { "type": "string", "description": "End date to expect to be paid from the Linked Account." }, "fixed_amount_per_transaction": { "type": "number", "description": "The fixed amount that may be paid from the Linked Account, per transaction." }, "max_amount_per_transaction": { "type": "number", "description": "Maximum amount that may be paid from the Linked Account, per transaction." }, "schedule": { "$ref": "#/components/schemas/MandateSchedule", "description": "The schedule for recurring transaction cycles. If no schedule is provided, the number of transactions allowed will be unlimited." } }, "description": "Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT." }, "Core_Resources_Address": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Address where the business operates and conducts its activities." }, "Core_Resources_FailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "iso_code": { "type": "string", "description": "Error code [ISO 20022](https://www.iso20022.org/about-iso-20022) (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "provider_failure_details": { "$ref": "#/components/schemas/ProviderFailureDetails", "description": "A set of original information received from the local clearing system." } }, "description": "Empty unless the deposit is in a failure status (`REJECTED`, `REVERSED`)." }, "Core_Resources_NextAction": { "type": "object", "required": [ "micro_deposit_count", "remaining_attempts", "type", "verification_type" ], "properties": { "candidate_accounts": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateAccount" } }, "micro_deposit_count": { "type": "integer", "format": "int32", "description": "Number of microdeposits sent to the linked bank account." }, "remaining_attempts": { "type": "integer", "format": "int32", "description": "Remaining attempts you have to enter the correct microdeposit amount. When this becomes 0, account status will update to FAILED." }, "type": { "type": "string", "description": "Type of action to be taken.", "enum": [ "verify_micro_deposits", "confirm_account", "auth", "update_mandate", "external_authorize", "external_unsuspend_mandate" ] }, "verification_type": { "type": "string", "description": "The verification type that should be taken to refresh the Linked Account authentication.", "enum": [ "PLAID", "TRUELAYER", "EGIRO", "BASIQ" ] } }, "description": "Details of the next action to be taken to activate the Linked Account. For all statuses other than REQUIRES_ACTION, will return as null." }, "Core_Resources_Mandate": { "type": "object", "required": [ "accepted_at", "email", "signatory", "status", "type", "version" ], "properties": { "accepted_at": { "type": "string", "format": "date-time", "description": "Timestamp of the mandate signing." }, "address": { "$ref": "#/components/schemas/Core_Resources_Address", "description": "Address of the signatory." }, "controls": { "$ref": "#/components/schemas/MandateTransactionControl", "description": "Set of characteristics defining the mandate. Controls how Direct Debit can be initiated. Only applicable if mandate type is AU_PAYTO_DEBIT." }, "email": { "type": "string", "description": "Email of the signatory. A pdf copy of the mandate will be shared to this address. Required if you are not reusing mandate." }, "reference": { "type": "string", "description": "It is useful for GB linked accounts only. The reference that was used during creation." }, "signatory": { "type": "string", "description": "Name of the signatory of this mandate. This should be the external account owner. Required if you are not reusing mandate." }, "status": { "type": "string", "description": "Status of the mandate.", "enum": [ "PROCESSING", "ACTIVE", "INACTIVE" ] }, "type": { "type": "string", "description": "Type of the source of your funds.", "enum": [ "AU_BECS_DEBIT", "US_ACH_DEBIT", "US_FEDWIRE_DEBIT", "GB_BACS_DEBIT", "EU_SEPA_DEBIT", "CA_EFT_DEBIT", "HK_FPS_DEBIT", "SG_EGIRO_DEBIT", "AU_PAYTO_DEBIT", "NZ_BECS_DEBIT" ] }, "version": { "type": "string", "description": "Version of the mandate signed. Required if you are not reusing mandate." } } }, "CoreBankingFinancialReportParameters": { "type": "object", "properties": { "currencies": { "type": "array", "description": "Currencies included in the report.", "items": { "type": "string" } }, "from_date": { "type": "string", "description": "Start date of the report (inclusive)." }, "time_zone": { "type": "string", "description": "Timezone of the user." }, "to_date": { "type": "string", "description": "End date of the report (inclusive)." }, "transaction_types": { "type": "array", "description": "Transaction types included in the report.", "items": { "type": "string" } } }, "description": "Parameters used to generate report." }, "CoreBankingFinancialReportRes": { "type": "object", "properties": { "file_format": { "type": "string", "description": "File format of the report. One of `CSV`, `PDF`, `EXCEL`." }, "file_name": { "type": "string", "description": "File name." }, "id": { "type": "string", "description": "Unique identifier of the financial report." }, "report_expires_at": { "type": "string", "description": "Contents expiration date. Will be empty string if report is in `PENDING` state or the report does not expire." }, "report_parameters": { "$ref": "#/components/schemas/CoreBankingFinancialReportParameters", "description": "Parameters used to generate report." }, "report_version": { "type": "string", "description": "Version of the report." }, "status": { "type": "string", "description": "Status of the report.", "enum": [ "COMPLETED", "FAILED", "PENDING" ] }, "type": { "type": "string", "enum": [ "ACCOUNT_STATEMENT_REPORT", "AGGREGATED_SETTLEMENT_REPORT", "BALANCE_ACTIVITY_REPORT", "ONLINE_PAYMENTS_TRANSACTION_REPORT", "SETTLEMENT_REPORT", "TRANSACTION_RECON_REPORT" ] } } }, "CoreBankingFinancialTransaction": { "type": "object", "properties": { "amount": { "type": "number", "description": "Gross amount the transaction." }, "batch_id": { "type": "string", "description": "The batch unique identifier of the settlement that the transaction belongs to." }, "client_rate": { "type": "number", "description": "The client rate for the transaction." }, "created_at": { "type": "string", "format": "date-time", "description": "The time this transaction was created at." }, "currency": { "type": "string", "description": "Currency the transaction should be made in (3-letter ISO-4217 code)." }, "currency_pair": { "type": "string", "description": "The currency pair that the `client_rate` is quoted in." }, "description": { "type": "string", "description": "The description of the transaction." }, "estimated_settled_at": { "type": "string", "format": "date-time", "description": "The time when the transaction will be settled at." }, "fee": { "type": "number", "description": "Fee paid for the transaction." }, "funding_source_id": { "type": "string", "description": "The unique identifier of the funding source from which the transaction originated." }, "id": { "type": "string", "description": "Unique identifier of the transaction." }, "net": { "type": "number", "description": "Net amount of the transaction." }, "settled_at": { "type": "string", "format": "date-time", "description": "The time when the transaction was settled at." }, "source_id": { "type": "string", "description": "The source unique identifier of the transaction." }, "source_type": { "type": "string", "description": "The type of the source transaction, One of `PAYOUT`, `CONVERSION`, `DEPOSIT`, \n `ADJUSTMENT`, `FEE`, `PAYMENT_ATTEMPT`, `REFUND`, `DISPUTE`, `CHARGE`, `TRANSFER`, `YIELD`, \n `BATCH_PAYOUT`, `CARD_PURCHASE`, `CARD_REFUND`, `PURCHASE`, `REFUND_REVERSAL`, `REPAYMENT`, `TRANSFER_OUT`, `TRANSFER_IN`, `TRANSFER_OUT_REVERSAL`, `TRANSFER_IN_REVERSAL`, `WITHHOLDING_TAX`." }, "status": { "type": "string", "description": "One of `PENDING`, `SETTLED`, `CANCELLED` ." }, "transaction_type": { "type": "string", "description": "The type of the transaction, One of `DISPUTE`,\n `DISPUTE_REVERSAL`, `DISPUTE_LOST`, `REFUND`, `REFUND_REVERSAL`,`REFUND_FAILURE`,\n `PAYMENT_RESERVE_HOLD`,`PAYMENT_RESERVE_RELEASE`,`PAYOUT`,`PAYOUT_FAILURE`,\n `PAYOUT_REVERSAL`, `CONVERSION_SELL`, `CONVERSION_BUY`, `CONVERSION_REVERSAL`,\n `DEPOSIT`, `ADJUSTMENT`, `FEE`, `DD_CREDIT`, `DD_DEBIT`, `DC_CREDIT`, `DC_DEBIT`,\n `TRANSFER`, `PAYMENT`, `ISSUING_AUTHORISATION_HOLD`,\n `ISSUING_AUTHORISATION_RELEASE`, `ISSUING_CAPTURE`, `ISSUING_REFUND`, `PURCHASE`,\n `PREPAYMENT`, `PREPAYMENT_RELEASE`, `REPAYMENT_FUNDING`, `REPAYMENT_DEDUCTION`,\n `MOR_PAYOUT`, `MOR_PAYOUT_REVERSAL`, `TRANSFER_OUT`, `TRANSFER_IN`,\n `TRANSFER_OUT_REVERSAL`, `TRANSFER_IN_REVERSAL`,\n `WITHHOLDING_TAX`, `WITHHOLDING_TAX_REVERSAL`." } } }, "PaymentAcceptanceFinancialSettlement": { "type": "object", "properties": { "amount": { "type": "number", "description": "Settlement amount Airwallex pays to the merchant." }, "created_at": { "type": "string", "format": "date-time", "description": "The time this settlement was created at." }, "currency": { "type": "string", "description": "Currency of the settlement." }, "estimated_settled_at": { "type": "string", "format": "date-time", "description": "The time when the settlement will be settled at." }, "fee": { "type": "number", "description": "Fee of the settlement." }, "settlement_id": { "type": "string", "description": "ID of the settlement." }, "settled_at": { "type": "string", "format": "date-time", "description": "The time this settlement was settled at." }, "status": { "type": "string", "description": "One of `PENDING`, `SETTLED`." } } }, "PaymentAcceptanceFinancialSettlementReport": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "The date and time this settlement report was created." }, "settlement_id": { "type": "string", "description": "ID of the settlement." }, "report_url": { "type": [ "string", "null" ], "description": "The url of the report. Available when `report_status` is `READY`, otherwise `null`." }, "report_status": { "type": "string", "enum": [ "READY", "IN_PROGRESS" ], "x-enumDescriptions": { "READY": "`READY` once available for download", "IN_PROGRESS": "`IN_PROGRESS` while still being generated" }, "description": "Status of the report." } } }, "NonPciFeeDetail": { "type": "object", "properties": { "amount": { "type": "number", "description": "Fee amount." }, "currency": { "type": "string", "description": "Currency in which the fee is charged (3-letter ISO-4217 code)." }, "type": { "type": "string", "description": "Fee type. One of: `ATM_ACCESS_FEE`." } } }, "NonPciCardTransactionData": { "type": "object", "description": "Identifiers for the card transaction associated with this record, following the Lifecycle → Card Transaction → Transaction Event model. Omitted for transactions that have no associated card transaction lifecycle.", "properties": { "card_transaction_lifecycle_id": { "type": "string", "format": "uuid", "description": "Identifier that links related transactions belonging to the same card payment — such as authorizations, reversals, captures, and refunds — under a single lifecycle." }, "card_transaction_id": { "type": "string", "format": "uuid", "description": "Identifier of the card transaction. Retrieve its details via GET /api/v1/issuing/card_transactions/{id}." }, "card_transaction_event_id": { "type": "string", "format": "uuid", "description": "Identifier of the individual card transaction event within the lifecycle. The closest equivalent of the transaction_id field." } } }, "NonPciAdditionalMerchantInfo": { "type": "object", "properties": { "merchant_category": { "type": "string", "description": "Merchant category." }, "merchant_full_name": { "type": "string", "description": "Merchant full name." }, "merchant_logo_url": { "type": "string", "description": "Merchant logo url." }, "merchant_sub_category": { "type": "string", "description": "Merchant sub category." } }, "description": "Merchant additional info." }, "NonPciMerchant": { "type": "object", "properties": { "additional_merchant_info": { "$ref": "#/components/schemas/NonPciAdditionalMerchantInfo", "description": "Merchant additional info." }, "category_code": { "type": "string", "description": "Merchant category code." }, "city": { "type": "string", "description": "Merchant city." }, "country": { "type": "string", "description": "Merchant country. Note: this field might prefixed with state name for some countries, e.g. TXUSA, you should parse the last 3 characters for country code." }, "identifier": { "type": "string", "description": "Unique identifier for the merchant." }, "name": { "type": "string", "description": "Merchant name." }, "postcode": { "type": "string", "description": "Merchant postcode (only for merchants within the US, Canada or Brazil)." }, "state": { "type": "string", "description": "Merchant state (only for merchants within the US, Canada or Brazil)." } }, "description": "merchant of the card transaction." }, "NonPciRiskDetails": { "type": "object", "properties": { "risk_actions_performed": { "type": "array", "description": "Risk actions performed for a card transaction, triggered by rules in our risk engine.", "items": { "type": "string" } }, "risk_factors": { "type": "array", "description": "Risk factors are conditions or variables that increase the likelihood of fraud or financial irregularities, assessed by our risk management system to determine the threat level of a transaction.", "items": { "type": "string" } }, "three_dsecure_outcome": { "type": "string", "description": "The outcome of a 3D Secure authentication process, which verifies the identity of a cardholder during an online purchase. Can be one of: `ATTEMPTED`, `AUTHENTICATED`, `FAILED`, `NOT_APPLICABLE`, `NOT_REQUESTED`. Learn more about [3D Secure](/docs/issuing/card-controls/3d-secure-authentication)." } }, "description": "Risk details provides a comprehensive overview of the risk evaluation for a card transaction, including identified risk factors, actions taken by the risk engine, and the outcome of the 3D Secure authentication process. It encapsulates key elements that assess the potential threat level, safeguard the transaction, and ensure the cardholder’s identity is verified. N.b. this information will only be available for transactions on or after 1st Sept 2024." }, "NonPciAuthorization": { "type": "object", "properties": { "acquiring_institution_identifier": { "type": "string", "description": "Unique Identifier for the acquiring institution." }, "auth_code": { "type": "string", "description": "Authorization Code." }, "billing_amount": { "type": "number", "description": "Billing Amount." }, "billing_currency": { "type": "string", "description": "Billing Currency." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the card." }, "card_nickname": { "type": "string", "description": "The nickname of the card used." }, "client_data": { "type": "string", "description": "Client data stored against the card record." }, "create_time": { "type": "string", "description": "The time this outstanding authorization was created." }, "digital_wallet_token_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the digital token." }, "expiry_date": { "type": "string", "description": "The authorization will expire after this date if not posted." }, "failure_reason": { "type": "string", "description": "The reason why this authorization failed (if status is FAILED). Can be one of: `ACCOUNT_INVALID`, `CARD_CLOSED`, `CARD_INACTIVE`, `CARD_INVALID`, `CARD_LOST_STOLEN`, `CARD_NOT_ACTIVATED`, `CARD_REISSUED_TO_NEW_NUMBER`, `CARDHOLDER_VERIFICATION_FAILED`, `CURRENCY_NOT_ALLOWED`, `CVV_INVALID`, `EXPIRY_MISSING`, `INSUFFICIENT_AVAILABLE_CREDIT`, `INSUFFICIENT_FUNDS`, `INTERNAL_ERROR`, `INVALID_EXPIRY_DATE`, `LIMIT_EXCEEDED`, `MERCHANT_CATEGORY_NOT_ALLOWED`, `NOT_SUPPORTED`, `OUT_OF_ALLOWED_TIME_RANGE`, `PIN_INVALID`, `PIN_RETRIES_EXCEEDED`, `REMOTE_AUTH_DECLINED`, `RESTRICTED_COUNTRY`, `SUSPECTED_FRAUD`, `TRANSACTION_BLOCKED`, `TRANSACTION_BLOCKED_AT_TERMINAL`, `TRANSACTION_USAGE_DISABLED`, `MERCHANT_COUNTRY_NOT_ALLOWED`, `MERCHANT_BRAND_NOT_ALLOWED`, `MERCHANT_BRAND_CATEGORY_NOT_ALLOWED`, `MERCHANT_BRAND_SUBCATEGORY_NOT_ALLOWED`. Learn more about [transaction failure reasons](/docs/issuing/transactions/transaction-failure-reasons)." }, "fee_details": { "type": "array", "description": "List of fee details associated with the authorization.", "items": { "$ref": "#/components/schemas/NonPciFeeDetail" } }, "card_transaction_data": { "$ref": "#/components/schemas/NonPciCardTransactionData", "description": "Card transaction identifiers associated with this authorization. Replaces the lifecycle_id field. Omitted for transactions that have no associated card transaction lifecycle." }, "masked_card_number": { "type": "string", "description": "Masked card number." }, "merchant": { "$ref": "#/components/schemas/NonPciMerchant", "description": "merchant of the card transaction." }, "network_transaction_id": { "type": "string", "description": "The transaction unique identifier from VISA network." }, "retrieval_ref": { "type": "string", "description": "Transaction retrieval reference number. Data element 37 of a financial transaction message (https://en.wikipedia.org/wiki/ISO_8583)." }, "risk_details": { "$ref": "#/components/schemas/NonPciRiskDetails", "description": "Risk details provides a comprehensive overview of the risk evaluation for a card transaction, including identified risk factors, actions taken by the risk engine, and the outcome of the 3D Secure authentication process. It encapsulates key elements that assess the potential threat level, safeguard the transaction, and ensure the cardholder’s identity is verified. N.b. this information will only be available for transactions on or after 1st Sept 2024." }, "status": { "type": "string", "description": "The status of this authorization. Can be one of `CLEARED`, `EXPIRED`, `FAILED`, `PENDING`, `REVERSED`." }, "transaction_amount": { "type": "number", "description": "Transaction amount." }, "transaction_currency": { "type": "string", "description": "Transaction currency." }, "transaction_id": { "type": "string", "format": "uuid", "description": "Unique id for the transaction." }, "updated_by_transaction": { "type": "string", "format": "uuid", "description": "Id of the transaction which updated status of this transaction. eg: capture." } } }, "NonPciFxConversionFromToDetails": { "type": "object", "properties": { "from_currency": { "type": "string", "description": "The source currency of the conversion (3-letter ISO-4217 code)." }, "rate": { "type": "number", "description": "The effective rate of fx after markup, in the from -> to direction." }, "to_currency": { "type": "string", "description": "The target currency of the conversion (3-letter ISO-4217 code)." } }, "description": "Currency conversion details, present when the billing currency differs from the transaction currency." }, "NonPciSimpleDigitalWalletToken": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the digital token." }, "payment_method": { "type": "string", "description": "Payment method used. One of: `APPLE_PAY`, `GOOGLE_PAY`, `CARD_ON_FILE`." } }, "description": "Details of the digital wallet token used for the transaction, if applicable." }, "NonPciAdditionalMerchantInfo-2": { "type": "object", "properties": { "merchant_brand_category_id": { "type": "integer", "format": "int32", "description": "The unique identifier associated with the merchant category." }, "merchant_brand_id": { "type": "string", "format": "uuid", "description": "The unique identifier for the merchant brand." }, "merchant_brand_name": { "type": "string", "description": "The full legal or common name of the merchant." }, "merchant_brand_subcategory_id": { "type": "integer", "format": "int32", "description": "The unique identifier associated with the merchant's sub-category." }, "merchant_logo_url": { "type": "string", "description": "URL of the merchant's logo for display purposes." } }, "description": "Supplemental details providing richer context on the merchant and its brand. Learn more about [merchant brand controls](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories)." }, "NonPciMerchantWithEnrichment": { "type": "object", "properties": { "additional_merchant_info": { "$ref": "#/components/schemas/NonPciAdditionalMerchantInfo-2", "description": "Supplemental details providing richer context on the merchant and its brand. Learn more about [merchant brand controls](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories)." }, "category_code": { "type": "string", "description": "The Merchant Category Code (MCC)." }, "city": { "type": "string", "description": "The city of the merchant." }, "country": { "type": "string", "description": "The country of the merchant." }, "identifier": { "type": "string", "description": "Unique identifier for the merchant." }, "name": { "type": "string", "description": "The short name of the merchant." }, "postcode": { "type": "string", "description": "The postal code of the merchant." }, "state": { "type": "string", "description": "The state or province of the merchant." } }, "description": "Details about the merchant where the transaction occurred, including enriched brand information." }, "NonPciTransactionEvent": { "type": "object", "properties": { "acquiring_institution_identifier": { "type": "string", "description": "Identifier of the acquiring institution (the merchant's bank)." }, "auth_code": { "type": "string", "description": "Authorization code returned for approved transactions." }, "billing_amount": { "type": "number", "description": "The amount for this event in the card's billing currency." }, "billing_currency": { "type": "string", "description": "Three-letter ISO 4217 currency code for the billing amount." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card associated with this transaction event." }, "card_transaction_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card transaction this event belongs to." }, "conversion_details": { "$ref": "#/components/schemas/NonPciFxConversionFromToDetails", "description": "Currency conversion details, present when the billing currency differs from the transaction currency." }, "created_at": { "type": "string", "description": "Date and time when the transaction event was created, in ISO 8601 format." }, "digital_wallet_token": { "$ref": "#/components/schemas/NonPciSimpleDigitalWalletToken", "description": "Details of the digital wallet token used for the transaction, if applicable." }, "expiry_date": { "type": "string", "description": "The date and time when the authorization is set to expire, in ISO 8601 format. After expiry, reserved funds are released. Note: the associated card transaction status may not update to `EXPIRED` immediately after this time." }, "failure_reason": { "type": "string", "description": "The reason the event was declined. Only present when `process_result` is `DECLINED`. Learn more about [transaction failure reasons](/docs/issuing/transactions/transaction-failure-reasons)." }, "fee_details": { "type": "array", "description": "Fees applied to this specific event.", "items": { "$ref": "#/components/schemas/NonPciFeeDetail" } }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the transaction event." }, "lifecycle_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the lifecycle this event belongs to." }, "masked_card_number": { "type": "string", "description": "The masked primary account number (PAN) of the card." }, "merchant": { "$ref": "#/components/schemas/NonPciMerchantWithEnrichment", "description": "Details about the merchant where the event originated, including enriched brand information." }, "network_transaction_id": { "type": "string", "description": "Unique identifier assigned to the transaction by the card network." }, "pos_entry_mode": { "type": "string", "description": "The point-of-service entry mode indicating how the card was presented. One of: `MANUAL`, `CREDENTIAL_ON_FILE`, `CONTACTLESS_CHIP`, `CONTACT_CHIP`, or `MAGSTRIPE`." }, "process_result": { "type": "string", "description": "The processing outcome for this event. `APPROVED` or `DECLINED`." }, "remote_auth": { "type": "object", "description": "Data related to remote authentication, present when the transaction was processed via Remote Auth. Null or absent otherwise.", "required": [ "default_response_used", "duration_ms", "reason", "response", "timed_out" ], "properties": { "response": { "type": "string", "description": "The response status of the remote auth call. One of: `AUTHORIZED`, `DECLINED`." }, "reason": { "type": "string", "description": "Reason for the remote authorization decision." }, "duration_ms": { "type": "integer", "format": "int32", "description": "Response time of remote authorization in milliseconds." }, "timed_out": { "type": "boolean", "description": "Indicates whether the remote auth call timed out before a response was received." }, "default_response_used": { "type": "boolean", "description": "Indicates whether the fallback/default action from the remote auth configuration was applied." } } }, "retrieval_ref": { "type": "string", "description": "Reference number assigned by the acquiring bank, used to link related events (e.g., a clearing to its original authorization)." }, "risk_details": { "$ref": "#/components/schemas/NonPciRiskDetails", "description": "Risk assessment details for this transaction event." }, "subtype": { "type": "string", "description": "A more specific classification of the event type. One of: `AUTHORIZATION`, `INCREMENTAL_AUTHORIZATION`, `VERIFICATION`, `REVERSAL`, `PARTIAL_REVERSAL`, `EXPIRED_AUTHORIZATION`, `CLEARING`, `PARTIAL_CLEARING`, `CLEARING_REVERSAL`." }, "transaction_amount": { "type": "number", "description": "The amount for this event in the merchant's transaction currency." }, "transaction_category": { "type": "string", "description": "The category of the transaction, derived from the card scheme's processing code. One of: `PURCHASE`, `CASH_DISBURSEMENT`, `ACCOUNT_FUNDING`, `QUASI_CASH`, `MERCHANT_CREDIT`, `DISPUTE_CREDIT`, `ORIGINAL_CREDIT`, `ELIGIBILITY_INQUIRY`, `BILL_PAYMENT`." }, "transaction_currency": { "type": "string", "description": "Three-letter ISO 4217 currency code for the transaction amount." }, "transacted_at": { "type": "string", "format": "date-time", "description": "The date and time the transaction occurred as reported by the card network, in ISO 8601 format." }, "type": { "type": "string", "description": "The type of this transaction event. One of: `AUTHORIZATION`, `CLEARING`, or `REVERSAL_AUTH`." }, "updated_at": { "type": "string", "description": "Date and time when the transaction event was last updated, in ISO 8601 format." } } }, "NonPciBookmarkedResultOfIssuingNonPciTransactionEvent": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciTransactionEvent" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } } }, "NonPciAggregatedAmounts": { "type": "object", "properties": { "currency": { "type": "string", "description": "Three-letter ISO 4217 currency code for all amounts in this object." }, "total_authorized": { "type": "number", "description": "Total amount authorized (funds reserved in the wallet)." }, "total_credited": { "type": "number", "description": "Total amount credited (funds returned to the wallet, e.g., refunds)." }, "total_debited": { "type": "number", "description": "Total amount debited (funds moved out of the wallet after clearing)." }, "total_declined": { "type": "number", "description": "Total amount declined (transaction amounts that were rejected)." }, "total_expired": { "type": "number", "description": "Total amount expired (authorized amounts that were never captured and have been released)." }, "total_pending": { "type": "number", "description": "Total amount still pending (outstanding authorized amount not yet cleared, reversed, or expired)." }, "total_reversed": { "type": "number", "description": "Total amount reversed (authorized amounts that were cancelled and released)." } }, "description": "Aggregated amounts in the card's billing currency (the currency of the cardholder's wallet). Includes totals for authorized, debited, credited, pending, and other states." }, "NonPciLifecycle": { "type": "object", "properties": { "billing_amounts": { "type": "array", "description": "Aggregated billing totals grouped by currency. Each entry contains cumulative amounts across all card transactions and transaction events within this lifecycle, including totals for authorized, debited, credited, declined, expired, pending, and reversed amounts.", "items": { "$ref": "#/components/schemas/NonPciAggregatedAmounts" } }, "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card associated with this lifecycle." }, "created_at": { "type": "string", "description": "Date and time when the lifecycle was created, in ISO 8601 format." }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the lifecycle." }, "updated_at": { "type": "string", "description": "Date and time when the lifecycle was last updated (e.g., when a new card transaction or transaction event was added), in ISO 8601 format." } } }, "NonPciBookmarkedResultOfIssuingNonPciLifecycle": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciLifecycle" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } } }, "NonPciCardTransaction": { "type": "object", "properties": { "billing_amounts": { "$ref": "#/components/schemas/NonPciAggregatedAmounts", "description": "Aggregated amounts in the card's billing currency (the currency of the cardholder's wallet). Includes totals for authorized, debited, credited, pending, and other states." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card associated with this card transaction." }, "created_at": { "type": "string", "description": "Date and time when the card transaction was created, in ISO 8601 format." }, "digital_wallet_token": { "$ref": "#/components/schemas/NonPciSimpleDigitalWalletToken", "description": "Details of the digital wallet token used for the transaction, if applicable." }, "expiry_date": { "type": "string", "description": "The date and time when the current authorization is set to expire, in ISO 8601 format. After expiry, reserved funds are released. Note: the status may not update to `EXPIRED` immediately after this time." }, "failure_reason": { "type": "string", "description": "The reason the transaction was declined. Only present when `status` is `DECLINED`. Learn more about [transaction failure reasons](/docs/issuing/transactions/transaction-failure-reasons)." }, "fee_details": { "type": "array", "description": "Fees applied to this card transaction, such as ATM fees or foreign transaction fees.", "items": { "$ref": "#/components/schemas/NonPciFeeDetail" } }, "fund_direction": { "type": "string", "description": "The direction of funds relative to the cardholder's wallet. One of: `DEBIT`, `CREDIT`, or `NO_MOVEMENT`." }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card transaction." }, "lifecycle_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the lifecycle this card transaction belongs to. Use this to retrieve all related card transactions (e.g., a purchase and its refund)." }, "masked_card_number": { "type": "string", "description": "The masked primary account number (PAN) of the card." }, "merchant": { "$ref": "#/components/schemas/NonPciMerchantWithEnrichment", "description": "Details about the merchant where the transaction occurred, including enriched brand information." }, "status": { "type": "string", "description": "The current status of the card transaction. `AUTHORIZED` is non-terminal; all other statuses are terminal. One of: `AUTHORIZED`, `CLEARED`, `DECLINED`, `EXPIRED`, `REVERSED`, `VERIFIED`." }, "transaction_amounts": { "$ref": "#/components/schemas/NonPciAggregatedAmounts", "description": "Aggregated amounts in the merchant's transaction currency (the currency used at the point of sale)." }, "updated_at": { "type": "string", "description": "Date and time when the card transaction was last updated, in ISO 8601 format." } } }, "NonPciBookmarkedResultOfIssuingNonPciCardTransaction": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciCardTransaction" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } } }, "NonPciAddress": { "type": "object", "required": [ "city", "country", "line1", "postcode" ], "properties": { "city": { "type": "string", "description": "City of address." }, "country": { "type": "string", "description": "ISO country code of address." }, "line1": { "type": "string", "description": "Address line 1." }, "line2": { "type": "string", "description": "Address line 2." }, "postcode": { "type": "string", "description": "Address postcode or ZIP code." }, "state": { "type": "string", "description": "Address state or region." } }, "description": "Optional postal address of physical card delivery." }, "NonPciBusinessIdentifier": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ] } } }, "NonPciEmployer": { "type": "object", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/NonPciBusinessIdentifier" } }, "business_name": { "type": "string", "description": "Name of the employer." } } }, "NonPciCardholderName": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name of cardholder." }, "last_name": { "type": "string", "description": "Last name for cardholder." }, "middle_name": { "type": "string", "description": "Optional middle name of cardholder." }, "title": { "type": "string", "description": "Optional title of cardholder." } }, "description": "The full name of the Individual. Only characters in English are supported." }, "NonPciIndividual": { "type": "object", "required": [ "date_of_birth", "name" ], "properties": { "address": { "$ref": "#/components/schemas/NonPciAddress", "description": "Address of the cardholder." }, "date_of_birth": { "type": "string", "format": "date", "description": "The individual's date of birth, in the format `YYYY-MM-DD`." }, "employers": { "type": "array", "description": "Information of the individual's employers.", "items": { "$ref": "#/components/schemas/NonPciEmployer" } }, "name": { "$ref": "#/components/schemas/NonPciCardholderName", "description": "The full name of the Individual. Only characters in English are supported." }, "tax_identification_number": { "type": "string", "description": "The tax identification number for the individual cardholder. Used for customs or regulatory reporting when required by the shipping destination. Format and requirements may differ by country." } }, "description": "Details about the cardholder. Only relevant for individual cardholder type." }, "NonPciCardholder": { "type": "object", "properties": { "cardholder_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the cardholder." }, "email": { "type": "string", "description": "Email address of the cardholder." }, "individual": { "$ref": "#/components/schemas/NonPciIndividual", "description": "Details about the cardholder. Only relevant for individual cardholder type." }, "mobile_number": { "type": "string", "description": "The mobile number of the cardholder." }, "postal_address": { "$ref": "#/components/schemas/NonPciAddress", "description": "Postal address for the cardholder." }, "status": { "type": "string", "description": "The status of the cardholder.", "enum": [ "INCOMPLETE", "PENDING", "READY", "DISABLED", "DELETED" ], "x-enumDescriptions": { "INCOMPLETE": "Cardholder record has incomplete information or more data is required to move them to READY.", "PENDING": "Cardholder is currently in review.", "READY": "Cardholder is ready to be issued cards.", "DISABLED": "Cardholder record has been disabled.", "DELETED": "Cardholder record has been deleted." } }, "type": { "type": "string", "description": "The type of cardholder.", "enum": [ "INDIVIDUAL", "DELEGATE" ], "x-enumDescriptions": { "INDIVIDUAL": "A cardholder who is associated with a named individual that is a representative of your business. Can be associated with a personalized or non-personalized card.", "DELEGATE": "A cardholder who may be assigned to non-personalized cards only and acts as an authorized user of the card." } } } }, "NonPciDeleteCardholder": { "type": "object", "properties": { "cardholder_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the cardholder." }, "deleted": { "type": "boolean", "description": "Will be set to true if the cardholder was deleted successfully." } } }, "PciError": { "type": "object", "required": [ "code", "source" ], "properties": { "code": { "type": "string" }, "details": { "type": "object" }, "message": { "type": "string" }, "source": { "type": "string" } } }, "NonPciAlertSettingEntry": { "type": "object", "required": [ "enabled", "percent" ], "properties": { "enabled": { "type": "boolean", "description": "Indicates whether the alert is active." }, "percent": { "type": "integer", "format": "int32", "description": "Specifies the percentage threshold for the alert." } }, "description": "Configures an alert for when the remaining spending limit dips below a specified percentage. When enabled, a webhook notification will be triggered if the remaining limit falls below the defined threshold. Note that:\n\n- Only one notification per spend limit interval will be sent. A webhook is triggered only when the threshold is crossed, and further spending below the threshold will not trigger additional notifications. Example: if the percent enabled is 10, a webhook will be sent once the remaining limit is at or less than 10%.\n- If the spend limit has been updated, a new notification will be sent when the new threshold is crossed.\n- This alert only applies to multiple use cards.\n- If not specified, this setting will be enabled by default with ``enabled`` set to ``true`` and ``percent`` set to an account specific default value." }, "NonPciAlertSettings": { "type": "object", "properties": { "low_remaining_transaction_limit": { "$ref": "#/components/schemas/NonPciAlertSettingEntry", "description": "Configures an alert for when the remaining spending limit dips below a specified percentage. When enabled, a webhook notification will be triggered if the remaining limit falls below the defined threshold. Note that:\n\n- Only one notification per spend limit interval will be sent. A webhook is triggered only when the threshold is crossed, and further spending below the threshold will not trigger additional notifications. Example: if the percent enabled is 10, a webhook will be sent once the remaining limit is at or less than 10%.\n- If the spend limit has been updated, a new notification will be sent when the new threshold is crossed.\n- This alert only applies to multiple use cards.\n- If not specified, this setting will be enabled by default with ``enabled`` set to ``true`` and ``percent`` set to an account specific default value." } }, "description": "Contains alert configuration settings for the card." }, "NonPciCardVersion": { "type": "object", "properties": { "card_number": { "type": "string", "description": "Masked card number of this version." }, "card_status": { "type": "string", "description": "Card status of this version. See [Card Status](/docs/issuing/get-started/create-cards/card-statuses) for definitions.", "enum": [ "PENDING", "FAILED", "INACTIVE", "ACTIVE", "LOST", "STOLEN", "CLOSED", "BLOCKED", "EXPIRED", "UNKNOWN" ] }, "card_version": { "type": "integer", "format": "int32", "description": "Version Id which uniquely identifies this card version object." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation time of the card version." } } }, "NonPciAllowedMerchantBrands": { "type": "object", "properties": { "categories": { "type": "array", "description": "Allowed Merchant Brands Categories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand categories will be allowed.", "items": { "type": "string" } }, "ids": { "type": "array", "description": "Allowed Merchant Brand identifiers for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand ids will be allowed. You can search for Merchant Brands ids using the [Merchant Brands API](/docs/api/issuing/merchant_brands/retrieve).", "items": { "type": "string", "format": "uuid" } }, "subcategories": { "type": "array", "description": "Allowed Merchant Brands Subcategories for transactions. These must be provided using the codes defined in the [Merchant Brands Controls product page](/docs/issuing/card-controls/authorization-controls/merchant-brand-transaction-categories). Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant brand subcategories will be allowed.", "items": { "type": "string" } } }, "description": "Allowed Merchant Brands rules for transactions. Please note if this field is absent from request payload, then transactions from all merchant brands will be allowed." }, "NonPciTransactionUsage": { "type": "object", "properties": { "transaction_scope": { "type": "string", "description": "Types of transaction scope. It can be one of: `ALL_TRANSACTIONS`, `ONLINE_TRANSACTION`, `CONTACTLESS_TRANSACTION`, `CONTACT_CHIP_TRANSACTION`, `MAGSTRIPE`, `CASH_WITHDRAWAL`, `BILL_PAYMENT`, `ACCOUNT_FUNDING`." }, "usage_scope": { "type": "string", "description": "Determines if a transaction can be made domestically and/or internationally. It can be one of: `ALL`, `INTERNATIONAL`, `DOMESTIC`." } } }, "NonPciSpendingLimit": { "type": "object", "required": [ "amount", "interval" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount. This field is mandatory and must be greater than 0. Customer can set perTransaction limit up to a maximum amount (The maximum amount is part of account setting)." }, "interval": { "type": "string", "description": "Transaction limit interval. This field is mandatory and must be one of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." } } }, "NonPciTransactionLimits": { "type": "object", "required": [ "limits" ], "properties": { "cash_withdrawal_limits": { "type": "array", "description": "Cash withdrawal transaction limits are based on interval and amount. \n \nIf the daily limit is not set, the default daily limit amount for the selected limit currency will be used. The default daily limit amount is part of the account setting. To change the default daily limit amount, please reach out to your account manager. \n \nPlease note that the cash withdrawal transaction limits apply exclusively to cash withdrawals and are imposed to help manage potential liability for the account holder and for Airwallex. The account holder may be liable for any unauthorised spending on the card, so please apply the limits responsibly. \n \n**Important**: This limit will only appear if you have cash withdrawals enabled. Please speak to your account manager if you would like to enable cash withdrawals.", "items": { "$ref": "#/components/schemas/NonPciSpendingLimit" } }, "currency": { "type": "string", "description": "Currency for transaction limits (3-letter ISO-4217 code). Will use USD if not set. Examples of valid base currencies are USD, AUD, GBP, EUR, CNY, HKD, SGD, NZD, JPY, CAD, CHF. More currencies may be available for your account: you may query the full list by calling the [Get issuing config](/docs/api/issuing/config/retrieve) endpoint." }, "limits": { "type": "array", "description": "Transaction limits are based on interval and amount. \n \nIf the per transaction limit is not set, the default per transaction limit amount for the selected limit currency will be used. The default per transaction amount is part of account settings. To change the default per transaction limit, please reach out to your account manager. \n \nThe account holder may be liable for any unauthorised spending on the card, so please apply limits responsibly.", "items": { "$ref": "#/components/schemas/NonPciSpendingLimit" } } }, "description": "Transaction limits for the card. Multiple transaction limits can be configured based on single currency. Each transaction will be checked against the limits with interval after currency conversion rate applied." }, "NonPciAuthorizationControls": { "type": "object", "required": [ "allowed_transaction_count", "transaction_limits" ], "properties": { "active_from": { "type": "string", "description": "If provided, authorizations prior to this time will be rejected." }, "active_to": { "type": "string", "description": "If provided, authorizations after this time will be rejected." }, "allowed_currencies": { "type": "array", "description": "Allowed Currencies for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then all transaction currencies will be allowed.", "items": { "type": "string" } }, "allowed_merchant_brands": { "$ref": "#/components/schemas/NonPciAllowedMerchantBrands", "description": "Allowed Merchant Brands rules for transactions. Please note if this field is absent from request payload, then transactions from all merchant brands will be allowed." }, "allowed_merchant_categories": { "type": "array", "description": "Allowed Merchant Category Codes. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then all merchant categories will be allowed.", "items": { "type": "string" } }, "allowed_merchant_countries": { "type": "array", "description": "Allowed Merchant Countries for transactions. Please note if this field is absent from request payload, or has a value of `null` or empty array `[]`, then transactions from all merchant countries will be allowed (although some may still be blocked by our risk team).", "items": { "type": "string" } }, "allowed_transaction_count": { "type": "string", "description": "Specifies whether this card is a Single or Multiple Use card. Single Use means that the card can only be used for 1 successful debit transaction.", "enum": [ "SINGLE", "MULTIPLE" ] }, "blocked_transaction_usages": { "type": "array", "description": "List of disabled transaction usages, based on transaction_scope and usage_scope values. Please note if this field is absent from request payload or has a value of `null`, then all transaction usages will be allowed unless a default configration is added. \n \nYou can add multiple transaction_scope and usage_scope values. The most restrictive scope(s) would apply.", "items": { "$ref": "#/components/schemas/NonPciTransactionUsage" } }, "transaction_limits": { "$ref": "#/components/schemas/NonPciTransactionLimits", "description": "Transaction limits for the card. Multiple transaction limits can be configured based on single currency. Each transaction will be checked against the limits with interval after currency conversion rate applied." } }, "description": "Spend controls that determine the rules and restrictions to check for transaction authorizations." }, "NonPciDeliveryDetails": { "type": "object", "properties": { "delivery_mode": { "type": "string", "description": "`MAIL`: Delivery of the card is delivered via mail shipment. Tracking may or may not be provided.\n`EXPRESS`: Delivery of the card is tracked and delivered via express shipment. A tracking_link will always be provided.\n", "enum": [ "MAIL", "EXPRESS", "UNKNOWN" ] }, "delivery_vendor": { "type": "string", "description": "Delivery vendor of this card.", "enum": [ "UNKNOWN", "AU_POST", "EMS", "HK_POST", "CITY_LINK", "DHL", "CN_POST", "PL_POST", "USPS", "FEDEX" ] }, "mobile_number": { "type": "string", "description": "The mobile number for the card delivery." }, "preferred_delivery_mode": { "type": "string", "description": "The delivery mode customer selected when the Create Card API is called.", "enum": [ "MAIL", "EXPRESS", "UNKNOWN" ] }, "status": { "type": "string", "description": "See [Delivery Status](/docs/issuing/manage-cards/retrieve-physical-card-delivery-details) for definitions.", "enum": [ "PENDING", "PRINTED", "FAILED_TO_PRINT", "DISPATCHED", "IN_TRANSIT", "OUT_FOR_DELIVERY", "DELIVERED", "DELIVERY_FAILED", "DELIVERY_DELAYED", "UNKNOWN" ] }, "status_description": { "type": "string", "description": "A brief description of the status.\n" }, "tracked": { "type": "boolean", "description": "Specifies if the delivery of the card is tracked. If `true`, a tracking link will be provided when status becomes `DISPATCHED`." }, "tracking_link": { "type": "string", "description": "Tracking link of the card." }, "tracking_number": { "type": "string", "description": "Delivery tracking number of this card." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update time of the delivery details." } }, "description": "Delivery detail of the card. Only available for physical cards." }, "NonPciPrimaryContactDetail": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the primary contact of the new card." }, "full_name": { "type": "string", "description": "Full name of the primary contact of the new card." }, "mobile_number": { "type": "string", "description": "The mobile number of the primary contact of the new card." } }, "description": "Details of the primary contact of the card." }, "NonPciCardProgram": { "type": "object", "properties": { "interchange_percent": { "type": "string", "description": "Interchange percent of the card - This is only available for `sub_type=\"B2B_TRAVEL\"` cards. Interchange can vary from 0.8 to 1.9, with increments of 0.1." }, "purpose": { "type": "string", "enum": [ "CONSUMER", "COMMERCIAL" ], "x-enumDescriptions": { "CONSUMER": "A card used for personal purposes backed by funding belonging to an individual.", "COMMERCIAL": "A card used for business purposes backed by funding belonging to a business." } }, "sub_type": { "type": "string", "description": "Sub type of the program - This is used for specific products under the defined program types. e.g `B2B_TRAVEL` which designates BINs for travel use cases (E.g OTAs).", "enum": [ "GOOD_FUNDS_CREDIT", "B2B_TRAVEL", "UNKNOWN" ] }, "type": { "type": "string", "description": "Card type - `PREPAID`, `DEBIT`, `CREDIT` or `DEFERRED_DEBIT`. `DEFERRED_DEBIT` is Deferred Debit card available for OTA (Online Travel Agent) customers only in UK/Europe countries. If card type is not set, the default card type which is a part of your account setting will be used.", "enum": [ "UNKNOWN", "DEBIT", "PREPAID", "CREDIT", "DEFERRED_DEBIT" ] } }, "description": "Card program." }, "NonPciCard": { "type": "object", "properties": { "activate_on_issue": { "type": "boolean", "description": "Set this to `true` to activate the physical card when it is created. This will enable use of the card while it’s being delivered to the cardholder. Virtual cards will always be activated upon creation." }, "auto_close_date": { "type": "string", "format": "date", "description": "The date on which the card is automatically closed, at the start of that day (00:00 GMT). The date is in the format YYYY-MM-DD. Returns `null` if no automatic closure is scheduled." }, "additional_cardholder_ids": { "type": "array", "description": "The ID of additional cardholders of this card. Only valid if `is_personalized` is `false`.", "items": { "type": "string", "format": "uuid" } }, "alert_settings": { "$ref": "#/components/schemas/NonPciAlertSettings", "description": "Contains alert configuration settings for the card." }, "all_card_versions": { "type": "array", "description": "Contains information about all versions of a card. A version changes with change in PAN.", "items": { "$ref": "#/components/schemas/NonPciCardVersion" } }, "authorization_controls": { "$ref": "#/components/schemas/NonPciAuthorizationControls", "description": "Spend controls that determine the rules and restrictions to check for transaction authorizations." }, "brand": { "type": "string", "description": "Card Brand." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the card." }, "card_number": { "type": "string", "description": "Masked card number." }, "card_status": { "type": "string", "description": "Current card status. See [Card Status](/docs/issuing/get-started/create-cards/card-statuses) for definitions.", "enum": [ "PENDING", "FAILED", "INACTIVE", "ACTIVE", "LOST", "STOLEN", "CLOSED", "BLOCKED", "EXPIRED", "UNKNOWN" ] }, "card_version": { "type": "integer", "format": "int32", "description": "Current version of the card." }, "cardholder_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the cardholder this card is associated with if it is an individual card." }, "client_data": { "type": "string", "description": "Client data which will be stored against the card record in Airwallex." }, "created_at": { "type": "string", "format": "date-time", "description": "Creation time of the card." }, "created_by": { "type": "string", "description": "The creator of the card." }, "delivery_details": { "$ref": "#/components/schemas/NonPciDeliveryDetails", "description": "Delivery detail of the card. Only available for physical cards." }, "form_factor": { "type": "string", "description": "Form of the card.", "enum": [ "PHYSICAL", "VIRTUAL" ] }, "funding_source_id": { "type": "string", "format": "uuid", "description": "A unique identifier that links a card to its designated funding source. This unique identifier determines which funding source will be accessed for the deduction of funds during transactions. The `funding_source_id` can be retrieved from the client's account manager. If `funding_source_id` is not provided, the default funding source would be the account's wallet." }, "is_personalized": { "type": "boolean", "description": "Determines whether the card should be assigned to a singular individual or to the business with multiple cardholders who are authorized to use the card. Note - only personalized cards can be created as physical and added to digital wallet providers." }, "metadata": { "type": "object", "description": "A set of key-value pairs that can be attached to the Card. You can specify up to 20 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "name_on_card": { "type": "string", "description": "Name to be printed on card." }, "nick_name": { "type": "string", "description": "A nick name for the card." }, "note": { "type": "string", "description": "Notes that are to be stored against the card request (for client reference)." }, "postal_address": { "$ref": "#/components/schemas/NonPciAddress", "description": "Optional postal address of physical card delivery." }, "primary_contact_details": { "$ref": "#/components/schemas/NonPciPrimaryContactDetail", "description": "Details of the primary contact of the card." }, "program": { "$ref": "#/components/schemas/NonPciCardProgram", "description": "Card program." }, "purpose": { "type": "string", "description": "The purpose of the card's usage. Only available for expense cards.", "enum": [ "SUBSCRIPTIONS", "OFFICE_SUPPLIES", "MARKETING_EXPENSES", "TRAVEL_EXPENSES", "CLIENT_EXPENSES", "TEAM_EXPENSES", "ONLINE_PURCHASING", "BUSINESS_EXPENSES", "OTHER" ] }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client. Requests with the same request_id will be ignored. This allows requests to be replayed if client is unsure of the outcome, e.g. due to network issues, system failures, etc. Note: Can be non-UUID as long as it is unique between requests." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update time of the card." } } }, "NonPciCardSummary": { "type": "object", "required": [ "brand", "card_id", "card_number", "card_status", "created_at" ], "properties": { "additional_cardholder_ids": { "type": "array", "description": "Unique Identifiers for additional cardholders.", "items": { "type": "string", "format": "uuid" } }, "brand": { "type": "string", "description": "Card Brand." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the card." }, "card_number": { "type": "string", "description": "Masked card number." }, "card_status": { "type": "string", "description": "Current card status, one of: ", "enum": [ "PENDING", "FAILED", "INACTIVE", "ACTIVE", "LOST", "STOLEN", "CLOSED", "BLOCKED", "EXPIRED", "UNKNOWN" ] }, "cardholder_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the cardholder, if this is an employee card." }, "created_at": { "type": "string", "format": "date-time", "description": "Date card was created." }, "nick_name": { "type": "string", "description": "Nickname on the card." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last update time of the card." } } }, "PciCardPci": { "type": "object", "required": [ "card_number", "cvv", "expiry_month", "expiry_year", "name_on_card" ], "properties": { "card_number": { "type": "string", "description": "Card Number." }, "cvv": { "type": "string", "description": "Card Verification Value." }, "expiry_month": { "type": "integer", "format": "int32", "description": "Card Expiry Month." }, "expiry_year": { "type": "integer", "format": "int32", "description": "Card Expiry Year." }, "name_on_card": { "type": "string", "description": "Name printed on card." } } }, "NonPciRemainingLimit": { "type": "object", "required": [ "amount", "interval", "remaining" ], "properties": { "amount": { "type": "number", "description": "Transaction limit amount." }, "interval": { "type": "string", "description": "Transaction limit interval. One of: `PER_TRANSACTION`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`, `ALL_TIME`." }, "remaining": { "type": "number", "description": "Remaining amount of transaction limit for that interval. Refunds are always restored to active limits (each refund will increase the limit balance). Please check product doc for more details." } } }, "NonPciRemainingLimits": { "type": "object", "properties": { "cash_withdrawal_limits": { "type": "array", "description": "Remaining Cash Withdrawal Limits for Intervals.", "items": { "$ref": "#/components/schemas/NonPciRemainingLimit" } }, "currency": { "type": "string", "description": "Currency of transaction limits (3-letter ISO-4217 code)." }, "limits": { "type": "array", "description": "Remaining limits for Intervals.", "items": { "$ref": "#/components/schemas/NonPciRemainingLimit" } } } }, "IssuingPciExpirationDate": { "type": "object", "required": [ "month", "year" ], "properties": { "month": { "type": "string", "description": "Expiry month of the provisioned token." }, "year": { "type": "string", "description": "Expiry year of the provisioned token." } } }, "PciApiProvisioning": { "type": "object", "required": [ "card_id" ], "properties": { "card_id": { "type": "string", "description": "Identifier of the provisioned card." }, "activation_data": { "type": "string", "description": "Present when `type` is `apple_pay`. Activation data to return to Apple PassKit." }, "encrypted_pass_data": { "type": "string", "description": "Present when `type` is `apple_pay`. Encrypted pass data to return to Apple PassKit to complete provisioning." }, "ephemeral_public_key": { "type": "string", "description": "Present when `type` is `apple_pay`. Ephemeral public key to return to Apple PassKit." }, "expiration_date": { "$ref": "#/components/schemas/IssuingPciExpirationDate", "description": "Present when `type` is `google_pay`. Expiration date of the provisioned token." }, "enc_address": { "type": "string", "description": "Present when `type` is `google_pay`, when available. Encrypted billing address." }, "last4": { "type": "string", "description": "Present when `type` is `google_pay` or `samsung_pay`. Last four digits of the tokenized card." }, "opaque_payment_card": { "type": "string", "description": "Present when `type` is `google_pay` or `samsung_pay`. Opaque payment card payload to pass to the wallet SDK." }, "google_opaque_payment_card": { "type": "string", "description": "Present when `type` is `google_pay`. Used for push provisioning." }, "card_type": { "type": "string", "description": "Present when `type` is `samsung_pay`. Card network / type." }, "vcard_id": { "type": "string", "description": "Present when `type` is `samsung_pay`." } } }, "NonPciRemoteAuthConfig": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Remote auth config creation time." }, "default_action": { "type": "string", "description": "Default action when remote auth failed.", "enum": [ "AUTHORIZED", "DECLINED" ] }, "enabled": { "type": "boolean", "description": "Remote auth config enabled flag, Airwallex will start sending remote auth request to your endpoint once this flag is enabled." }, "shared_secret": { "type": "string", "description": "Shared secret to verify our remote auth request. Please note this field only return once when you init remote auth config or request a new secret in the update request, get issuing setting always return null." }, "updated_at": { "type": "string", "description": "Remote auth config last update time." }, "url": { "type": "string", "description": "The url for your remote auth endpoint, we will send remote auth request to this endpoint when your config is enabled." }, "version": { "type": "integer", "format": "int32", "description": "Specifies the remote auth payload version (1 or 2)." } }, "description": "Remote authorization config. Please read the [remote auth product documentation](/docs/issuing/card-controls/remote-authorization) for more information. You will need to reach out to our support team to enable this feature for you." }, "NonPciMethodConfig": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the method being configured." }, "path": { "type": "string", "description": "Path that will be combined with url for remote calls." } } }, "NonPciRemoteCallConfig": { "type": "object", "properties": { "methods": { "type": "array", "description": "Individual remote call method configs.", "items": { "$ref": "#/components/schemas/NonPciMethodConfig" } }, "shared_secret": { "type": "string", "description": "Shared secret to verify remote call requests. Please note this field only return once when you init remote call config or request a new secret in the update request, get issuing setting always return null.", "readOnly": true }, "url": { "type": "string", "description": "The base url for remote calls, which will be combined with the path supplied for individual methods." } }, "description": "Remote call config. You will need to reach out to our support team to enable this feature for you." }, "NonPciRemoteProvisioningConfig": { "type": "object", "properties": { "default_action": { "type": "string", "description": "Default action when remote provisioning attempt fails.", "enum": [ "UNKNOWN", "CONDITIONAL_APPROVAL", "GENERIC_DECLINE" ] }, "enabled": { "type": "boolean", "description": "Remote Provisioning config enabled flag, Airwallex will start sending remote provisioning requests to your endpoint once this flag is enabled." } }, "description": "Remote provisioning config. You will need to reach out to our support team to enable this feature for you." }, "NonPciSpendingLimitSetting": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency code of the card spending limit setting." }, "default": { "type": "number", "description": "Default card spending limit amount of no limit set when create/update card." }, "maximum": { "type": "number", "description": "Maximum spending limit user can set for the card. When create/update card, if spending limit exceed this amount, the create/update card request will be rejected." } } }, "NonPciSpendingLimitSettings": { "type": "object", "properties": { "per_transaction_limits": { "type": "array", "description": "PerTransaction Limit settings for all supported base currency.", "items": { "$ref": "#/components/schemas/NonPciSpendingLimitSetting" } } }, "description": "Spending limit settings. The default and maximum limits can be modified by reaching out to an Account Services team member. " }, "NonPciIssuingSetting": { "type": "object", "required": [ "enable_auto_conversion", "primary_currency", "spending_limit_settings" ], "properties": { "blocked_transaction_usages": { "type": "array", "description": "Transaction usage settings. The default controls are set based on regulatory requirements and can only be reviewed by reaching out to an Account Services team member.", "items": { "$ref": "#/components/schemas/NonPciTransactionUsage" } }, "enable_auto_conversion": { "type": "boolean", "description": "Whether auto currency conversion is enabled." }, "primary_currency": { "type": "string", "description": "The designated primary currency used as the funding source for auto currency conversion." }, "remote_auth_settings": { "$ref": "#/components/schemas/NonPciRemoteAuthConfig", "description": "Remote authorization config. Please read the [remote auth product documentation](/docs/issuing/card-controls/remote-authorization) for more information. You will need to reach out to our support team to enable this feature for you." }, "remote_call_config": { "$ref": "#/components/schemas/NonPciRemoteCallConfig", "description": "Remote call config. You will need to reach out to our support team to enable this feature for you." }, "remote_provisioning_config": { "$ref": "#/components/schemas/NonPciRemoteProvisioningConfig", "description": "Digital wallet remote provisioning config. You will need to reach out to our support team to enable this feature for you." }, "spending_limit_settings": { "$ref": "#/components/schemas/NonPciSpendingLimitSettings", "description": "Spending limit settings. The default and maximum limits can be modified by reaching out to an Account Services team member. " } } }, "NonPciDeviceInformation": { "type": "object", "properties": { "device_id": { "type": "string", "description": "The identifier for the device associated with the token." }, "device_type": { "type": "string", "description": "Type of device associated with the token \nOne of `MOBILE_PHONE`, `TABLET`, `WATCH`, `MOBILEPHONE_OR_TABLET`, `PC`.", "enum": [ "MOBILE_PHONE", "TABLET", "WATCH", "MOBILEPHONE_OR_TABLET", "PC", "UNKNOWN" ] } }, "description": "Additional information related to the device associated with the token." }, "NonPciRiskInformation": { "type": "object", "properties": { "wallet_provider_account_score": { "type": "string", "description": "Indicates the wallet providers confidence in the account between 1 to 5, where 5 indicates the most confidence in the account." }, "wallet_provider_device_score": { "type": "string", "description": "Indicates the wallet providers confidence in the device between 1 to 5, where 5 indicates the most confidence in the device." } }, "description": "General risk information about the token." }, "NonPciDigitalWalletToken": { "type": "object", "properties": { "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the card associated with the token." }, "cardholder_id": { "type": "string", "format": "uuid", "description": "Unique identifier for the cardholder associated with the token." }, "create_time": { "type": "string", "description": "The time this token was created." }, "device_information": { "$ref": "#/components/schemas/NonPciDeviceInformation", "description": "Additional information related to the device associated with the token." }, "expiry_month": { "type": "integer", "format": "int32", "description": "Token expiry month." }, "expiry_year": { "type": "integer", "format": "int32", "description": "Token expiry year." }, "masked_card_number": { "type": "string", "description": "Masked card number." }, "pan_reference_id": { "type": "string", "description": "Unique identifier for the tokenization of this card. Used by mobile SDKs to determine whether this card has already been provisioned to the device." }, "risk_information": { "$ref": "#/components/schemas/NonPciRiskInformation", "description": "General risk information about the token." }, "token_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the token." }, "token_reference_id": { "type": "string", "description": "Unique identifier of the digital wallet token within the card network." }, "token_status": { "type": "string", "description": "Status of the token \nOne of `ACTIVE`, `INACTIVE`, `SUSPENDED`, `DEACTIVATED`.", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "DEACTIVATED", "UNKNOWN" ] }, "token_type": { "type": "string", "description": "The type of this token \nOne of `SECURE_ELEMENT`, `HCE`, `CARD_ON_FILE`, `ECOMMERCE`, `QRC`.", "enum": [ "SECURE_ELEMENT", "HCE", "CARD_ON_FILE", "ECOMMERCE", "QRC", "UNKNOWN" ] } } }, "NonPciMerchantBrand": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the merchant brand." }, "logo_url": { "type": "string", "description": "URL of the merchant brand logo image." }, "name": { "type": "string", "description": "Current name of the merchant brand. Please note, this is subject to change at any time, please do not rely on it for business logic." } } }, "NonPciBookmarkedResultOfIssuingNonPciMerchantBrand": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciMerchantBrand" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } } }, "NonPciAdditionalInfo": { "type": "object", "properties": { "actual_delivery_date": { "type": "string", "description": "The date on which the cardholder actually received the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "attempted_return_date": { "type": "string", "description": "The date on which the cardholder attempted to return the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." }, "card_charge_permission_withdrawn_date": { "type": "string", "description": "The date on which the cardholder withdrew permission for the card charge (e.g. cancelled a subscription or recurring payment). Strongly recommended to set this field when dispute reason is RECURRING_CANCELED." }, "expected_delivery_date": { "type": "string", "description": "The date by which the cardholder expected to receive the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_RECEIVED or GOODS_SERVICE_CANCELED." }, "order_cancellation_date": { "type": "string", "description": "The date on which the goods, service, or reservation was cancelled. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_CANCELED." }, "returned_date": { "type": "string", "description": "The date on which the cardholder returned the goods or service. Strongly recommended to set this field when dispute reason is GOODS_SERVICE_NOT_AS_DESCRIBED or GOODS_DAMAGED." } }, "description": "Additional information for the dispute." }, "NonPciDisputeMessage": { "type": "object", "discriminator": { "propertyName": "type" }, "properties": { "evidence_files": { "type": "array", "description": "The list of file id containing the evidence added to the dispute during the dispute process.", "items": { "type": "string" } }, "note": { "type": "string", "description": "The note added to the dispute." }, "updated_at": { "type": "string", "description": "Time when the dispute was updated." }, "updated_by": { "type": "string", "description": "The party who updated the dispute.", "enum": [ "CUSTOMER", "AIRWALLEX" ] } } }, "NonPciTransactionDispute": { "type": "object", "discriminator": { "propertyName": "type" }, "properties": { "additional_info": { "$ref": "#/components/schemas/NonPciAdditionalInfo", "description": "Additional information for the dispute." }, "amount": { "type": "number", "description": "Dispute amount." }, "card_transaction_event_id": { "type": "string", "format": "uuid", "description": "The unique identifier for the disputed card transaction event." }, "created_at": { "type": "string", "description": "Time when the dispute was created." }, "detailed_status": { "type": "string", "description": "The detailed status of the dispute life cycle between Airwallex and the card scheme.", "enum": [ "DISPUTE_FILED", "PRE_ARB_RECEIVED", "PRE_ARB_DECLINED_BY_ISSUER", "ARBITRATION_RECEIVED", "DISPUTE_DECLINED", "PRE_ARB_DELIVERED", "PRE_ARB_DECLINED_BY_ACQUIRER", "ARB_DELIVERED", "WON", "LOST" ] }, "id": { "type": "string", "format": "uuid", "description": "The unique identifier for this dispute." }, "notes": { "type": "string", "description": "The latest notes that was added to the dispute." }, "reason": { "type": "string", "description": "The reason for raising the dispute. Learn more about the [dispute reasons](/docs/issuing/transactions/handle-transaction-disputes#dispute-reasons).", "enum": [ "SUSPECTED_FRAUD", "UNAUTHORIZED_TRANSACTION", "DUPLICATED_TRANSACTION", "PAID_BY_OTHER_MEANS", "GOODS_SERVICE_NOT_AS_DESCRIBED", "GOODS_DAMAGED", "GOODS_SERVICE_NOT_RECEIVED", "REFUND_UNPROCESSED", "GOODS_SERVICE_CANCELED", "RECURRING_CANCELED", "OTHER" ] }, "reference": { "type": "string", "description": "A value added for your internal reference." }, "status": { "type": "string", "description": "The latest status of the dispute. Learn more about the [dispute statuses](/docs/issuing/transactions/handle-transaction-disputes/dispute-statuses).", "enum": [ "DRAFT", "EXPIRED", "SUBMITTED", "REJECTED", "CANCELED", "IN_PROGRESS", "WON", "LOST" ] }, "update_history": { "type": "array", "items": { "$ref": "#/components/schemas/NonPciDisputeMessage" } }, "updated_at": { "type": "string", "description": "Time when the dispute was last updated." }, "updated_by": { "type": "string", "description": "The party who updated the dispute.", "enum": [ "CUSTOMER", "AIRWALLEX" ] } } }, "NonPciQueryDispute": { "type": "object", "properties": { "items": { "type": "array", "description": "array of the TransactionDispute resource.", "items": { "$ref": "#/components/schemas/NonPciTransactionDispute" } }, "page_after": { "type": "string", "description": "A pointer to the start of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the previous page of results." } } }, "NonPciTransaction": { "type": "object", "discriminator": { "propertyName": "type" }, "properties": { "acquiring_institution_identifier": { "type": "string", "description": "Unique Identifier for the acquiring institution." }, "auth_code": { "type": "string", "description": "Authorization Code." }, "billing_amount": { "type": "number", "description": "Billing amount." }, "billing_currency": { "type": "string", "description": "Billing Currency." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the card." }, "card_nickname": { "type": "string", "description": "The nickname of the card used." }, "client_data": { "type": "string", "description": "Client data stored against the card record." }, "digital_wallet_token_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for the digital token." }, "failure_reason": { "type": "string", "description": "The reason why this transaction failed (if status is FAILED). Can be one of: `ACCOUNT_INVALID`, `CARD_CLOSED`, `CARD_INACTIVE`, `CARD_INVALID`, `CARD_LOST_STOLEN`, `CARD_NOT_ACTIVATED`, `CARDHOLDER_VERIFICATION_FAILED`, `CURRENCY_NOT_ALLOWED`, `CVV_INVALID`, `EXPIRY_MISSING`, `INSUFFICIENT_FUNDS`, `INTERNAL_ERROR`, `INVALID_EXPIRY_DATE`, `LIMIT_EXCEEDED`, `MERCHANT_CATEGORY_NOT_ALLOWED`, `NOT_SUPPORTED`, `PIN_INVALID`, `PIN_RETRIES_EXCEEDED`, `REMOTE_AUTH_DECLINED`, `RESTRICTED_COUNTRY`, `SUSPECTED_FRAUD`, `TRANSACTION_BLOCKED`, `TRANSACTION_BLOCKED_AT_TERMINAL`, `CARD_REISSUED_TO_NEW_NUMBER`, `TRANSACTION_USAGE_DISABLED`, `MERCHANT_COUNTRY_NOT_ALLOWED`, `MERCHANT_BRAND_NOT_ALLOWED`, `MERCHANT_BRAND_CATEGORY_NOT_ALLOWED`, `MERCHANT_BRAND_SUBCATEGORY_NOT_ALLOWED`. Learn more about [transaction failure reasons](/docs/issuing/transactions/transaction-failure-reasons)." }, "fee_details": { "type": "array", "description": "List of fee details associated with the transaction.", "items": { "$ref": "#/components/schemas/NonPciFeeDetail" } }, "card_transaction_data": { "$ref": "#/components/schemas/NonPciCardTransactionData", "description": "Card transaction identifiers associated with this transaction. Replaces the lifecycle_id field. Omitted for transactions that have no associated card transaction lifecycle." }, "masked_card_number": { "type": "string", "description": "Masked card number." }, "matched_authorizations": { "type": "array", "description": "List of authorization ids for matching captures and reversals to their corresponding authorization. This is only available for authorizations made after 1st May 2022.", "items": { "type": "string" } }, "merchant": { "$ref": "#/components/schemas/NonPciMerchant", "description": "merchant of the card transaction." }, "network_transaction_id": { "type": "string", "description": "The transaction unique identifier from VISA network." }, "posted_date": { "type": "string", "description": "Date transaction posted ." }, "retrieval_ref": { "type": "string", "description": "Transaction retrieval reference number. Data element 37 of an financial transaction message (https://en.wikipedia.org/wiki/ISO_8583)." }, "risk_details": { "$ref": "#/components/schemas/NonPciRiskDetails", "description": "Risk details provides a comprehensive overview of the risk evaluation for a card transaction, including identified risk factors, actions taken by the risk engine, and the outcome of the 3D Secure authentication process. It encapsulates key elements that assess the potential threat level, safeguard the transaction, and ensure the cardholder’s identity is verified. N.b. this information will only be available for transactions on or after 1st Sept 2024." }, "status": { "type": "string", "description": "The status of this transaction. Can be one of: `APPROVED`, `CLEARED`, `EXPIRED`, `FAILED`, `PENDING`, `REVERSED`." }, "transaction_amount": { "type": "number", "description": "Transaction amount." }, "transaction_currency": { "type": "string", "description": "Transaction currency." }, "transaction_date": { "type": "string", "description": "Transaction date." }, "transaction_id": { "type": "string", "format": "uuid", "description": "An unique id for this authorization, a uuid." }, "transaction_type": { "type": "string", "description": "Transaction type - one of `AUTHORIZATION`, `CLEARING`, `REFUND`, `REVERSAL`, `ORIGINAL_CREDIT`." } } }, "ApplePayRegisteredDomains": { "type": "object", "properties": { "items": { "type": "array", "description": "All registered domains.", "items": { "type": "string" } } } }, "BankResources": { "type": "object", "properties": { "logo_url": { "type": "string", "description": "URLs of the bank logos." } }, "description": "The resources provided to render your bank list." }, "BankConfig": { "type": "object", "required": [ "bank_name", "display_name", "resources" ], "properties": { "bank_name": { "type": "string", "description": "The code name of the bank. Pass it to confirm Payment Intent if `bank_name` is needed." }, "display_name": { "type": "string", "description": "The bank name for display." }, "resources": { "$ref": "#/components/schemas/BankResources", "description": "The resources provided to render your bank list." } } }, "ConvertibleShopperCurrencies": { "type": "object", "properties": { "items": { "type": "array", "description": "A list of shopper currencies available for currency conversion. Each currency is represented by a 3-letter ISO-4217 code.", "items": { "type": "string" } } } }, "PaymentMethodTypeConfig": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Indicate whether the payment method type is active." }, "flows": { "type": "array", "description": "The supported flows for the payment method type and the transaction mode. One of `qrcode`, `mobile_web`, `mobile_app`.", "items": { "type": "string" } }, "name": { "type": "string", "description": "The type of payment method. Can be `card`, `wechatpay`, `alipaycn`, `alipayhk`, `kakaopay`, `tng`, `truemoney`, `dana`, `gcash`, etc. " }, "transaction_currencies": { "type": "array", "description": "The supported transaction currencies for the payment method type and the transaction mode.", "items": { "type": "string" } }, "transaction_mode": { "type": "string", "description": "Indicate in which mode you trigger transactions with the payment method type. One of `oneoff`, `recurring`.\n" } } }, "DelayedPlan": { "type": "object", "properties": { "delay_in_days": { "type": "integer", "format": "int32", "description": "the number of days that transaction amount will be held in your reserve account before they are released." } }, "description": "`DELAYED` reserve plan." }, "DelayedRollingPlan": { "type": "object", "properties": { "delay_in_days": { "type": "integer", "format": "int32", "description": "the number of days that transaction amount will be held in your reserve account after transaction." }, "rolling_percentage": { "type": "number", "description": "the percentage of the transaction amount that will be held in the reserve account after `delay_in_days`." }, "rolling_window_in_days": { "type": "integer", "format": "int32", "description": "the number of days that the reserved funds will be held in the reserve account after `delay_in_days`." } }, "description": "`DELAYED_ROLLING` reserve plan." }, "RollingPlan": { "type": "object", "properties": { "rolling_percentage": { "type": "number", "description": "the percentage of the transaction amount that will be held in the reserve account." }, "rolling_window_in_days": { "type": "integer", "format": "int32", "description": "the number of days that the reserved funds will be held before they are released." } }, "description": "`ROLLING` reserve plan." }, "ReservePlan": { "type": "object", "properties": { "delayed": { "$ref": "#/components/schemas/DelayedPlan", "description": "`DELAYED` reserve plan." }, "delayed_rolling": { "$ref": "#/components/schemas/DelayedRollingPlan", "description": "`DELAYED_ROLLING` reserve plan." }, "rolling": { "$ref": "#/components/schemas/RollingPlan", "description": "`ROLLING` reserve plan." }, "type": { "type": "string", "description": "The type of the reserve plan. Possible values: \n \n\n- `DELAYED`: All funds will settle to your wallet `delayed.delay_in_days` days after transaction.\n- `ROLLING`: `rolling.rolling_percentage` percent of funds will be held for `rolling.rolling_window_in_days` days, while the rest will settle in 2-3 days after transaction.\n- `DELAYED_ROLLING`: Combination of `DELAYED` and `ROLLING` reserve plans. All funds will be held for `delayed_rolling.delay_in_days` days and `delayed_rolling.rolling_percentage` percent of funds will be held for additional `delayed_rolling.rolling_window_in_days` after transaction." } } }, "ConversionQuote": { "type": "object", "properties": { "conversion_rate": { "type": "number", "description": "The conversion rate from the merchant currency to the shopper currency." }, "created_at": { "type": "string", "description": "Time at which this Conversion Quote was created." }, "expires_at": { "type": "string", "description": "Time at which this Conversion Quote expires." }, "id": { "type": "string", "description": "Unique identifier of the Conversion Quote." }, "merchant_currency": { "type": "string", "description": "The currency used by the merchant for pricing or payment (3-letter ISO 4217 code)." }, "shopper_currency": { "type": "string", "description": "The currency that the shopper prefers to use (3-letter ISO-4217 code)." }, "status": { "type": "string", "description": "Status of the Conversion Quote \n\n- **CREATED**: The conversion quote has been created and is valid for use.\n- **EXPIRED**: The conversion quote has expired.\n" }, "validity_period": { "type": "string", "description": "The period for which the conversion quote remains valid. One of `HR_1`, `HR_24`." } } }, "CustomerBalanceTransactionResponse": { "description": "A transaction that records a change in the balance of funds held on behalf of a customer. For more about customer balances and how they apply to bank transfers, see the [Customer balance transactions](/docs/payments/payment-methods/global/bank-transfer/customer-balance-transactions) guide.", "type": "object", "required": [ "id", "type", "created_at" ], "properties": { "applied_to_payment": { "type": "object", "description": "Details of the funds applied to a payment. Present when `type` is `applied_to_payment`. If the funds are applied to several payments, a separate Customer Balance Transaction is created for each payment.", "properties": { "amount": { "type": "number", "description": "Matched payment amount." }, "currency": { "type": "string", "description": "Matched payment currency." }, "customer_balance_transaction_id": { "type": "string", "description": "ID of the Customer Balance Transaction the funds were applied from." }, "payment_attempt_id": { "type": "string", "description": "PaymentAttempt ID that the funds were applied to." }, "payment_intent_amount": { "type": "number", "description": "Original amount of the PaymentIntent." }, "payment_intent_id": { "type": "string", "description": "PaymentIntent ID that the funds were applied to." } } }, "bank_transfer": { "type": "object", "description": "Details of the bank transfer received. Present when `type` is `bank_transfer`.", "properties": { "amount": { "type": "number", "description": "The bank transfer amount received from the customer. This may be more or less than the expected payment amount, for example in overpayment or underpayment scenarios." }, "bank_transfer_instructions": { "type": "object", "description": "Bank transfer instructions provided by Airwallex for the customer to transfer the funds to.", "properties": { "account_name": { "type": "string", "description": "Account holder name of the Airwallex bank account the customer transfers the funds to." }, "account_number": { "type": "string", "description": "Account number of the Airwallex bank account the customer transfers the funds to." }, "bank_name": { "type": "string", "description": "Bank name of the Airwallex bank account the customer transfers the funds to." } } }, "currency": { "type": "string", "description": "Payment currency in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payer": { "type": "object", "description": "Details of the bank transfer payer.", "properties": { "account_name": { "type": "string", "description": "Payer bank account name." }, "account_number": { "type": "string", "description": "Payer bank account number." }, "bank_name": { "type": "string", "description": "Payer bank name." }, "customer_id": { "type": "string", "description": "Associated Customer ID if the payer is a registered customer." }, "payer_email": { "type": "string", "description": "Payer email address." }, "payer_name": { "type": "string", "description": "Payer name." } } }, "received_at": { "type": "string", "format": "date-time", "description": "Time when the bank transfer funds were received." }, "status": { "type": "string", "description": "Status of the bank transfer. One of:\n- `RECEIVED` - The funds have been received.\n- `PENDING_REVIEW` - The bank transfer requires review before it can be accepted. Airwallex will send you a Request for Information (RFI) — you must respond to the RFI for the fund to be applied to the payment. Review may take several days.\n- `FAILED` - The bank transfer was rejected during review or by the bank.\n- `SUCCEEDED` - The bank transfer has been accepted.", "enum": [ "RECEIVED", "PENDING_REVIEW", "FAILED", "SUCCEEDED" ] } } }, "bank_transfer_reversal": { "type": "object", "description": "Details of the bank transfer reversal. Present when `type` is `bank_transfer_reversal`.", "properties": { "amount": { "type": "number", "description": "Reversal amount." }, "beneficiary": { "type": "object", "description": "The beneficiary of the bank transfer reversal, that is, the payer who receives the reversed funds.", "properties": { "account_name": { "type": "string", "description": "Beneficiary bank account holder name." }, "account_number": { "type": "string", "description": "Beneficiary bank account number. Either the account number or the IBAN is provided." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." } } }, "currency": { "type": "string", "description": "Payment currency in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "customer_balance_transaction_id": { "type": "string", "description": "ID of the Customer Balance Transaction (the original bank transfer fund record) being reversed." }, "failure_code": { "type": "string", "description": "The failure code for the bank transfer reversal. Returned only when the reversal failed." }, "failure_reason": { "type": "string", "description": "The reason the bank transfer reversal failed. Returned only when the reversal failed." }, "payment_attempt_id": { "type": "string", "description": "Associated PaymentAttempt ID." }, "payment_intent_id": { "type": "string", "description": "Associated PaymentIntent ID." }, "refund_id": { "type": "string", "description": "Associated Refund ID." }, "remitter": { "type": "object", "description": "The remitting bank account that Airwallex sends the reversal from.", "properties": { "account_name": { "type": "string", "description": "Name on the remitting bank account that Airwallex sends the reversal from." }, "account_number": { "type": "string", "description": "Number of the remitting bank account that Airwallex sends the reversal from." }, "bank_reference": { "type": "string", "description": "Reference that the merchant and payer can use to track bank transfer reversal progress with the payer's bank." } } }, "reversal_fee": { "type": "number", "description": "Fee charged for this bank transfer reversal." }, "reversal_reason": { "type": "string", "description": "The reason the bank transfer reversal occurred." }, "status": { "type": "string", "description": "Status of the bank transfer reversal. One of:\n- `CREATED` - The reversal has been created.\n- `PENDING_REVIEW` - The reversal requires review before it can proceed. Airwallex will send you a Request for Information (RFI) — you must respond to the RFI for the funds to be returned to the payer. Review may take several days.\n- `FAILED` - The reversal failed and the funds were not returned to the payer. It was rejected during Airwallex review or by the bank. See `failure_reason` and `failure_code` for details.\n- `SUCCEEDED` - The reversal has succeeded.", "enum": [ "CREATED", "PENDING_REVIEW", "FAILED", "SUCCEEDED" ] } } }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which the Customer Balance Transaction was created." }, "id": { "type": "string", "description": "Unique ID for the Customer Balance Transaction." }, "type": { "type": "string", "description": "The transaction type. One of:\n- `bank_transfer` - Adds bank transfer funds to the customer balance.\n- `bank_transfer_reversal` - Reverses a previous bank transfer transaction and deducts the corresponding amount from the customer balance.\n- `applied_to_payment` - Applies bank transfer funds from the customer balance to a payment, reducing the available customer balance. If the funds are applied to several payments, a separate Customer Balance Transaction is created for each payment.", "enum": [ "bank_transfer", "bank_transfer_reversal", "applied_to_payment" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "Time at which the Customer Balance Transaction was last updated or operated on." } } }, "Customer": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "Address of the customer." }, "business_name": { "type": "string", "description": "Business name of the customer." }, "client_secret": { "type": "string", "description": "Customer's client secret for browser or app. Only returned by Customer create API. \n\nThe provided client_secret is valid for 60 minutes." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which the Customer was created." }, "email": { "type": "string", "description": "Email address of the Customer." }, "first_name": { "type": "string", "description": "First name of the Customer." }, "id": { "type": "string", "description": "Unique identifier for the Customer." }, "last_name": { "type": "string", "description": "Last name of the Customer." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of the Customer in merchant's system. Maximum length is 64." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Customer. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "phone_number": { "type": "string", "description": "Phone number of the Customer." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which the customer was updated or operated on." } } }, "CustomerClientSecret": { "type": "object", "properties": { "client_secret": { "type": "string", "description": "Customer's client secret for browser or app. Only returned by Customer create API. \n\nThe provided client_secret is valid for 60 minutes." }, "expired_time": { "type": "string", "format": "date-time", "description": "Time at when the client secret expires." } } }, "CustomsDetails": { "type": "object", "required": [ "customs_code", "merchant_customs_name", "merchant_customs_number" ], "properties": { "customs_code": { "type": "string", "description": "China customs code, please refer to here for information https://www.airwallex.com/docs/payments/apac/wechat-pay/customs-declaration,https://www.airwallex.com/docs/payments/apac/alipay/customs-declaration." }, "merchant_customs_name": { "type": "string", "description": "Merchant's registered name in customs system. Maximum length is 256." }, "merchant_customs_number": { "type": "string", "description": "Merchant's registered number in customs system. Maximum length is 32." } }, "description": "Customs details." }, "SubOrder": { "type": "object", "required": [ "amount", "currency", "order_number", "shipping_fee" ], "properties": { "amount": { "type": "number", "description": "The total amount of your sub_order, shipping fee shall be included, unit is Yuan. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "currency": { "type": "string", "description": "Currency for the suborder, only CNY supported now." }, "order_number": { "type": "string", "description": "Suborder number in merchant system. Maximum length is 128." }, "provider_order_id": { "type": "string", "description": "The unique transaction identifier assigned by the provider for your sub_order. Please use this field as the provider transaction no. for your order information/shipment information’s declaration. Example of our providers: Cards, WeChat, Alipay etc." }, "shipping_fee": { "type": "number", "description": "Suborder transport fee, unit is Yuan." } }, "description": "Suborder info, required for each customs declaration." }, "CustomsDeclaration": { "type": "object", "properties": { "awx_request_id": { "type": "string", "description": "Request unique identifier generated by Air Wallex send to the provider for a Payment Attempt." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which the Customs Declaration was created." }, "customs_details": { "$ref": "#/components/schemas/CustomsDetails", "description": "Customs details." }, "customs_status_message": { "type": "string", "description": "Additional status message from customs." }, "id": { "type": "string", "description": "Unique identifier for the Customs Declaration." }, "payment_method_type": { "type": "string", "description": "Payment method type of the Payment Attempt." }, "provider_transaction_id": { "type": "string", "description": "The unique transaction identifier assigned by the provider for a payment attempt. Example of our providers: Cards, WeChat, Alipay etc." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "shopper_identity_check_result": { "type": "string", "description": "Identity check result of the shopper." }, "status": { "type": "string", "description": "Customs processing status, UNDECLARED/PROCESSING/SUCCESS/FAIL." }, "sub_order": { "$ref": "#/components/schemas/SubOrder", "description": "Suborder info, required for each customs declaration." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which the Customs Declaration was updated or operated on." }, "verification_department_code": { "type": "string", "description": "Verification department code." }, "verification_department_transaction_id": { "type": "string", "description": "Transaction unique identifier returned by verification department." } } }, "FundsSplitReversal": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split." }, "created_at": { "type": "string", "format": "date-time", "description": "Instant when this split reversal is created at." }, "funds_split_id": { "type": "string", "description": "Funds Split unique identifier." }, "id": { "type": "string", "description": "Unique identifier for the Funds Split Reversal." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "status": { "type": "string", "description": "Status of this reversal, can be CREATED, RELEASED, SETTLED etc." } } }, "FundSplit": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of this split." }, "auto_release": { "type": "boolean", "description": "Release type of this split." }, "created_at": { "type": "string", "format": "date-time", "description": "Instant when this split is created at." }, "currency": { "type": "string", "description": "Currency of this split." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts." }, "id": { "type": "string", "description": "Unique identifier for the Funds Split." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Funds Split. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "source_id": { "type": "string", "description": "The source unique identifier of the transaction that this split is created from." }, "source_type": { "type": "string", "description": "Transaction source type, such as PAYMENT_INTENT." }, "status": { "type": "string", "description": "Status of this split, one of CREATED, RELEASED, SETTLED." } } }, "DsData": { "type": "object", "properties": { "cavv": { "type": "string", "description": "Cardholder Authentication Verification Value. Base64-encoded 28-character string." }, "challenge_cancellation_reason": { "type": "string", "description": "Challenge cancellation reason." }, "eci": { "type": "string", "description": "Electronic Commerce Indicator. As defined by 3D-Secure.\n- `00`: **Mastercard variant**: Authentication failed.\n- `01`: **Mastercard variant**: Authentication attempted.\n- `02`: **Mastercard variant**: Authentication succeeded.\n- `04`: **Mastercard variant**: Frictionless authentication via data only mode.\n- `05`: Authentication succeeded.\n- `06`: Authentication attempted. **Mastercard variant**: Exempted from Strong Customer Authentication.\n- `07`: Authentication failed or exempted. **Mastercard variant**: Recurring transaction successfully authenticated.\n- `null`: Not applicable or 3DS authentication was not performed.\n" }, "enrolled": { "type": "string", "description": "Indicates whether the cardholder is enrolled in 3D-Secure.\n- `Y`: Cardholder is enrolled.\n- `N`: Cardholder is not enrolled.\n- `U`: Unable to determine enrollment status.\n- `null`: Not applicable or enrollment check was not performed.\n" }, "frictionless": { "type": "string", "description": "Indicates whether 3DS passed in frictionless flow.\n- `Y`: 3DS passed in frictionless flow.\n- `N`: 3DS entered challenge flow.\n- `null`: Not applicable or 3DS authentication was not performed.\n" }, "liability_shift_indicator": { "type": "string", "description": "Indicates whether liability has shifted to the card issuer.\n- `Y`: Liability has shifted to the issuer.\n- `N`: Liability has not shifted.\n- `null`: Not applicable or unable to determine.\n" }, "pa_res_status": { "type": "string", "description": "Payment Authentication Response (PARes) status.\n- `Y`: Authentication successful.\n- `N`: Authentication failed.\n- `U`: Authentication could not be performed.\n- `A`: Authentication attempted but not completed.\n- `C`: Challenge required.\n- `R`: Authentication rejected.\n- `null`: Not applicable or authentication was not performed.\n" }, "version": { "type": "string", "description": "3ds version." }, "xid": { "type": "string", "description": "XID" } }, "description": "3DS data." }, "RiskFactor": { "type": "object", "properties": { "description": { "type": "string", "description": "Risk factor description." } } }, "FraudDataDetail": { "type": "object", "properties": { "action": { "type": "string", "description": "Fraud action." }, "risk_factors": { "type": "array", "description": "Risk factors.", "items": { "$ref": "#/components/schemas/RiskFactor" } }, "score": { "type": "string", "description": "Fraud score." } }, "description": "Post-authorization fraud check data." }, "FraudData": { "type": "object", "properties": { "action": { "type": "string", "description": "Fraud action." }, "post_authorization_check": { "$ref": "#/components/schemas/FraudDataDetail", "description": "Post-authorization fraud check data." }, "risk_factors": { "type": "array", "description": "Risk factors.", "items": { "$ref": "#/components/schemas/RiskFactor" } }, "score": { "type": "string", "description": "Fraud score." } }, "description": "Fraud data." }, "ScaExemption": { "type": "object", "properties": { "applied_exemption": { "type": "string", "description": "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`." }, "requested_exemption": { "type": "string", "description": "The SCA exemption type requested by the merchant for Airwallex to use. Possible values: `LOW_RISK_TRANSACTION`, `LOW_VALUE`, `SECURE_CORPORATE_PAYMENT`, `ANONYMOUS`." } } }, "AuthenticationData": { "type": "object", "properties": { "authentication_type": { "type": "string", "description": "The method used to authenticate this transaction. Possible values: passkey, 3ds, none." }, "avs_result": { "type": "string", "description": "AVS result." }, "cvc_result": { "type": "string", "description": "CVC result." }, "ds_data": { "$ref": "#/components/schemas/DsData", "description": "3DS data." }, "fraud_data": { "$ref": "#/components/schemas/FraudData", "description": "Fraud data." }, "passkey_setup_status": { "type": "string", "description": "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`\n- `SETUP_COMPLETED`: Payment passkey was successfully set up.\n- `ALREADY_SETUP`: Payment passkey was already set up for this card/device combination in a previous transaction.\n- `FAILED_TO_SETUP`: Attempted to set up a payment passkey, but the setup failed.\n- `NOT_TRIGGERED`: Payment passkey setup was not supported or not applicable for this transaction (transaction was not processed via the passkey flow)." }, "sca_exemption": { "$ref": "#/components/schemas/ScaExemption", "description": "SCA exemption indicators for this transaction." } }, "description": "Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result." }, "Dcc": { "type": "object", "properties": { "amount": { "type": "number", "description": "DCC amount." }, "currency": { "type": "string", "description": "DCC currency." } }, "description": "Present when DCC amount is available and DCC currency is different from Payment Intent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product." }, "MicroDebitResult": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of micro_debit." } }, "description": "The result of micro debit." }, "MicroDepositResult": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of micro_deposit." } }, "description": "The result of micro deposit." }, "AchDirectDebit": { "type": "object", "properties": { "aba_routing_number": { "type": "string", "description": "9-digit number to identify a bank in the US." }, "account_number": { "type": "string", "description": "4-17 digits number to identify a bank account in the US." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account." }, "micro_debit": { "$ref": "#/components/schemas/MicroDebitResult", "description": "The result of micro debit." }, "micro_deposit": { "$ref": "#/components/schemas/MicroDepositResult", "description": "The result of micro deposit." }, "owner_email": { "type": "string", "description": "Email of the account holder." }, "owner_name": { "type": "string", "description": "Name of the account holder." } }, "description": "ACH Direct Debit information." }, "AirwallexPay": { "type": "object", "properties": { "payer_name": { "type": "string", "description": "Name of the payer. Only returned for successful payments." } }, "description": "Airwallex Pay information." }, "Alfamart": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Alfamart information." }, "Alipaycn": { "type": "object", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`, `mini_program`." }, "os_type": { "type": "string", "description": "ios, android." }, "shopper_login_id": { "type": "string", "description": "Alipay's User Login Id (Shopper) for Payment Consent Verification." }, "user_id": { "type": "string", "description": "Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified." }, "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } } }, "description": "Alipay CN information." }, "AlipayConnect": { "type": "object", "properties": { "flow": { "type": "string", "description": "One of `qrcode`, `mobile_web`, `mobile_app`." }, "os_type": { "type": "string", "description": "ios, android." }, "shopper_login_id": { "type": "string", "description": "Alipay's User Login Id (Shopper) for Payment Consent Verification." }, "user_id": { "type": "string", "description": "Unique identifier of a user in payment method provider side. Only present after the payment has been completed or the consent has been verified." }, "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } } }, "description": "Alipay HK information." }, "Billing": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "The billing address as it appears on the credit card issuer’s records." }, "date_of_birth": { "type": "string", "description": "Date of birth of the customer in the format: YYYY-MM-DD." }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } }, "description": "Billing information." }, "Emv": { "type": "object", "required": [ "emv_data" ], "properties": { "emv_data": { "type": "string", "description": "Output from the Secure Element." }, "encrypted_pin_data": { "type": "string", "description": "The PIN encrypted using the bank’s key." } }, "description": "EMV data." }, "ThreeDomainSecure": { "type": "object", "required": [ "online_payment_cryptogram" ], "properties": { "eci_indicator": { "type": "string", "description": "Electronic Commerce Indicator, as defined by 3-D Secure." }, "online_payment_cryptogram": { "type": "string", "description": "Online payment cryptogram, as defined by 3-D Secure." } }, "description": "3D-Secure authentication data." }, "AuthenticationMethod": { "type": "object", "required": [ "type" ], "properties": { "emv": { "$ref": "#/components/schemas/Emv", "description": "EMV data." }, "three_ds": { "$ref": "#/components/schemas/ThreeDomainSecure", "description": "3D-Secure authentication data." }, "type": { "type": "string", "description": "The authentication method type. One of `CRYPTOGRAM_3DS`, `PAN_ONLY`." } }, "description": "Authentication method." }, "TokenizedCard": { "type": "object", "required": [ "expiry_month", "expiry_year" ], "properties": { "authentication_method": { "$ref": "#/components/schemas/AuthenticationMethod", "description": "Authentication method." }, "bin": { "type": "string", "description": "Bank identify number of this card." }, "brand": { "type": "string", "description": "Brand of the card. One of `visa`, `mastercard`, `maestro`, `chinaunionpay`." }, "device_manufacturer_identifier": { "type": "string", "description": "Device manufacturer identifier." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "fingerprint": { "type": "string", "description": "Fingerprint of the card." }, "is_commercial": { "type": "boolean", "description": "A boolean field referring whether the card is commercial or not." }, "issuer_country_code": { "type": "string", "description": "Country code of the card issuer." }, "issuer_name": { "type": "string", "description": "Issuer name." }, "last4": { "type": "string", "description": "Last four digits of the card number." }, "name": { "type": "string", "description": "Cardholder name." }, "type": { "type": "string", "description": "The card's type of payment. One of `credit` or `debit`." } }, "description": "Payment data with the tokenized card details." }, "Applepay": { "type": "object", "properties": { "billing": { "$ref": "#/components/schemas/Billing", "description": "Billing information." }, "lifecycle_id": { "type": "string", "description": "Identifier used to link the transaction to the original or previous transaction in a subscription or card-on-file chain. Currently supported only for Mastercard." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "$ref": "#/components/schemas/TokenizedCard", "description": "Payment data with the tokenized card details." } }, "description": "Apple pay information." }, "Atome": { "type": "object", "properties": { "shopper_phone": { "type": "string", "description": "Customer's mobile number, formatted in [E.164](https://en.wikipedia.org/wiki/E.164) standard." } }, "description": "Atome information." }, "BacsDirectDebitAddress": { "type": "object", "required": [ "line1", "postcode", "town" ], "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes. One of `GB`, `US`. Default to `GB` if not provided." }, "line1": { "type": "string", "description": "House number and street name, e.g., `777 Casino Drive`." }, "line2": { "type": "string", "description": "Locality name, e.g., `Apartment 123`." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address. Should be provided if country code is `US`. Use the two-character ISO3166-2:US state code." }, "town": { "type": "string", "description": "Post town." } }, "description": "Account holder's address." }, "BacsDirectDebit": { "type": "object", "properties": { "account_number": { "type": "string", "description": "8 digits number to identify a bank account in the UK." }, "address": { "$ref": "#/components/schemas/BacsDirectDebitAddress", "description": "Account holder's address." }, "bank_name": { "type": "string", "description": "Bank of the account. You can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account." }, "micro_deposit": { "$ref": "#/components/schemas/MicroDepositResult", "description": "The result of micro deposit." }, "owner_email": { "type": "string", "description": "Email of the account holder." }, "owner_name": { "type": "string", "description": "Name of the account holder." }, "sort_code": { "type": "string", "description": "6-digit number to identify a bank in the UK." } }, "description": "BACS Direct Debit information." }, "Bancontact": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Bancontact information." }, "BankTransfer": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "expires_at": { "type": "string", "description": "Expiry time of this attempt, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "ga_mode": { "type": "string", "description": "The type of GA mode." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Bank Transfer information." }, "BecsDirectDebit": { "type": "object", "properties": { "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account." }, "micro_debit": { "$ref": "#/components/schemas/MicroDebitResult", "description": "The result of micro debit." }, "micro_deposit": { "$ref": "#/components/schemas/MicroDepositResult", "description": "The result of micro deposit." }, "owner_email": { "type": "string", "description": "Account holder's email." }, "owner_name": { "type": "string", "description": "Account holder name." } }, "description": "BECS Direct Debit information." }, "Bitpay": { "type": "object", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Bit Pay information." }, "Blik": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "BLIK information." }, "Boost": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Boost information." }, "CardAdditionalInfo": { "type": "object", "properties": { "merchant_verification_value": { "type": "string", "description": "Merchant Verification Value (Provided by VISA during onboarding)\nor\nMasterCard Assigned ID (Provided by MasterCard during onboarding)." }, "token_requestor_id": { "type": "string", "description": "Token requestor unique identifier (Provided by card schemes during onboarding)." } }, "description": "Additional information of external network token requestor. Would return when number_type is `EXTERNAL_NETWORK_TOKEN`." }, "CardUpdaterInfo": { "type": "object", "properties": { "expiry_updated": { "type": "boolean", "description": "Expiry was updated (true or false)." }, "number_updated": { "type": "boolean", "description": "Account number was updated (true or false)." } }, "description": "Specifies if card information got updated." }, "KoreanCardData": { "type": "object", "properties": { "business_number": { "type": "string", "description": "A 10-digit business number of the company." }, "date_of_birth": { "type": "string", "description": "A 6-digit date of birth in the format of YYMMDD." }, "password_first2": { "type": "string", "description": "Card password first 2 digits." } }, "description": "Information for Korean Card." }, "CardAttempt": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/CardAdditionalInfo", "description": "Additional information of external network token requestor. Would return when number_type is `EXTERNAL_NETWORK_TOKEN`." }, "billing": { "$ref": "#/components/schemas/Billing", "description": "Billing information." }, "bin": { "type": "string", "description": "Bank identify number of this card." }, "brand": { "type": "string", "description": "Brand of the card. One of `mastercard`, `visa`, `union pay`, `american express`, `jcb`, `discover`, `diners club international`." }, "card_type": { "type": "string", "description": "Funding type of the card." }, "card_updater_info": { "$ref": "#/components/schemas/CardUpdaterInfo", "description": "Specifies if card information got updated." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "fingerprint": { "type": "string", "description": "Fingerprint of the card." }, "is_commercial": { "type": "boolean", "description": "A boolean field referring whether the card is commercial or not." }, "issuer_country_code": { "type": "string", "description": "Country code of the card issuer." }, "issuer_name": { "type": "string", "description": "Issuer name." }, "korean_card": { "$ref": "#/components/schemas/KoreanCardData", "description": "Information for Korean Card." }, "last4": { "type": "string", "description": "Last four digits of the card number." }, "lifecycle_id": { "type": "string", "description": "Identifier used to link the transaction to the original or previous transaction in a subscription or card-on-file chain. Currently supported only for Mastercard." }, "name": { "type": "string", "description": "Card holder name." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`, `AIRWALLEX_NETWORK_TOKEN`." } }, "description": "Card information." }, "CardPresentReceipt": { "type": "object", "properties": { "retrieval_reference_number": { "type": "string", "description": "Retrieval reference number of the transaction." }, "system_trace_audit_number": { "type": "string", "description": "System trace audit number of the transaction." }, "terminal_verification_results": { "type": "string", "description": "Terminal verification result (EMV tag 95) of the transaction." } }, "description": "Data used for receipt printing of the transaction." }, "TerminalInfo": { "type": "object", "required": [ "pin_entry_capability", "supported_pan_entry_modes", "terminal_identifier" ], "properties": { "mobile_device": { "type": "boolean", "description": "Indicate whether the POS terminal is a mobile POS device. Default is `false`." }, "pin_entry_capability": { "type": "string", "description": "Describe the capability of the terminal device to accept PIN. \n- `unsupported`: Terminal does not have PIN entry capability. \n- `supported`: Terminal has PIN entry capability. Except the case suitable for software_based. \n- `software_based`: For a mobile POS device, a user can input PIN through software-based keyboard. \n- `disabled`: Terminal has PIN entry capability but PIN pad is not currently operative." }, "support_single_tap_with_pin": { "type": "boolean", "description": "Indicate whether the POS terminal could respond to a `request_pin` action. Default is `false`." }, "supported_pan_entry_modes": { "type": "array", "description": "List of `pan_entry_modes` supported by the terminal.", "items": { "type": "string" } }, "terminal_identifier": { "type": "string", "description": "An up to 8 digit alphanumeric unique identifier used to identify the terminal at the card acceptor location of the user’s POS system." }, "terminal_type": { "type": "string", "description": "Type of the POS terminal that processes this payment. \n- `attended_pos`: dedicated pos devices that attended by a merchant staff. \n- `unattended_pos`: dedicated pos devices that not attended. \n- `android_softpos`: android mobile devices that can work as pos device with software. \n- `ios_softpos`: iOS mobile devices that can work as pos device with software." }, "use_embedded_reader": { "type": "boolean", "description": "Indicate whether the reader is embedded in a mobile POS device. Default is `true`." } }, "description": "Data obtained by the POS terminal from the card and terminal properties." }, "CardPresent": { "type": "object", "properties": { "aid": { "type": "string", "description": "Application Identifier (AID) of the card." }, "bin": { "type": "string", "description": "Bank identify number of this card." }, "brand": { "type": "string", "description": "Brand of the card." }, "card_sequence_number": { "type": "string", "description": "A unique identifier to distinguish among separate cards having the save PAN." }, "card_type": { "type": "string", "description": "Funding type of the card." }, "cardholder_verification_method": { "type": "string", "description": "Cardholder verification method." }, "contactless_card_form_factor": { "type": "string", "description": "Contactless Card Form Factor." }, "emv_tags": { "type": "string", "description": "Tag-length-value (TLV)-encoded data returned by issuers or card schemes." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "fallback": { "type": "boolean", "description": "Whether fallback happens when reading the card." }, "fallback_reason": { "type": "string", "description": "Fallback reason." }, "fingerprint": { "type": "string", "description": "Fingerprint of the card." }, "is_commercial": { "type": "boolean", "description": "A boolean field referring whether the card is commercial or not." }, "issuer_country_code": { "type": "string", "description": "Country code of the card issuer." }, "issuer_name": { "type": "string", "description": "Issuer name." }, "last4": { "type": "string", "description": "Last four digits of the card number." }, "name": { "type": "string", "description": "Card holder name." }, "pan_entry_mode": { "type": "string", "description": "The way the terminal reads the card information." }, "receipt": { "$ref": "#/components/schemas/CardPresentReceipt", "description": "Data used for receipt printing of the transaction." }, "terminal_info": { "$ref": "#/components/schemas/TerminalInfo", "description": "Data obtained by the POS terminal from the card and terminal properties." } }, "description": "Card-present information." }, "CashAppPay": { "type": "object", "properties": { "cashtag": { "type": "string", "description": "A unique identifier for individuals and businesses using Cash App. Only present for Payment Intents with verified consent.", "example": "$example_cashtag" } }, "description": "Cash App Pay information." }, "DokuEwallet": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Doku E-Wallet information." }, "Dragonpay": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Dragonpay information." }, "DuitNow": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Duit Now information." }, "EftDirectDebit": { "type": "object", "properties": { "account_number": { "type": "string", "description": "4-17 digits number to identify a bank account in Canada." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account." }, "institution_number": { "type": "string", "description": "3-digit number to identify a bank institution in Canada." }, "micro_debit": { "$ref": "#/components/schemas/MicroDebitResult", "description": "The result of micro debit." }, "micro_deposit": { "$ref": "#/components/schemas/MicroDepositResult", "description": "The result of micro deposit." }, "owner_email": { "type": "string", "description": "Email of the account holder." }, "owner_name": { "type": "string", "description": "Name of the account holder." }, "transit_number": { "type": "string", "description": "Identify a bank branch transit in Canada." } }, "description": "EFT Direct Debit information." }, "Eps": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "EPS information." }, "Esun": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "ESUN information." }, "FamilyMart": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Family Mart information." }, "Fps": { "type": "object", "properties": { "flow": { "type": "string", "description": "The specific FPS flow to use. Currently only support `qrcode`." } }, "description": "FPS information." }, "Fpx": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "FPX information." }, "GoPay": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Go Pay information." }, "Googlepay": { "type": "object", "properties": { "billing": { "$ref": "#/components/schemas/Billing", "description": "Billing information." }, "lifecycle_id": { "type": "string", "description": "Identifier used to link the transaction to the original or previous transaction in a subscription or card-on-file chain. Currently supported only for Mastercard." }, "payment_data_type": { "type": "string", "description": "Type of the payment data details. One of `tokenized_card` or `encrypted_payment_token`." }, "tokenized_card": { "$ref": "#/components/schemas/TokenizedCard", "description": "Payment data with the tokenized card details." } }, "description": "Google pay information." }, "Grabpay": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Grab Pay information." }, "HiLife": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Hi-Life information." }, "Ideal": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "i DEAL information." }, "Indomaret": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Indomaret information." }, "JeniusPay": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Jenius Pay information." }, "Klarna": { "type": "object", "required": [ "country_code" ], "properties": { "billing": { "$ref": "#/components/schemas/Billing", "description": "Billing information." }, "country_code": { "type": "string", "description": "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`." }, "language": { "type": "string", "description": "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. \nAT: `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`." } }, "description": "Klarna information." }, "Konbini": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Konbini information." }, "Linkaja": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Link Aja information." }, "Maxima": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Maxima information." }, "Multibanco": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Multibanco information." }, "Mybank": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "My Bank information." }, "Narvesen": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Narvesen information." }, "OnlineBanking": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Online Banking information." }, "Ovo": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "OVO information." }, "P24": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "P24 information." }, "PayNow": { "type": "object", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Pay Now information." }, "Paybybankapp": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Pay by Bank app information." }, "Payeasy": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Pay Easy information." }, "Paypal": { "type": "object", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Pay Pal information." }, "Paypost": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Paypost information." }, "Paysafecard": { "type": "object", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "paysafecard information." }, "Paysafecash": { "type": "object", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Paysafecash information." }, "Paysera": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Paysera information." }, "Bsb": { "type": "object", "properties": { "account_name": { "type": "string", "description": "The account name." }, "account_number": { "type": "string", "description": "4-9 digits number to identify a bank account in Australia." }, "bsb_number": { "type": "string", "description": "6-digit Bank-State-Branch number." } } }, "PayId": { "type": "object", "properties": { "australian_business_number": { "type": "string", "description": "11 digits number to identify the Pay Id. Required when `phone_number`, `owner_email`, and `organisation_id` is null." }, "organisation_id": { "type": "string", "description": "The organisation id of the recipient. The Pay ID must be in the format of `payid:airwallex.com`." }, "owner_email": { "type": "string", "description": "owner email to identify the Pay Id. Required when `phone_number`, `australian_business_number`, and `organisation_id` is null." }, "phone_number": { "type": "string", "description": "The phone number of the Pay Id. Required when `owner_email`, `australian_business_number`, and `organisation_id` is null." } }, "description": "The Pay ID of the recipient." }, "Payto": { "type": "object", "properties": { "bsb": { "$ref": "#/components/schemas/Bsb" }, "pay_id": { "$ref": "#/components/schemas/PayId", "description": "The Pay ID of the recipient." } }, "description": "Payto information." }, "Payu": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Pay U information." }, "PerlasTerminals": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Perlas terminals information." }, "PromptPay": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Prompt Pay information." }, "Satispay": { "type": "object", "properties": { "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Satispay information." }, "SepaDirectDebitAddress": { "type": "object", "required": [ "postcode", "street", "town" ], "properties": { "country_code": { "type": "string", "description": "Country code of the address. Use the two-character ISO Standard Country Codes." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "street": { "type": "string", "description": "street of the address. " }, "town": { "type": "string", "description": "town of the address." } }, "description": "Account holder's address." }, "SepaDirectDebit": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/SepaDirectDebitAddress", "description": "Account holder's address." }, "bank_name": { "type": "string", "description": "Bank of the account. You can call [API to retrieve the available bank names](/docs/api/payments/config/banks)." }, "business_account": { "type": "boolean", "description": "Indicate whether the account is a business account." }, "country_code": { "type": "string", "description": "The 2-letter ISO country/region code from which the consumer will be paying." }, "iban": { "type": "string", "description": "15–34 characters to identify a bank account." }, "micro_debit": { "$ref": "#/components/schemas/MicroDebitResult", "description": "The result of micro debit." }, "micro_deposit": { "$ref": "#/components/schemas/MicroDepositResult", "description": "The result of micro deposit." }, "owner_email": { "type": "string", "description": "Email of the account holder." }, "owner_name": { "type": "string", "description": "Name of the account holder." } }, "description": "SEPA Direct Debit information." }, "SevenEleven": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "7-Eleven information." }, "ShopeePay": { "type": "object", "properties": { "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "Phone number of the shopper." } }, "description": "Boost information." }, "Skrill": { "type": "object", "properties": { "country_code": { "type": "string", "description": "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](https://www.skrill.com/en/footer/terms-conditions/non-serviced-countries/)." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Skrill information." }, "Tabby": { "type": "object", "properties": { "language": { "type": "string", "description": "The ISO 639-1 alpha-2 language code." }, "shopper_email": { "type": "string", "description": "The email of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." }, "shopper_phone": { "type": "string", "description": "The phone of the shopper." } }, "description": "Tabby information." }, "Trustly": { "type": "object", "properties": { "country_code": { "type": "string", "description": "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`." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Trustly information." }, "Verkkopankki": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "The name of the bank." }, "shopper_email": { "type": "string", "description": "Email address of the shopper." }, "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Verkkopankki information." }, "WechatPay": { "type": "object", "properties": { "channel": { "type": "string", "description": "Payment channel. Default: `ecom`.", "enum": [ "pos", "ecom" ], "x-enumDescriptions": { "pos": "A point-of-sale (POS) transaction.", "ecom": "A online e-commerce transaction." } }, "flow": { "type": "string", "description": "The specific Wechat Pay flow to use. One of `qrcode`, `official_account`, `mobile_app`, `mobile_web`." } }, "description": "WeChat Pay information." }, "Zip": { "type": "object", "properties": { "shopper_name": { "type": "string", "description": "The name of the shopper." } }, "description": "Zip information." }, "AttemptPaymentMethodDetail": { "type": "object", "properties": { "ach_direct_debit": { "$ref": "#/components/schemas/AchDirectDebit", "description": "ACH Direct Debit information." }, "airwallex_pay": { "$ref": "#/components/schemas/AirwallexPay", "description": "Airwallex Pay information." }, "alfamart": { "$ref": "#/components/schemas/Alfamart", "description": "Alfamart information." }, "alipaycn": { "$ref": "#/components/schemas/Alipaycn", "description": "Alipay CN information." }, "alipayhk": { "$ref": "#/components/schemas/AlipayConnect", "description": "Alipay HK information." }, "applepay": { "$ref": "#/components/schemas/Applepay", "description": "Apple pay information." }, "atome": { "$ref": "#/components/schemas/Atome", "description": "Atome information." }, "bacs_direct_debit": { "$ref": "#/components/schemas/BacsDirectDebit", "description": "BACS Direct Debit information." }, "bancontact": { "$ref": "#/components/schemas/Bancontact", "description": "Bancontact information." }, "bank_transfer": { "$ref": "#/components/schemas/BankTransfer", "description": "Bank Transfer information." }, "becs_direct_debit": { "$ref": "#/components/schemas/BecsDirectDebit", "description": "BECS Direct Debit information." }, "bitpay": { "$ref": "#/components/schemas/Bitpay", "description": "Bit Pay information." }, "blik": { "$ref": "#/components/schemas/Blik", "description": "BLIK information." }, "boost": { "$ref": "#/components/schemas/Boost", "description": "Boost information." }, "card": { "$ref": "#/components/schemas/CardAttempt", "description": "Card information." }, "card_present": { "$ref": "#/components/schemas/CardPresent", "description": "Card-present information." }, "cash_app_pay": { "$ref": "#/components/schemas/CashAppPay", "description": "Cash App Pay information." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which the Payment Method was created." }, "customer_id": { "type": "string", "description": "Customer id." }, "dana": { "$ref": "#/components/schemas/AlipayConnect", "description": "Dana information." }, "doku_ewallet": { "$ref": "#/components/schemas/DokuEwallet", "description": "Doku E-Wallet information." }, "dragonpay": { "$ref": "#/components/schemas/Dragonpay", "description": "Dragonpay information." }, "duit_now": { "$ref": "#/components/schemas/DuitNow", "description": "Duit Now information." }, "eft_direct_debit": { "$ref": "#/components/schemas/EftDirectDebit", "description": "EFT Direct Debit information." }, "eps": { "$ref": "#/components/schemas/Eps", "description": "EPS information." }, "esun": { "$ref": "#/components/schemas/Esun", "description": "ESUN information." }, "family_mart": { "$ref": "#/components/schemas/FamilyMart", "description": "Family Mart information." }, "fps": { "$ref": "#/components/schemas/Fps", "description": "FPS information." }, "fpx": { "$ref": "#/components/schemas/Fpx", "description": "FPX information." }, "gcash": { "$ref": "#/components/schemas/AlipayConnect", "description": "Gcash information." }, "go_pay": { "$ref": "#/components/schemas/GoPay", "description": "Go Pay information." }, "googlepay": { "$ref": "#/components/schemas/Googlepay", "description": "Google pay information." }, "grabpay": { "$ref": "#/components/schemas/Grabpay", "description": "Grab Pay information." }, "hi_life": { "$ref": "#/components/schemas/HiLife", "description": "Hi-Life information." }, "id": { "type": "string", "description": "Unique identifier for the Payment Method." }, "ideal": { "$ref": "#/components/schemas/Ideal", "description": "i DEAL information." }, "indomaret": { "$ref": "#/components/schemas/Indomaret", "description": "Indomaret information." }, "jenius_pay": { "$ref": "#/components/schemas/JeniusPay", "description": "Jenius Pay information." }, "kakaopay": { "$ref": "#/components/schemas/AlipayConnect", "description": "Kakaopay information." }, "klarna": { "$ref": "#/components/schemas/Klarna", "description": "Klarna information." }, "konbini": { "$ref": "#/components/schemas/Konbini", "description": "Konbini information." }, "linkaja": { "$ref": "#/components/schemas/Linkaja", "description": "Link Aja information." }, "maxima": { "$ref": "#/components/schemas/Maxima", "description": "Maxima information." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "multibanco": { "$ref": "#/components/schemas/Multibanco", "description": "Multibanco information." }, "mybank": { "$ref": "#/components/schemas/Mybank", "description": "My Bank information." }, "narvesen": { "$ref": "#/components/schemas/Narvesen", "description": "Narvesen information." }, "online_banking": { "$ref": "#/components/schemas/OnlineBanking", "description": "Online Banking information." }, "ovo": { "$ref": "#/components/schemas/Ovo", "description": "OVO information." }, "p24": { "$ref": "#/components/schemas/P24", "description": "P24 information." }, "pay_now": { "$ref": "#/components/schemas/PayNow", "description": "Pay Now information." }, "paybybankapp": { "$ref": "#/components/schemas/Paybybankapp", "description": "Pay by Bank app information." }, "payeasy": { "$ref": "#/components/schemas/Payeasy", "description": "Pay Easy information." }, "paypal": { "$ref": "#/components/schemas/Paypal", "description": "Pay Pal information." }, "paypost": { "$ref": "#/components/schemas/Paypost", "description": "Paypost information." }, "paysafecard": { "$ref": "#/components/schemas/Paysafecard", "description": "paysafecard information." }, "paysafecash": { "$ref": "#/components/schemas/Paysafecash", "description": "Paysafecash information." }, "paysera": { "$ref": "#/components/schemas/Paysera", "description": "Paysera information." }, "payto": { "$ref": "#/components/schemas/Payto", "description": "Payto information." }, "payu": { "$ref": "#/components/schemas/Payu", "description": "Pay U information." }, "perlas_terminals": { "$ref": "#/components/schemas/PerlasTerminals", "description": "Perlas terminals information." }, "prompt_pay": { "$ref": "#/components/schemas/PromptPay", "description": "Prompt Pay information." }, "rabbit_line_pay": { "$ref": "#/components/schemas/AlipayConnect", "description": "Rabbit LINE Pay information." }, "satispay": { "$ref": "#/components/schemas/Satispay", "description": "Satispay information." }, "sepa_direct_debit": { "$ref": "#/components/schemas/SepaDirectDebit", "description": "SEPA Direct Debit information." }, "seven_eleven": { "$ref": "#/components/schemas/SevenEleven", "description": "7-Eleven information." }, "shopee_pay": { "$ref": "#/components/schemas/ShopeePay", "description": "Boost information." }, "skrill": { "$ref": "#/components/schemas/Skrill", "description": "Skrill information." }, "status": { "type": "string", "description": "Status of the Payment Method. One of `CREATED`, `DISABLED`." }, "tabby": { "$ref": "#/components/schemas/Tabby", "description": "Tabby information." }, "tng": { "$ref": "#/components/schemas/AlipayConnect", "description": "TNG information." }, "truemoney": { "$ref": "#/components/schemas/AlipayConnect", "description": "Truemoney information." }, "trustly": { "$ref": "#/components/schemas/Trustly", "description": "Trustly information." }, "type": { "type": "string", "description": "Type of the Payment Method. 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`." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which the Payment Method was updated." }, "verkkopankki": { "$ref": "#/components/schemas/Verkkopankki", "description": "Verkkopankki information." }, "wechatpay": { "$ref": "#/components/schemas/WechatPay", "description": "WeChat Pay information." }, "zip": { "$ref": "#/components/schemas/Zip", "description": "Zip information." } }, "description": "Payment Method used by the Payment Attempt." }, "CardOption": { "type": "object", "properties": { "authorization_type": { "type": "string", "description": "The authorization type of the card payment. One of `final_auth`, `pre_auth`. Default to `final_auth`. Currently only available when `brand` is `visa` or `mastercard`." }, "auto_capture": { "type": "boolean", "description": "Specifies whether the funds should be requested automatically after the payment is authorized. Default to `true`." } }, "description": "The Payment Method options for card." }, "PaymentMethodOption": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/CardOption", "description": "The Payment Method options for card." } }, "description": "Options for Payment Method." }, "PaymentAttempt": { "type": "object", "properties": { "acquirer_reference_number": { "type": "string", "description": "Acquirer reference number of the card payment. Will be populated after the payment attempt has transitioned to the `CAPTURE_REQUESTED` or `SETTLED` status." }, "amount": { "type": "number", "description": "Amount of the Payment Attempt." }, "authentication_data": { "$ref": "#/components/schemas/AuthenticationData", "description": "Authentication data which contains AVS result, CVC result, three domain secure result and fraud evaluation result." }, "authorization_code": { "type": "string", "description": "Authorization response code from issuer when the payment is authorized successfully." }, "captured_amount": { "type": "number", "description": "Captured amount." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Attempt was created." }, "currency": { "type": "string", "description": "Currency of the Payment Attempt." }, "dcc_data": { "$ref": "#/components/schemas/Dcc", "description": "Present when DCC amount is available and DCC currency is different from Payment Intent currency. DCC could be conducted either by third party or Airwallex when using Airwallex DCC product." }, "failure_code": { "type": "string", "description": "Payment Attempt failure code. One of `authentication_failed`, `capture_failed`, `authorization_failed`, `provider_unavailable`, `system_unavailable`, `fraud_rejected`." }, "failure_details": { "$ref": "#/components/schemas/Payment_Acceptance_FailureDetails", "description": "Failure details. Only applicable when status is FAILED." }, "id": { "type": "string", "description": "Unique identifier for the Payment Attempt." }, "merchant_advice_code": { "type": "string", "description": "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_id": { "type": "string", "description": "Merchant order unique identifier of the Payment Attempt." }, "payment_consent_id": { "type": "string", "description": "Payment Consent unique identifier of the Payment Attempt." }, "payment_intent_id": { "type": "string", "description": "Payment Intent unique identifier of the Payment Attempt." }, "payment_method": { "$ref": "#/components/schemas/AttemptPaymentMethodDetail", "description": "Payment Method used by the Payment Attempt." }, "payment_method_options": { "$ref": "#/components/schemas/PaymentMethodOption", "description": "Options for Payment Method." }, "payment_method_transaction_id": { "type": "string", "description": "The unique transaction identifier for a Payment Attempt, assigned by the payment provider (card issuers or local payment method providers such as Google Pay, i DEAL, etc.)." }, "provider_original_response_code": { "type": "string", "description": "The original response code from the payment method provider (or issuer for card)." }, "provider_original_response_description": { "type": "string", "description": "Human-readable description of `provider_original_response_code`, describing the reason returned by the issuer." }, "provider_transaction_id": { "type": "string", "description": "Deprecated. \n \nUse `payment_method_transaction_id` instead." }, "refunded_amount": { "type": "number", "description": "Refunded amount." }, "settle_via": { "type": "string", "description": "Through which channel the merchant will get this payment settled. Possible values are `airwallex`, `paypal`, `amex`. \n\nIf `airwallex` is returned, this payment will be settled to merchant's Airwallex wallet, otherwise it will be settled externally." }, "status": { "type": "string", "description": "\n- **RECEIVED**: The Payment Attempt has been created upon request.\n- **AUTHENTICATION_REDIRECTED**: The Payment Attempt is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan.\n- **PENDING_AUTHORIZATION**: The Payment Attempt authorization request has been accepted and is pending the final result from the provider.\n- **AUTHORIZED**: The Payment Attempt 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 Payment Intent status is **PENDING_REVIEW**.\n- **CAPTURE_REQUESTED**: The Payment Attempt has been successfully requested for capture. The payment is complete.\n- **EXPIRED**: The Payment Attempt expired after the allowed payment time. Please create a new Payment Attempt to retry.\n- **CANCELLED**: The Payment Attempt has been cancelled. The previously authorized amount (if any) will be returned to the customer.\n- **FAILED**: The Payment Attempt has failed. Please create a new Payment Attempt to retry.\n- **SETTLED**: Airwallex has received the settlement from the provider. We will settle the funds in your wallet.\n- **PAID**: Airwallex has settled the funds in your wallet.\n" }, "terminal_id": { "type": "string", "description": "Airwallex terminal unique identifier used to process the payment attempt." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Attempt was updated or operated on." } }, "description": "Latest Payment Attempt that was created under the Payment Intent." }, "FailureReason": { "type": "object", "properties": { "code": { "type": "string", "description": "The failure code returned by Airwallex." }, "details": { "type": "object", "description": "The verification failure details." }, "message": { "type": "string", "description": "Consent verification failed. Please retry the consent verification or select a different payment method." } }, "description": "Verification failure reason. Only applicable when status is `REQUIRES_PAYMENT_METHOD` and `REQUIRES_CUSTOMER_ACTION`." }, "BacsDirectDebitMandate": { "type": "object", "properties": { "ddi_reference": { "type": "string", "description": "Reference of the Direct Debit instrument." }, "service_user_number": { "type": "string", "description": "A unique six-digit number used to identify a business paying or receiving money through a Bacs Direct Debit transaction." } }, "description": "BACS Direct Debit mandate information." }, "SepaDirectDebitMandate": { "type": "object", "properties": { "creditor_identifier": { "type": "string", "description": "A unique number used to identify a business paying or receiving money through a SEPA Direct Debit transaction." }, "reference": { "type": "string", "description": "Reference of the Direct Debit mandate." } }, "description": "SEPA Direct Debit mandate information." }, "PaymentConsentNextAction": { "type": "object", "properties": { "content_type": { "type": "string", "description": "The content type of the request when `method` is `POST`. If not provided, the content type should be `application/json`." }, "data": { "type": "object", "description": "The additional data that can be used to complete this action." }, "email": { "type": "string", "description": "Email address to send the Micro Deposit verification link. Appears if type is `notify_micro_deposits`." }, "fallback_url": { "type": "string", "description": "Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is `mobile_app`." }, "method": { "type": "string", "description": "The redirect method if the action type is `redirect`. One of `GET`, `POST`." }, "micro_deposit_count": { "type": "integer", "format": "int32", "description": "Number of funds that will be deposited into shopper account. Appears if type is `notify_micro_deposits`." }, "package_name": { "type": "string", "description": "Android package name. Returned only if the flow is `mobile_app` and the os_type is `android`." }, "qrcode": { "type": "string", "description": "QR Code text representation if the action type is `redirect`, only applicable to `wechatpay`." }, "remaining_attempts": { "type": "integer", "format": "int32", "description": "the remaining attempts to verify micro_deposit or retry micro_debit." }, "stage": { "type": "string", "description": "Stage of the request flow." }, "type": { "type": "string", "description": "Type of next action can be either `redirect`, `redirect_iframe`, `notify_micro_deposits` or `retry_micro_debit`." }, "url": { "type": "string", "description": "The redirect url." } }, "description": "Next action for merchant." }, "PaymentMethodDetailsForConsent": { "type": "object", "required": [ "type" ], "properties": { "ach_direct_debit": { "$ref": "#/components/schemas/AchDirectDebit", "description": "ACH Direct Debit information. Only provided when `type` is `ach_direct_debit`." }, "alipaycn": { "$ref": "#/components/schemas/Alipaycn", "description": "Alipay CN information. Only provided when `type` is `alipaycn`." }, "alipayhk": { "$ref": "#/components/schemas/AlipayConnect", "description": "Alipay HK information. Only provided when `type` is `alipayhk`." }, "applepay": { "$ref": "#/components/schemas/Applepay", "description": "Apple pay information. Only provided when `type` is `applepay`." }, "bacs_direct_debit": { "$ref": "#/components/schemas/BacsDirectDebit", "description": "BACS Direct Debit information. Only provided when `type` is `bacs_direct_debit`." }, "becs_direct_debit": { "$ref": "#/components/schemas/BecsDirectDebit", "description": "BECS Direct Debit information. Only provided when `type` is `becs_direct_debit`." }, "card": { "$ref": "#/components/schemas/Payment_Acceptance_Card", "description": "Card information. Only provided when `type` is card." }, "dana": { "$ref": "#/components/schemas/AlipayConnect", "description": "DANA information. Only provided when `type` is `dana`." }, "eft_direct_debit": { "$ref": "#/components/schemas/EftDirectDebit", "description": "EFT Direct Debit information. Only provided when `type` is `eft_direct_debit`." }, "gcash": { "$ref": "#/components/schemas/AlipayConnect", "description": "GCASH information. Only provided when `type` is `gcash`." }, "googlepay": { "$ref": "#/components/schemas/Googlepay", "description": "Google pay information. Only provided when `type` is `googlepay`." }, "id": { "type": "string", "description": "Unique identifier of the Payment Method attached for subsequent payments. Only provided when `type` is card." }, "kakaopay": { "$ref": "#/components/schemas/AlipayConnect", "description": "KAKAOPAY information. Only provided when `type` is `kakaopay`." }, "payto": { "$ref": "#/components/schemas/Payto", "description": "Payto information. Only provided when `type` is `payto`." }, "sepa_direct_debit": { "$ref": "#/components/schemas/SepaDirectDebit", "description": "SEPA Direct Debit information. Only provided when `type` is `sepa_direct_debit`." }, "type": { "type": "string", "description": "Type of the Payment Method. One of `card`, `googlepay`, `applepay`, `alipayhk`, `truemoney`, `gcash`, `dana`, `kakaopay`, `tng`, `alipaycn`, `rabbit_line_pay`, `wechatpay`, `ach_direct_debit`, `bacs_direct_debit`, `becs_direct_debit`, `sepa_direct_debit`, `eft_direct_debit`." } }, "description": "Payment Method information attached for subsequent payments." }, "PaymentSchedule": { "type": "object", "properties": { "period": { "type": "integer", "format": "int32", "description": "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." }, "period_unit": { "type": "string", "description": "Specifies billing frequency. One of `DAY`, `WEEK`, `MONTH`, and `YEAR`. Required when merchant_trigger_reason = scheduled." } } }, "TermsOfUse": { "type": "object", "required": [ "payment_amount_type" ], "properties": { "billing_cycle_charge_day": { "type": "integer", "format": "int32", "description": "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": { "type": "string", "description": "End date to expect payment request." }, "first_payment_amount": { "type": "number", "description": "The first payment. It could include the costs associated with the first debited amount.Optional if payment agreement type is `VARIABLE`." }, "fixed_payment_amount": { "type": "number", "description": "The fixed payment amount that can be charged for a single payment.Required if payment agreement type is `FIXED`." }, "max_payment_amount": { "type": "number", "description": "The maximum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "min_payment_amount": { "type": "number", "description": "The minimum payment amount that can be charged for a single payment.Optional if payment agreement type is `VARIABLE`." }, "payment_amount_type": { "type": "string", "description": "The agreed type of amounts for subsequent payment. Should be one of `FIXED`, `VARIABLE`.\n\n- **FIXED**: payment amount is fixed. A specific amount is required.\n- **VARIABLE**: payment amount is variable at each collection. A max limit is recommended." }, "payment_currency": { "type": "string", "description": "The currency of this payment. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "payment_schedule": { "$ref": "#/components/schemas/PaymentSchedule" }, "start_date": { "type": "string", "description": "Start date to expect payment request." }, "total_billing_cycles": { "type": "integer", "format": "int32", "description": "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 `unscheduled`The mandate will continue indefinitely if total_billing_cycles is null. " } }, "description": "Terms to specify how this Payment Consent will be used." }, "PaymentConsent": { "type": "object", "required": [ "created_at", "customer_id", "id", "next_triggered_by", "request_id", "status", "updated_at" ], "properties": { "client_secret": { "type": "string", "description": "Payment Consent's client secret for browser or app. Only returned by Payment Consent create API. \n\nThe provided client_secret is valid for 60 minutes." }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Consent was created." }, "customer_id": { "type": "string", "description": "Unique identifier from Airwallex of the customer who will make the payment with this Payment Consent." }, "disable_reason": { "type": "string", "description": "Disable reason. Only applicable when status is `DISABLED`." }, "failure_reason": { "$ref": "#/components/schemas/FailureReason", "description": "Verification failure reason. Only applicable when status is `REQUIRES_PAYMENT_METHOD` and `REQUIRES_CUSTOMER_ACTION`." }, "id": { "type": "string", "description": "Unique identifier of this Payment Consent." }, "initial_payment_intent_id": { "type": "string", "description": "Unique identifier of the initial Payment Intent confirmed with this Payment Consent." }, "mandate": { "$ref": "#/components/schemas/Payment_Acceptance_Mandate", "description": "An authorization from shopper to merchant to debit payments from their bank account." }, "merchant_trigger_reason": { "type": "string", "description": "Only applicable when `next_triggered_by` is `merchant`. One of `scheduled`, `unscheduled`, `installments`." }, "metadata": { "type": "object", "description": "A set of key-value pairs that can be attached to this Payment Consent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long." }, "next_action": { "$ref": "#/components/schemas/PaymentConsentNextAction", "description": "Next action for merchant." }, "next_triggered_by": { "type": "string", "description": "The party to trigger subsequent payments. One of `merchant`, `customer`." }, "payment_method": { "$ref": "#/components/schemas/PaymentMethodDetailsForConsent", "description": "Payment Method information attached for subsequent payments." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." }, "status": { "type": "string", "description": "\n- **REQUIRES_PAYMENT_METHOD**: Populate `payment_method` when calling **verify**.\n - This value is returned if `payment_method` is either null, or the `payment_method` has failed during verify, and a different `payment_method` should be provided.\n- **REQUIRES_CUSTOMER_ACTION**: Pending customer action, see `next_action` for details.\n- **PENDING**: The mandate of the Payment Consent has been submitted. It only occurs when payment method type is `bacs_direct_debit`. You need to wait for the final result. The status will become `DISABLED` if the mandate is rejected or `VERIFIED` if the mandate is accepted.\n- **PAUSED**: The active mandate of the Payment Consent has been paused. The Payment Consent can be paused only when the previous status was `VERIFIED`. It only occurs when payment method type is `payto`. The status will become `DISABLED` if the mandate is canceled or `VERIFIED` if the mandate is resumed.\n- **VERIFIED**: The Payment Consent has been verified and it can be used for subsequent payments.\n- **DISABLED**: The Payment Consent is disabled. You cannot verify it again.\n" }, "terms_of_use": { "$ref": "#/components/schemas/TermsOfUse", "description": "The terms of this consent. " }, "updated_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Consent was last updated." } } }, "RefundRequest": { "type": "object", "properties": { "amount": { "type": "number", "description": "The refund amount when accepting `RFI`. If not specified, it will be same as the remaining amount that has been captured but not yet refunded. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "reason": { "type": "string", "description": "The refund reason when accepting `RFI`. `OTHERS` is used by default. One of `REQUESTED_BY_CUSTOMER`, `DUPLICATE`, `FRAUDULENT`, `ABANDONED`, and `OTHERS`." } }, "description": "The Refund requested to be created." }, "AcceptDetails": { "type": "object", "properties": { "accepted_at": { "type": "string", "format": "date-time", "description": "The time when the user accepted the Payment Dispute." }, "accepted_by": { "type": "string", "description": "User unique identifier of person/system actioned on case." }, "description": { "type": "string", "description": "The accept description." }, "reason": { "type": "string", "description": "The accept reason. One of \n\n- `AGREEMENT_REACHED_WITH_CUSTOMER`\n- `CUSTOMER_RELATIONSHIP_MAINTENANCE` \n- `LOW_VALUE_TRANSACTION`\n- `VALID_CUSTOMER_DISPUTE` \n- `NO_ACTION_TAKEN_BY_MERCHANT`\n- `RDR_AUTO_ACCEPTED` \n- `COLLABORATION_ACCEPTED_MANUAL`\n- `COLLABORATION_AUTO_ACCEPTED`\n- `COLLABORATION_AUTO_ACCEPTED_BY_EXPIRY`\n- `OTHERS`.\n" }, "refund": { "$ref": "#/components/schemas/RefundRequest", "description": "The Refund requested to be created." }, "stage": { "type": "string", "description": "The stage when dispute is accepted. Possible values: `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, `PRE_ARBITRATION`." } } }, "AiDisputeRecommendation": { "type": "object", "properties": { "action": { "type": "string", "description": "The recommended action. Possible values: `Challenge`, `Accept`." }, "evidence_to_submit": { "type": "array", "description": "The evidence fields listed below are recommended for challenging this dispute. \nFor field definitions and accepted values, \nrefer to the `evidence` object in [Challenge a Payment Dispute](/docs/api/payments/payment_disputes/challenge).", "items": { "type": "string" } } }, "description": "The AI recommendation for the dispute, present when status is `AVAILABLE`." }, "AiDisputeAutomation": { "type": "object", "properties": { "recommendation": { "$ref": "#/components/schemas/AiDisputeRecommendation", "description": "The AI recommendation for the dispute, present when status is `AVAILABLE`." }, "status": { "type": "string", "description": "Indicates whether AI Dispute Automation is available. Possible values: `AVAILABLE`, `UNAVAILABLE`." }, "unavailable_reason": { "type": "string", "description": "The reason AI Dispute Automation is unavailable. Possible values: \n\n- **DISABLED**: AI Dispute Automation is currently disabled. [Activate it](/docs/payments/payment-operations/disputes/dispute-automation#activate-ai-dispute-automation) to use this feature.\n- **NOT_SUPPORTED**: AI Dispute Automation is not available for the current dispute.\n" } }, "description": "Information about AI dispute automation, including recommendation and current status. Applicable only when the stage is `CHARGEBACK`." }, "CustomerInformation": { "type": "object", "properties": { "billing_address": { "type": "string", "description": "Customer billing address." }, "device_id": { "type": "string", "description": "Customer device unique identifier." }, "email": { "type": "string", "description": "Customer email." }, "ip": { "type": "string", "description": "Customer ip." }, "name": { "type": "string", "description": "Customer name." }, "phone_number": { "type": "string", "description": "Customer phone number." } }, "description": "Customer information." }, "DeliveryInformation": { "type": "object", "properties": { "address": { "type": "string", "description": "The shipping address. Applicable at stage `RFI`." }, "delivered_at": { "type": "string", "format": "date-time", "description": "The date when services or goods are delivered." }, "fee_amount": { "type": "number", "description": "The amount of shipping fee. Applicable at stage `RFI`." }, "fee_currency": { "type": "string", "description": "The currency of shipping fee. Applicable at stage `RFI`." }, "name": { "type": "string", "description": "The recipient's name. Applicable at stage `RFI`." }, "phone_number": { "type": "string", "description": "The recipient's phone number. Applicable at stage `RFI`." }, "shipped_at": { "type": "string", "format": "date-time", "description": "The shipping date (the expected delivery date for `RFI`)." }, "shipping_company": { "type": "string", "description": "The company name managing this delivery, such as asendia-usa, 4px, and so on." }, "shipping_method": { "type": "string", "description": "The shipping method, such as Priority Mail, Flat rate, and so on. Applicable at stage `RFI`." }, "status": { "type": "string", "description": "The shipping status, such as `SHIPPED`, `DELIVERED`, and so on. Applicable at stage `RFI`." }, "tracking_number": { "type": "string", "description": "The shipping tracking number." } }, "description": "The delivery information." }, "AiDisputeEvidence": { "type": "object", "properties": { "access_activity_file_ids": { "type": "array", "description": "File unique identifiers of access activity files. Provide screenshots from your activity log that show the customer's on-site behaviour, such as login times or download timestamps. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "authenticity_proof_file_ids": { "type": "array", "description": "File unique identifiers of authenticity proof files. Provide documentation that confirms your products are genuine and not counterfeit. This can include certificates, supplier invoices, or brand authorization letters. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "customer_communication_file_ids": { "type": "array", "description": "File unique identifiers of customer communication files. Provide copies of any emails, chat logs, or messages with the customer that show communication before or after the purchase. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "duplicate_acquirer_reference_number": { "type": "string", "description": "Acquirer reference number of the duplicate transaction." }, "duplicate_explanation": { "type": "string", "description": "Explanation of the duplicate transaction." }, "duplicate_payment_file_ids": { "type": "array", "description": "File unique identifiers of duplicate payment files. Provide documents that show how this transaction differs from any potential duplicates. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "duplicate_transaction_amount_currency": { "type": "string", "description": "Amount and currency of the duplicate transaction." }, "duplicate_transaction_created_at": { "type": "string", "format": "date-time", "description": "Creation date of the duplicate transaction." }, "merchant_business_model_description": { "type": "string", "description": "Description of the merchant's business model." }, "order_fulfilled_at": { "type": "string", "format": "date-time", "description": "Date and time when the order was fulfilled." }, "order_fulfillment_file_ids": { "type": "array", "description": "File unique identifiers of order fulfillment files. Provide screenshots of delivery confirmation or shipment tracking information that clearly show the order was successfully delivered. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "order_snapshot_file_ids": { "type": "array", "description": "File unique identifiers of order snapshot files. Provide screenshots of the customer's receipt or order confirmation page as evidence that the customer placed the order. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "previous_dispute_won_on_same_card_file_ids": { "type": "array", "description": "File unique identifiers of previous won disputes on same card. Provide evidence of any previous disputes that you won for transactions using the same card. This helps establish a history of legitimate transactions. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "previous_purchase_similar_product_file_ids": { "type": "array", "description": "File unique identifiers of previous purchases of similar products. Provide proof of the customer's past purchases of similar items to show their history and relationship with your business. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "product_consumption_file_ids": { "type": "array", "description": "File unique identifiers of product usage files. Provide evidence that the customer has used the product or service, such as a login record or usage timestamp. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "product_description": { "type": "string", "description": "Description of the product." }, "product_snapshot_file_ids": { "type": "array", "description": "File unique identifiers of product snapshot files. Provide a screenshot of the product page or a photo of the item to show that the product matches its description. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "refund_policy_file_ids": { "type": "array", "description": "File unique identifiers for your refund policy documents. Upload all documents that describe your refund policy. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } }, "refund_policy_url": { "type": "string", "description": "URL of the refund policy page." }, "user_agreement_file_ids": { "type": "array", "description": "File unique identifiers of user agreement files. Upload your user agreement forms that outline the terms and conditions for your customers. Supported file formats: JPG, PNG, WEBP and max 10MB size. Please use [File Service](/docs/api/supporting_services/file_service/upload_files) to upload files.", "items": { "type": "string" } } }, "description": "The evidence submitted when challenge_method is `AI_DISPUTE_AUTOMATION`." }, "ProductSeller": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system." } }, "description": "Seller info of the purchase order." }, "Product": { "type": "object", "properties": { "category": { "type": "string", "description": "Product category at the merchant store, such as home furnishings, pet supplies, apparel and accessories." }, "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 128 characters." }, "desc": { "type": "string", "description": "Product description. Maximum of 500 characters." }, "effective_end_at": { "type": "string", "description": "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`)." }, "effective_start_at": { "type": "string", "description": "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`)." }, "image_url": { "type": "string", "description": "The preview image url for this product, which is usually displayed as thumbnail in the order details." }, "name": { "type": "string", "description": "Name of the product. Maximum of 255 characters." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "seller": { "$ref": "#/components/schemas/ProductSeller", "description": "Seller info of the purchase order." }, "sku": { "type": "string", "description": "Stock keeping unit. A unique identifier assigned by the merchant to identify and track this specific product. Maximum of 128 characters." }, "type": { "type": "string", "description": "Type of product, such as `physical_good`, `intangible_good`, or `service`. Maximum of 128 characters." }, "unit_price": { "type": "number", "description": "Product unit price." }, "url": { "type": "string", "description": "The url that links to the product page at merchant site." } } }, "OrderInformation": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Time at which this order was created." }, "id": { "type": "string", "description": "The order unique identifier." }, "invoice_number": { "type": "string", "description": "The invoice number of order." }, "products": { "type": "array", "description": "The products of order.", "items": { "$ref": "#/components/schemas/Product" } }, "total_amount": { "type": "number", "description": "The total amount of order." }, "total_currency": { "type": "string", "description": "The currency of total amount." } }, "description": "The order information. Applicable when the stage is `RFI`." }, "SellerInformation": { "type": "object", "properties": { "name": { "type": "string", "description": "Seller name." }, "store_name": { "type": "string", "description": "Store name." }, "store_physical_address": { "type": "string", "description": "Store physical address." }, "store_url": { "type": "string", "description": "Store URL." } }, "description": "Merchant information." }, "DisputeDocument": { "type": "object", "properties": { "description": { "type": "string", "description": "Additional file descriptions or explanations." }, "file_ids": { "type": "array", "description": "File unique identifiers of the documents.", "items": { "type": "string" } }, "type": { "type": "string", "description": "Type of the documents. Possible values: `PRIMARY`, `ORDER`, `CUSTOMER`, `OTHER`.\n\n- **PRIMARY**: The primary evidence depends on the challenge reason.\n- **ORDER**: Order related evidence.\n- **CUSTOMER**: Customer related evidence.\n- **OTHER**: Other supporting evidence.\n" } } }, "SupportingDocuments": { "type": "object", "properties": { "customer_communication_documents": { "type": "array", "description": "The file IDs of customer communication. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "customer_signature_documents": { "type": "array", "description": "The file IDs of customer signature. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "documents": { "type": "array", "description": "List of documents.", "items": { "$ref": "#/components/schemas/DisputeDocument" } }, "duplicate_charge_defense_documents": { "type": "array", "description": "The file IDs of duplicate payment evidence. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "generated_files": { "type": "array", "description": "The file unique identifiers of the files generated by Airwallex automatically based on text evidence or refund information.", "items": { "type": "string" } }, "other_documents": { "type": "array", "description": "The list of file IDs of other documents. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "proof_of_delivery_documents": { "type": "array", "description": "The file IDs of proof of delivery. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "receipt_documents": { "type": "array", "description": "The file IDs of the receipt. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "refund_policy_documents": { "type": "array", "description": "The file IDs of the refund policy. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } } }, "description": "The file unique identifiers of support documents." }, "ChallengeDetails": { "type": "object", "properties": { "challenge_method": { "type": "string", "description": "The method used to challenge the dispute. Possible values: \n\n- **AI_DISPUTE_AUTOMATION**: Challenge via AI Dispute Automation\n - Applicable when Payment Dispute stage is `CHARGEBACK` and AI Dispute Automation status is `AVAILABLE`\n- **STANDARD**: Challenge via standard flow\n\nDefault to `STANDARD` if not provided." }, "challenged_at": { "type": "string", "format": "date-time", "description": "The time when the user challenges Payment Dispute." }, "challenged_by": { "type": "string", "description": "User unique identifier of person/system challenges Payment Dispute." }, "customer_info": { "$ref": "#/components/schemas/CustomerInformation", "description": "Customer information." }, "delivery_info": { "$ref": "#/components/schemas/DeliveryInformation", "description": "The delivery information." }, "evidence": { "$ref": "#/components/schemas/AiDisputeEvidence", "description": "The evidence submitted when challenge_method is `AI_DISPUTE_AUTOMATION`." }, "order_info": { "$ref": "#/components/schemas/OrderInformation", "description": "The order information. Applicable when the stage is `RFI`." }, "product_description": { "type": "string", "description": "The description of product." }, "product_type": { "type": "string", "description": "The type of Product." }, "reason": { "type": "string", "description": "The reason why the merchant challenges the dispute. Possible values: \n\n- **CUSTOMER_WITHDRAWN**: The customer withdrew the dispute\n- **CUSTOMER_REFUNDED**: The customer has already been refunded\n- **PRODUCT_RECEIVED**: The customer has already received / will receive the product or service\n- **PURCHASE_HISTORY**: The customer has a purchasing history with me\n- **NOT_ENTITLED**: The customer is not entitled to refund\n- **SEPARATE_PRODUCT**: The customer purchased separate products or services\n- **AUTHENTIC_PRODUCT**: The product is not damaged, defective or counterfeit\n- **OTHER_REASONS**: Other reasons for challenging.\n" }, "refund_refusal_reason": { "type": "string", "description": "Explanation of why refund is refused." }, "seller_info": { "$ref": "#/components/schemas/SellerInformation", "description": "Merchant information." }, "stage": { "type": "string", "description": "The stage when evidence is submitted. Possible values: `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`." }, "supporting_documents": { "$ref": "#/components/schemas/SupportingDocuments", "description": "The file unique identifiers of support documents." } } }, "ReasonDetails": { "type": "object", "properties": { "description": { "type": "string", "description": "Payment Dispute reason description." }, "original_code": { "type": "string", "description": "Payment Dispute reason code." }, "type": { "type": "string", "description": "Payment Dispute reason type. Possible values: `CREDIT_NOT_PROCESSED`, `FRAUDULENT`, `DUPLICATE_CHARGE`, `PRODUCT_NOT_RECEIVED`, `PRODUCT_UNACCEPTABLE`, `UNRECOGNIZED_CHARGE`, `CANCELLED_PRODUCT`, `MISREPRESENTATION`, `COUNTERFEIT_PRODUCT`, `PROCESSING_ERRORS`, `AUTHORIZATION`, `NOT_RECOGNIZED`, `BANK_REJECTION`, `FUND_REVERSAL`, `CONSUMER_DISPUTE`, `POINT_OF_INTERACTION_ERROR` and `UNKNOWN`." } }, "description": "Payment Dispute reason." }, "RefundDetails": { "type": "object", "properties": { "acquirer_reference_number": { "type": "string", "description": "The acquirer reference number of Refund." }, "id": { "type": "string", "description": "Refund unique identifier." } } }, "PaymentDispute": { "type": "object", "properties": { "accept_details": { "type": "array", "description": "Further details on why the client is accepting the Payment Dispute event.", "items": { "$ref": "#/components/schemas/AcceptDetails" } }, "acquirer_reference_number": { "type": "string", "description": "The acquirer reference number of original payment." }, "ai_dispute_automation": { "$ref": "#/components/schemas/AiDisputeAutomation", "description": "Information about AI dispute automation, including recommendation and current status. Applicable only when the stage is `CHARGEBACK`." }, "amount": { "type": "number", "description": "Payment Dispute amount." }, "card_brand": { "type": "string", "description": "The card brand of original payment, applicable when payment_method_type is `CARD`. Possible values: `visa`, `mastercard`, `maestro`, `union pay`, `american express`, `jcb`, `diners club international` and `discover`." }, "challenge_details": { "type": "array", "description": "The challenge data submitted at each stage.", "items": { "$ref": "#/components/schemas/ChallengeDetails" } }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Dispute was created." }, "currency": { "type": "string", "description": "Payment Dispute currency." }, "customer_id": { "type": "string", "description": "The customer unique identifier of original payment." }, "customer_name": { "type": "string", "description": "The customer name of original payment." }, "due_at": { "type": "string", "format": "date-time", "description": "Payment Dispute due date." }, "id": { "type": "string", "description": "Payment Dispute unique identifier." }, "issuer_comment": { "type": "string", "description": "The issuer’s comment on Payment Dispute." }, "issuer_documents": { "type": "array", "description": "The issuer’s documents on Payment Dispute.", "items": { "type": "string" } }, "merchant_order_id": { "type": "string", "description": "The order unique identifier of original payment." }, "metadata": { "type": "object", "description": "A set of key-value pairs attached to the dispute by the merchant.", "additionalProperties": { "type": "string" } }, "mode": { "type": "string", "description": "Payment Dispute mode. Possible values: `ALLOCATION`, `COLLABORATION`, applicable when the stage is `CHARGEBACK`, `PRE_ARBITRATION` and `ARBITRATION`." }, "payment_attempt_id": { "type": "string", "description": "Payment Attempt unique identifier." }, "payment_intent_id": { "type": "string", "description": "Payment Intent unique identifier." }, "payment_method_type": { "type": "string", "description": "The payment method type of original payment." }, "reason": { "$ref": "#/components/schemas/ReasonDetails", "description": "Payment Dispute reason." }, "refunds": { "type": "array", "description": "The Refunds of original payment.", "items": { "$ref": "#/components/schemas/RefundDetails" } }, "stage": { "type": "string", "description": "Payment Dispute stage. Possible values: `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, `PRE_ARBITRATION`, `ARBITRATION`." }, "status": { "type": "string", "description": "Payment Dispute status. Possible values: \n\n- **REQUIRES_RESPONSE**: In this status, you can decide whether to accept or challenge the Payment Dispute.\n - Applicable when receive notification from card schemes that Payment Dispute has entered `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, or `PRE_ARBITRATION` stage.\n- **CHALLENGED**: In this status, we have informed the issuing bank that you would like to challenge the Payment Dispute.\n - Applicable when you challenge the Payment Dispute. At `PRE_CHARGEBACK` stage, the issuing bank will escalate to the chargeback stage in the following days. At `RFI`, `CHARGEBACK`, and `PRE_ARBITRATION` stage, the issuing bank will review your submitted evidence and decide whether to escalate the Payment Dispute or not.\n- **ACCEPTED**: In this status the Payment Dispute has been accepted and the payment will be refunded to the shopper.\n - Applicable when you accept the Payment Dispute at `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, and `PRE_ARBITRATION` stage.\n- **REVERSED**: In this status, the Payment Dispute has been reversed by the issuing bank. No further action is required.\n - Applicable when receive notification from card schemes that Payment Dispute has been reversed at `PRE_CHARGEBACK`, `CHARGEBACK`, and `PRE_ARBITRATION` stage.\n- **WON**: In this status, the issuing bank has accepted the response provided, or card schemes have ruled the Payment Dispute decision in your favor. No further action is required.\n - Applicable at `CHARGEBACK`, `PRE_ARBITRATION` and `ARBITRATION` stage.\n- **LOST**: In this status, the issuing bank has not accepted the evidence provided by you, or card schemes have ruled the Payment Dispute decision in Issuer’s favor. No further action is required.\n - Applicable at `PRE_ARBITRATION` and `ARBITRATION` stage.\n- **PENDING_CLOSURE**: In this status, the issuing bank has escalated the Payment Dispute to `PRE_ARBITRATION` stage and Airwallex is reviewing the Payment Dispute. Airwallex will decide whether to accept the Payment Dispute or respond to it on your behalf and may reach out to you for more information.\n - Applicable at `PRE_ARBITRATION` stage.\n- **EXPIRED**: In this status, the `RFI` event has expired as you have not responded to the request within 15 days.\n - Applicable at `RFI` stage.\n- **PENDING_DECISION**: In this status, we have responded to the issuing bank with evidence provided by you. The issuing bank will review your submitted evidence and decide whether to accept the Payment Dispute or not.\n - Applicable at `PRE_ARBITRATION` and `ARBITRATION` stage." }, "transaction_type": { "type": "string", "description": "The transaction type of the original transaction. Possible values: `PAYMENT`, `REFUND`." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Dispute was updated or operated on." } } }, "PageResponseDTOOfPaymentAcceptancePaymentDispute": { "type": "object", "properties": { "items": { "type": "array", "description": "The list of Payment Disputes.", "items": { "$ref": "#/components/schemas/PaymentDispute" } }, "page_after": { "type": "string", "description": "The BASE 64 encoded resource unique identifier of last Payment Dispute in items and navigation direction. When used in request, the response contains the page of Payment Dispute after it." }, "page_before": { "type": "string", "description": "The BASE 64 encoded resource unique identifier of first Payment Dispute in items and navigation direction. When used in request, the response contains the page of Payment Dispute before it." } } }, "MatchResults": { "type": "object", "properties": { "same_amount": { "type": "boolean", "description": "Whether the payment amount is the same." }, "same_device_id": { "type": "boolean", "description": "Whether the customer device id or fingerprint is the same." }, "same_email_address": { "type": "boolean", "description": "Whether the customer email address is the same." }, "same_fingerprint": { "type": "boolean", "description": "Whether the customer fingerprint is the same." }, "same_ip_address": { "type": "boolean", "description": "Whether the customer ip address is the same." }, "same_payment_method": { "type": "boolean", "description": "Whether the payment method is the same." }, "same_shipping_address": { "type": "boolean", "description": "Whether the shipping address is the same." } }, "description": "Matching details between the dispute and the related order." }, "RelatedOrder": { "type": "object", "properties": { "captured_amount": { "type": "number", "description": "The captured amount of the Payment Intent." }, "created_at": { "type": "string", "format": "date-time", "description": "The creation time of the Payment Intent." }, "currency": { "type": "string", "description": "The payment amount currency of the Payment Intent." }, "disputed": { "type": "boolean", "description": "Whether the Payment Intent is disputed." }, "fraudulent": { "type": "boolean", "description": "Whether the Payment Intent is fraudulent." }, "match_results": { "$ref": "#/components/schemas/MatchResults", "description": "Matching details between the dispute and the related order." }, "merchant_order_id": { "type": "string", "description": "The merchant order unique identifier of the Payment Intent." }, "payment_intent_id": { "type": "string", "description": "Payment Intent unique identifier." }, "refunded_amount": { "type": "number", "description": "The refunded amount of the Payment Intent." } } }, "PageResponseDTOOfPaymentAcceptanceRelatedOrder": { "type": "object", "properties": { "items": { "type": "array", "description": "The list of Payment Disputes.", "items": { "$ref": "#/components/schemas/RelatedOrder" } }, "page_after": { "type": "string", "description": "The BASE 64 encoded resource unique identifier of last Payment Dispute in items and navigation direction. When used in request, the response contains the page of Payment Dispute after it." }, "page_before": { "type": "string", "description": "The BASE 64 encoded resource unique identifier of first Payment Dispute in items and navigation direction. When used in request, the response contains the page of Payment Dispute before it." } } }, "AccountFundingAddress": { "type": "object", "required": [ "country_code" ], "properties": { "city": { "type": "string", "description": "City of the address." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "line1": { "type": "string", "description": "Address line1." }, "line2": { "type": "string", "description": "Address line2." }, "postcode": { "type": "string", "description": "Postcode of the address." }, "state": { "type": "string", "description": "State or province of the address." } }, "description": "Address of the recipient." }, "AccountFundingRecipient": { "type": "object", "properties": { "account_number": { "type": "string", "description": "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": { "$ref": "#/components/schemas/AccountFundingAddress", "description": "Address of the recipient." }, "first_name": { "type": "string", "description": "First name of the recipient." }, "last_name": { "type": "string", "description": "Last name of the recipient." }, "middle_name": { "type": "string", "description": "Middle name of the recipient." } }, "description": "Details of the recipient for this account funding transaction." }, "AccountFundingSender": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AccountFundingAddress", "description": "Address of the sender." }, "date_of_birth": { "type": "string", "description": "The sender’s date of birth. Format: YYYY-MM-DD (e.g., \"1989-07-15\")." }, "first_name": { "type": "string", "description": "First name of the sender." }, "last_name": { "type": "string", "description": "Last name of the sender." }, "middle_name": { "type": "string", "description": "Middle name of the sender." } }, "description": "Details of the sender for this account funding transaction." }, "AccountFundingData": { "type": "object", "required": [ "type" ], "properties": { "recipient": { "$ref": "#/components/schemas/AccountFundingRecipient", "description": "Details of the recipient for this account funding transaction." }, "sender": { "$ref": "#/components/schemas/AccountFundingSender", "description": "Details of the sender for this account funding transaction." }, "transfer_between_own_accounts": { "type": "boolean", "description": "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." }, "type": { "type": "string", "description": "Account funding transaction type. Possible values: \n\n- **ACCOUNT_TO_ACCOUNT_TRANSFER**: An account-to-account transfer, either within the same financial institution or to a different one.\n- **STORED_VALUE_DIGITAL_WALLET_TRANSFER**: Adding funds to or cashing out a Stored Value Digital Wallet (SVDW) account.\n- **STAGED_DIGITAL_WALLET_TRANSFER**: Funding a Staged Digital Wallet before the cardholder makes a purchase.\n- **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).\n- **LIQUID_ASSET_PURCHASE**: Funds transfer for the acquisition of liquid assets (for example, stocks, shares, foreign currency and cryptocurrency).\n" } }, "description": "Additional info for account funding transactions to ensure compliance with card networks." }, "CustomerSocialNetwork": { "type": "object", "properties": { "email": { "type": "string", "description": "The customer's email address on the social network." }, "name": { "type": "string", "description": "The social network used by the customer. Can be one of: `FACEBOOK`, `GOOGLE`, `TWITTER`, `REDDIT`, `PINTEREST`, `WECHAT`, `QQ`, `TWITCH`, `APPLE`, `DRIBBBLE`, `GITHUB`, `LINKEDIN`, `MAKER_STUDIOS`, `STACK_EXCHANGE`, `VIMEO`, `STEAM`, `KAKAO`, `NAVER`, `GRAB`, `JKOPAY`, `LINE`, `OTHER`." }, "profile_id": { "type": "string", "description": "The customer's profile unique identifier on the social network." } } }, "CustomerPurchaseSummary": { "type": "object", "required": [ "payment_method_type" ], "properties": { "currency": { "type": "string", "description": "The currency of successful purchase volume in 3-letter ISO 4217 currency code. Please refer to [supported currencies](/docs/payments/supported-currencies)." }, "first_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their first purchase in the merchant's system with the specified payment method type." }, "last_successful_purchase_date": { "type": "string", "description": "The date on which the customer completed their last purchase in the merchant's system with the specified payment method type." }, "payment_method_type": { "type": "string", "description": "Payment method type, one of `affirm`, `afterpay`, `atome`, `klarna`, and `other`." }, "successful_purchase_amount": { "type": "number", "description": "Total volume of successful purchases. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "successful_purchase_count": { "type": "integer", "format": "int32", "description": "Total number of successful purchases." } } }, "IntentCustomerAdditionalInfo": { "type": "object", "properties": { "account_type": { "type": "string", "description": "Customer account type. One of `GUEST`, `PRIVATE`, `BUSINESS`, `VIP`, `MERCHANT_OPERATED`, `TRIAL`, `MERCHANT_EMPLOYEE`, `PREMIUM_PAID`, `SMALL_BUSINESS`, `AGENT`." }, "first_successful_order_date": { "type": "string", "description": "Date at which the customer completes the first order on the merchant's site." }, "last_login_ip_address": { "type": "string", "description": "The public IP address used by the customer in the last login." }, "last_modified_at": { "type": "string", "description": "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`)." }, "linked_social_networks": { "type": "array", "description": "Social network data related to the customer.", "items": { "$ref": "#/components/schemas/CustomerSocialNetwork" } }, "purchase_summaries": { "type": "array", "description": "The purchase summaries of this customer with different payment methods in the merchant's system for risk analysis.", "items": { "$ref": "#/components/schemas/CustomerPurchaseSummary" } }, "registered_via_social_media": { "type": "boolean", "description": "Whether the customer registers through social media. Default to `false`." }, "registration_date": { "type": "string", "description": "Date at which the customer registers on the merchant's site." }, "registration_ip_address": { "type": "string", "description": "The public IP address used by the customer when registering on the merchant's site." } }, "description": "(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." }, "EnhancedSchemeCustomer": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "reference": { "type": "string", "description": "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." } }, "description": "Details of the customer making a payment for this Payment Intent." }, "EnhancedSchemeProduct": { "type": "object", "properties": { "code": { "type": "string", "description": "Merchant’s product identifier code. Maximum of 12 characters." }, "commodity_code": { "type": "string", "description": "The [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) for the product. Maximum of 12 characters." }, "description": { "type": "string", "description": "Product description. Maximum of 26 characters." }, "discount_amount": { "type": "number", "description": "The discount amount for the product. This amount must be expressed in the original currency of the transaction." }, "quantity": { "type": "integer", "format": "int32", "description": "Product quantity." }, "tax_percent": { "type": "number", "description": "The tax rate percentage for the product. Should be less than 100, up to 2 decimal places." }, "total_amount": { "type": "number", "description": "The total amount for the product. This amount must be expressed in the original currency of the transaction." }, "total_tax_amount": { "type": "number", "description": "The total amount of tax for the product. This amount must be expressed in the original currency of the transaction." }, "unit": { "type": "string", "description": "The unit of measure code used for the product. Maximum of 12 characters." }, "unit_price": { "type": "number", "description": "Product unit price. This amount must be expressed in the original currency of the transaction." } } }, "EnhancedSchemeShipping": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "Shipping address." }, "date": { "type": "string", "description": "The date the goods were shipped to the destination, in YYYY-MM-DD format." }, "fee_amount": { "type": "number", "description": "Shipping fee amount. This amount must be expressed in the same currency as the transaction amount." }, "from_postcode": { "type": "string", "description": "The postcode of the location the goods are being shipped from. Maximum of 10 characters." } }, "description": "Shipping information." }, "EnhancedSchemeData": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/EnhancedSchemeCustomer", "description": "Details of the customer making a payment for this Payment Intent." }, "customer_tax_identifier": { "type": "string", "description": "Tax identifier of the customer. Maximum of 13 characters." }, "duty_amount": { "type": "number", "description": "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": { "type": "string", "description": "Invoice reference number. Maximum of 17 characters." }, "local_tax_amount": { "type": "number", "description": "The amount of state or provincial tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "merchant_tax_identifier": { "type": "string", "description": "Tax identifier of the merchant. This can be a VAT / GST / other tax related identifier. Maximum of 20 characters." }, "national_tax_amount": { "type": "number", "description": "The amount of national tax on the transaction amount. This amount must be expressed in the original currency of the transaction." }, "products": { "type": "array", "description": "Product list.", "items": { "$ref": "#/components/schemas/EnhancedSchemeProduct" } }, "shipping": { "$ref": "#/components/schemas/EnhancedSchemeShipping", "description": "Shipping information." }, "summary_commodity_code": { "type": "string", "description": "The first 2,4 or 6 digits of [UNSPSC Commodity Code](https://www.ungm.org/Public/UNSPSC) 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." }, "total_tax_amount": { "type": "number", "description": "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." }, "vat_invoice_reference": { "type": "string", "description": "Value added tax invoice reference number. Maximum of 15 characters." } }, "description": "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." }, "EventInfo": { "type": "object", "required": [ "name" ], "properties": { "arena_location": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "The location of the venue." }, "arena_name": { "type": "string", "description": "The name of the venue." }, "arena_seat_number": { "type": "string", "description": "The seat number of the venue." }, "company": { "type": "string", "description": "The name of the company arranging the event." }, "customer_name": { "type": "string", "description": "The name of the customer." }, "customer_title": { "type": "string", "description": "The title used before the customer’s name. One of mr, ms, and mrs." }, "ends_at": { "type": "string", "description": "The event's end date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "name": { "type": "string", "description": "The name of the event." }, "starts_at": { "type": "string", "description": "The event's start date and time in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "type": { "type": "string", "description": "The category or type of the event." } } }, "OnlineTicketAgencyData": { "type": "object", "properties": { "events": { "type": "array", "description": "The details of the event.", "items": { "$ref": "#/components/schemas/EventInfo" } } }, "description": "The additional information for online ticket agency data." }, "AccommodationAddress": { "type": "object", "required": [ "city", "country_code", "postcode", "street" ], "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } }, "description": "The address of this accommodation." }, "Rating": { "type": "object", "properties": { "score": { "type": "string", "description": "The score of this rating." }, "source": { "type": "string", "description": "The source of this rating." }, "type": { "type": "string", "description": "The type of this rating. For example `Internal`, `External`." } } }, "Accommodation": { "type": "object", "required": [ "address", "check_in_date", "check_out_date", "guest_nationality", "guest_phone", "name", "room_type", "type" ], "properties": { "address": { "$ref": "#/components/schemas/AccommodationAddress", "description": "The address of this accommodation." }, "check_in_date": { "type": "string", "description": "Check-in date, in YYYY-MM-DD format." }, "check_out_date": { "type": "string", "description": "Check-out date, in YYYY-MM-DD format." }, "early_checkin": { "type": "boolean", "description": "Indicates if early check-in was paid for." }, "guest_email": { "type": "string", "description": "Guest email address for communication and confirmations." }, "guest_name": { "type": "string", "description": "Full legal name of the guest." }, "guest_nationality": { "type": "string", "description": "Nationality of the guest (ISO 3166-1 alpha-2 code)." }, "guest_phone": { "type": "string", "description": "Guest phone number." }, "late_checkout": { "type": "boolean", "description": "Indicates if late checkout was paid for." }, "name": { "type": "string", "description": "Name of the accommodation." }, "pre_tax_amount": { "type": "number", "description": "Accommodation amount excluding tax." }, "ratings": { "type": "array", "description": "Hotel rating(s) (from various sources).", "items": { "$ref": "#/components/schemas/Rating" } }, "room_type": { "type": "string", "description": "Type of room. For example `Presidential Suite`, `Single Room`, `Double Room`, `Suite`." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the accommodation price." }, "type": { "type": "string", "description": "Type of accommodation. For example `Hotel`, `Hostel`, `Resort`, `Apartment`." } } }, "InsuranceDetails": { "type": "object", "required": [ "company", "price", "type" ], "properties": { "company": { "type": "string", "description": "The insurance company name. Maximum length is 100." }, "price": { "type": "number", "description": "The insurance price in payment intent currency." }, "type": { "type": "string", "description": "The insurance type. One of `cancellation`, `delay`, `casualty`, `baggage`, and `other`." } } }, "TravelInfo": { "type": "object", "required": [ "arrival_city", "class_of_service", "departure_city", "passenger_name" ], "properties": { "arrival_city": { "type": "string", "description": "The city of the arrival. Maximum length is 100." }, "carrier": { "type": "string", "description": "The name of the transportation company." }, "class_of_service": { "type": "string", "description": "The itinerary service class." }, "departure_city": { "type": "string", "description": "The city of the departure. Maximum length is 100." }, "insurances": { "type": "array", "description": "The insurance list for the itinerary.", "items": { "$ref": "#/components/schemas/InsuranceDetails" } }, "passenger_identifier": { "type": "string", "description": "The identifier of the traveler in the merchant's system. Maximum length is 64." }, "passenger_name": { "type": "string", "description": "The name of the traveler. Maximum length is 100." }, "passenger_title": { "type": "string", "description": "The title used before the traveler’s name. One of `mr`, `ms`, and `mrs`." }, "price": { "type": "number", "description": "The itinerary unit price in payment intent currency." }, "scheduled_arrival_at": { "type": "string", "description": "The estimated arrival datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "The departure datetime in ISO 8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." } } }, "CarRentalAddress": { "type": "object", "required": [ "city", "country_code", "street" ], "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } }, "description": "The return address of this rental." }, "Vehicle": { "type": "object", "required": [ "license_plate", "manufacturer", "model" ], "properties": { "condition": { "type": "string", "description": "Condition of the vehicle. One of `GOOD`, `FAIR`, `POOR`." }, "license_plate": { "type": "string", "description": "License plate number." }, "manufacture_year": { "type": "string", "description": "Year of manufacture." }, "manufacturer": { "type": "string", "description": "Manufacturer of the vehicle." }, "model": { "type": "string", "description": "Model of the vehicle." }, "vin": { "type": "string", "description": "Vehicle Identification Number." } }, "description": "The details of the vehicle." }, "CarRental": { "type": "object", "required": [ "agreement_number", "driver_name", "driver_nationality", "drop_off_at", "pick_up_at" ], "properties": { "agreement_number": { "type": "string", "description": "Rental agreement number." }, "driver_email": { "type": "string", "description": "Driver email address for communication and confirmations." }, "driver_name": { "type": "string", "description": "Full legal name of the driver." }, "driver_nationality": { "type": "string", "description": "Nationality of the driver (ISO 3166-1 alpha-2 code)." }, "driver_phone": { "type": "string", "description": "Driver phone number." }, "drop_off_address": { "$ref": "#/components/schemas/CarRentalAddress", "description": "The return address of this rental." }, "drop_off_at": { "type": "string", "description": "Rental drop-off time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "insurances": { "type": "array", "description": "The list of insurances.", "items": { "$ref": "#/components/schemas/InsuranceDetails" } }, "pick_up_address": { "$ref": "#/components/schemas/CarRentalAddress", "description": "The start address of this rental." }, "pick_up_at": { "type": "string", "description": "Rental pick-up time, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "pre_tax_amount": { "type": "number", "description": "Rental amount excluding tax." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the rental price." }, "vehicle": { "$ref": "#/components/schemas/Vehicle", "description": "The details of the vehicle." } } }, "OnlineTravelAgencyCustomer": { "type": "object", "properties": { "loyalty_program_name": { "type": "string", "description": "The name of the loyalty program." }, "loyalty_program_points": { "type": "integer", "format": "int32", "description": "Points or miles in the loyalty program." }, "loyalty_program_tier": { "type": "string", "description": "Tier of the loyalty program. For example `Silver`, `Gold`, `Platinum`." }, "type": { "type": "string", "description": "Customer account type. One of `GUEST`, `MEMBER`." } }, "description": "Details of the customer making a payment for this Payment Intent." }, "Flight": { "type": "object", "required": [ "arrival_airport_code", "arrival_city", "arrival_country", "departure_airport_code", "departure_city", "departure_country", "flight_number", "passenger_name", "passenger_nationality", "scheduled_arrival_at", "scheduled_departure_at", "type" ], "properties": { "arrival_airport_code": { "type": "string", "description": "IATA code of the arrival airport." }, "arrival_city": { "type": "string", "description": "City where the arrival airport is located." }, "arrival_country": { "type": "string", "description": "Country where the arrival airport is located (ISO 3166-1 alpha-2 code)." }, "class_of_service": { "type": "string", "description": "Class of service. For example `Economy`, `Premium Economy`, `Business`, `First`." }, "departure_airport_code": { "type": "string", "description": "IATA code of the departure airport." }, "departure_city": { "type": "string", "description": "City where the departure airport is located." }, "departure_country": { "type": "string", "description": "Country where the departure airport is located (ISO 3166-1 alpha-2 code)." }, "flight_number": { "type": "string", "description": "Airline's unique flight number." }, "insurances": { "type": "array", "description": "The list of insurance.", "items": { "$ref": "#/components/schemas/InsuranceDetails" } }, "passenger_email": { "type": "string", "description": "Passenger email address for communication and confirmations." }, "passenger_name": { "type": "string", "description": "Full legal name of the passenger." }, "passenger_nationality": { "type": "string", "description": "Nationality of the passenger (ISO 3166-1 alpha-2 code)." }, "passenger_phone": { "type": "string", "description": "Passenger phone number." }, "pre_tax_amount": { "type": "number", "description": "Ticket amount excluding tax." }, "scheduled_arrival_at": { "type": "string", "description": "Scheduled arrival date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "scheduled_departure_at": { "type": "string", "description": "Scheduled departure date and time in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "seat_number": { "type": "string", "description": "Assigned seat number on the flight." }, "tax_amount": { "type": "number", "description": "Taxes and fees applied to the ticket price." }, "type": { "type": "string", "description": "Whether the flight is domestic or international. One of `DOMESTIC`, `INTERNATIONAL`." } } }, "OnlineTravelAgencyOrder": { "type": "object", "required": [ "cancellable", "created_at" ], "properties": { "cancellable": { "type": "boolean", "description": "Indicates if the booking is cancellable." }, "created_at": { "type": "string", "description": "The time of the order was made, in ISO8601 format. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "prepayment_model": { "type": "string", "description": "The model of payment. One of `FULL`, `PARTIAL`." } }, "description": "Purchase order related to this Payment Intent." }, "OnlineTravelAgencyData": { "type": "object", "properties": { "accommodations": { "type": "array", "description": "The details of accommodation.", "items": { "$ref": "#/components/schemas/Accommodation" } }, "buses": { "type": "array", "description": "The details of the buses travel.", "items": { "$ref": "#/components/schemas/TravelInfo" } }, "car_rentals": { "type": "array", "description": "The details of the car rental.", "items": { "$ref": "#/components/schemas/CarRental" } }, "customer": { "$ref": "#/components/schemas/OnlineTravelAgencyCustomer", "description": "Details of the customer making a payment for this Payment Intent." }, "ferries": { "type": "array", "description": "The details of the ferries travel.", "items": { "$ref": "#/components/schemas/TravelInfo" } }, "flights": { "type": "array", "description": "The details of the flights.", "items": { "$ref": "#/components/schemas/Flight" } }, "order": { "$ref": "#/components/schemas/OnlineTravelAgencyOrder", "description": "Purchase order related to this Payment Intent." }, "trains": { "type": "array", "description": "The details of the trains travel.", "items": { "$ref": "#/components/schemas/TravelInfo" } } }, "description": "The additional information for online travel agency data." }, "CustomerDetails": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "Address of the customer." }, "business_name": { "type": "string", "description": "Business name of the customer." }, "email": { "type": "string", "description": "Email address of the customer." }, "first_name": { "type": "string", "description": "First name of the customer." }, "last_name": { "type": "string", "description": "Last name of the customer." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of the customer in merchant's system. Maximum length is 64." }, "phone_number": { "type": "string", "description": "Phone number of the customer." } }, "description": "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." }, "FundsSplitData": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "Amount of this split. Please refer to [supported currencies](/docs/payments/supported-currencies) for supported minor units." }, "destination": { "type": "string", "description": "The destination that the money is splitting to. The value could be either:\n- a connected account ID. Used to split funds when collecting payments directly\n- a platform account ID. Used to split funds when collecting payments on behalf of connected accounts\nIf a value is not specified, the destination will be as specified in the Payment Intent." } } }, "DccData": { "type": "object", "properties": { "amount": { "type": "number", "description": "The proposed payment amount after Dynamic Currency Conversion (DCC)." }, "client_rate": { "type": "number", "description": "The proposed client rate for DCC." }, "currency": { "type": "string", "description": "Three-letter ISO code of the payment currency after DCC." }, "currency_pair": { "type": "string", "description": "Six-letter code representing the pair of Payment Intent currency and the proposed payment currency after DCC. Notice the preceding currency does not always represent the Payment Intent currency. The order of currencies only indicates the exchanging direction of `client_rate`." }, "rate_expiry": { "type": "string", "description": "Time at which the proposed `client_rate` expires." }, "rate_timestamp": { "type": "string", "description": "Time at which the proposed `client_rate` was generated." } }, "description": "The DCC data that can be used to complete this action." }, "Discount": { "type": "object", "properties": { "coupon_code": { "type": "string", "description": "Coupon code used." } }, "description": "Discount used by the customer." }, "SellerSalesSummary": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of sales amount." }, "period": { "type": "string", "description": "The period of this sales summary. Default to 12M (last 12 months)." }, "sales_amount": { "type": "number", "description": "The volume of sales completed by the seller in the last period." }, "sales_count": { "type": "integer", "format": "int32", "description": "The number of sales completed by the seller in the last period." } }, "description": "The sales summary of this seller during the last period." }, "SellerAdditionalInfo": { "type": "object", "properties": { "address_updated_at": { "type": "string", "description": "The timestamp of the latest address change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "email_updated_at": { "type": "string", "description": "The timestamp of the latest email change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "password_updated_at": { "type": "string", "description": "The timestamp of the latest password change. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "products_updated_at": { "type": "string", "description": "The timestamp of the latest change of product listing details. The timestamp must include an explicit timezone (e.g. `Z` or `-04:00`)." }, "sales_summary": { "$ref": "#/components/schemas/SellerSalesSummary", "description": "The sales summary of this seller during the last period." } }, "description": "The additional information of the seller in the merchant's system for risk analysis." }, "SellerBusinessInfo": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "Address of the seller." }, "email": { "type": "string", "description": "Email address of the seller." }, "phone_number": { "type": "string", "description": "Phone number of the seller." }, "rating": { "type": "number", "description": "The latest customer rating (out of 10) for this seller." }, "registration_date": { "type": "string", "description": "The date on which the seller registered in the merchant's system." } }, "description": "The business information of the seller in the merchant's system for risk analysis." }, "Seller": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/SellerAdditionalInfo", "description": "The additional information of the seller in the merchant's system for risk analysis." }, "business_info": { "$ref": "#/components/schemas/SellerBusinessInfo", "description": "The business information of the seller in the merchant's system for risk analysis." }, "identifier": { "type": "string", "description": "The identifier of the seller in the merchant's system. Maximum length is 64." }, "name": { "type": "string", "description": "The name of the seller in the merchant's system. Maximum length is 100." } } }, "SurchargeRes": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "The surcharge amount. This amount is included in the Payment Intent's total `amount`." }, "percent": { "type": "number", "description": "The surcharge rate in percentage. For example, 5 represents a 5% surcharge." } }, "description": "Surcharge Information." }, "Tip": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number", "description": "The tip amount. This amount is included in the total `amount`." } }, "description": "Tip information." }, "PaymentConsentOptions": { "type": "object", "required": [ "next_triggered_by" ], "properties": { "merchant_trigger_reason": { "type": "string", "description": "Indicate whether the subsequent payments are scheduled. Only applicable when `next_triggered_by` is `merchant`. One of `scheduled`, `unscheduled`, `installments`. \nDefault: `unscheduled`." }, "next_triggered_by": { "type": "string", "description": "The party to trigger subsequent payments. One of `merchant`, `customer`." }, "terms_of_use": { "$ref": "#/components/schemas/TermsOfUse", "description": "Terms to specify how this Payment Consent will be used." } }, "description": "The associated **Payment Consent** to set up along with the Payment Intent." }, "CardOptionsForCreate": { "type": "object", "properties": { "authorization_type": { "type": "string", "description": "The authorization type of the card payment. One of `final_auth`, `pre_auth`. Only applicable when `payment_method` is provided. Default to `final_auth`. Currently only available when `brand` is `visa` or `mastercard`." }, "auto_capture": { "type": "boolean", "description": "Specifies whether the funds should be requested automatically after the payment is authorized. Only applicable when `payment_method` is provided. Default to `true`." }, "card_input_via": { "type": "string", "description": "The channel through which the cardholder inputs the card. One of `ecommerce`, `moto`." }, "merchant_trigger_reason": { "type": "string", "description": "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.", "enum": [ "delayed_charges", "incremental_authorization", "no_show", "partial_shipment", "reauthorization", "resubmission" ] }, "three_ds_action": { "type": "string", "description": "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." } }, "description": "The Payment Method options for card." }, "WeChatPayOptions": { "type": "object", "properties": { "enable_funds_split": { "type": "boolean", "description": "Indicates whether funds split will be enabled for this WeChat Pay order." } }, "description": "The Payment Method options for wechatpay." }, "PaymentMethodOptionsForCreate": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/CardOptionsForCreate", "description": "The Payment Method options for card." }, "wechatpay": { "$ref": "#/components/schemas/WeChatPayOptions", "description": "The Payment Method options for wechatpay." } }, "description": "Options for Payment Method." }, "RiskControlOptions": { "type": "object", "properties": { "skip_risk_processing": { "type": "boolean", "description": "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`. " }, "tra_applicable": { "type": "boolean", "description": "Set it to 'true' if you want to use TRA exemption when create payment intent, only applicable when you skip risk processing." } }, "description": "Risk Control Options." }, "PaymentIntentSingle": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/Payment_Acceptance_AdditionalInfo", "description": "Additional info for the transaction." }, "amount": { "type": "number", "description": "Payment amount. This is the order amount you would like to charge your customer." }, "cancellation_reason": { "type": "string", "description": "Reason for cancelling the Payment Intent. Only present when the Payment Intent was successfully cancelled, i.e. status is `CANCELLED`." }, "cancelled_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Intent was cancelled. Only present when the Payment Intent was successfully cancelled, i.e. status is `CANCELLED`." }, "captured_amount": { "type": "number", "description": "Amount that captured from this Payment Intent." }, "client_secret": { "type": "string", "description": "Payment Intent's client secret for browser or app. Returned by Payment Intent create API or Payment Intent retrieve API \n\nThe provided client_secret is valid for 60 minutes." }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "conversion_quote_id": { "type": "string", "description": "The unique identifier of the conversion quote applied to the intent." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Intent was created." }, "currency": { "type": "string", "description": "Amount currency." }, "customer": { "$ref": "#/components/schemas/CustomerDetails", "description": "The details of the customer who is making a business payment for this Payment Intent, in which case it's not desired to create a Customer API resource. " }, "customer_id": { "type": "string", "description": "The unique identifier of the Customer who is paying for this Payment Intent." }, "descriptor": { "type": "string", "description": "Descriptor that will be displayed to the customer." }, "funds_split_data": { "type": "array", "description": "The data that will create funds splits automatically after the Payment Intent succeeds.", "items": { "$ref": "#/components/schemas/FundsSplitData" } }, "id": { "type": "string", "description": "Unique identifier for the Payment Intent." }, "invoice_id": { "type": "string", "description": "Invoice unique identifier." }, "latest_payment_attempt": { "$ref": "#/components/schemas/PaymentAttempt", "description": "Latest Payment Attempt that was created under the Payment Intent." }, "merchant_category_code": { "type": "string", "description": "Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code." }, "merchant_order_id": { "type": "string", "description": "The order unique identifier created in merchant's order system that corresponds to this Payment Intent." }, "merchant_website_url": { "type": "string", "description": "URL of the merchant's website where the customer is completing the transaction." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this Payment Intent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "next_action": { "$ref": "#/components/schemas/Payment_Acceptance_NextAction", "description": "Next action for merchant." }, "order": { "$ref": "#/components/schemas/Payment_Acceptance_PurchaseOrder", "description": "Purchase order related to this Payment Intent." }, "payment_consent": { "$ref": "#/components/schemas/PaymentConsentOptions", "description": "The associated **Payment Consent** to set up along with the Payment Intent." }, "payment_consent_id": { "type": "string", "description": "Unique identifier of the Payment Consent related to this Payment Intent." }, "payment_link_id": { "type": "string", "description": "Payment Link unique identifier (if this intent was created by Payment Link)." }, "payment_method_options": { "$ref": "#/components/schemas/PaymentMethodOptionsForCreate", "description": "Options for Payment Method." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after payment authentication." }, "risk_control_options": { "$ref": "#/components/schemas/RiskControlOptions", "description": "Risk Control Options." }, "status": { "type": "string", "description": "Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.\n\n- **REQUIRES_PAYMENT_METHOD**: The Payment Intent is waiting for the [confirm](/docs/api/payments/payment_intents/confirm) request.\n - This status is returned right after the Payment Intent is created or the previous Payment Attempt has failed or expired.\n- **REQUIRES_CUSTOMER_ACTION**: The Payment Intent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the `next_action`.\n- **PENDING_REVIEW**: The Payment Intent was successfully authorized, but it is currently under review for risk compliance.\n- **REQUIRES_CAPTURE**: The Payment Intent is waiting for your [capture](/docs/api/payments/payment_intents/capture) to complete the payment.\n- **PENDING**: The Payment Intent is pending the final result from the provider. No further action is required.\n- **SUCCEEDED**: The Payment Intent has succeeded. The payment is complete.\n- **CANCELLED**: The Payment Intent has been canceled by your [request](/docs/api/payments/payment_intents/cancel). The payment is closed.\n" }, "triggered_by": { "type": "string", "description": "Indicates who initiated the payment — the `merchant` or the `customer`.\n- `merchant`: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.\n- `customer`: The payment is initiated by the customer using stored payment method details. \n" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Intent was updated or operated on." } } }, "PaymentAttemptId": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the Payment Attempt." } }, "description": "Latest Payment Attempt that was created under the Payment Intent." }, "PaymentIntentList": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/Payment_Acceptance_AdditionalInfo", "description": "Additional info for the transaction." }, "amount": { "type": "number", "description": "Payment amount. This is the order amount you would like to charge your customer." }, "cancellation_reason": { "type": "string", "description": "Reason for cancelling the Payment Intent. Only present when the Payment Intent was successfully cancelled, i.e. status is `CANCELLED`." }, "cancelled_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Intent was cancelled. Only present when the Payment Intent was successfully cancelled, i.e. status is `CANCELLED`." }, "captured_amount": { "type": "number", "description": "Amount that captured from this Payment Intent." }, "client_secret": { "type": "string", "description": "Payment Intent's client secret for browser or app. Returned by Payment Intent create API or Payment Intent retrieve API \n\nThe provided client_secret is valid for 60 minutes." }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "conversion_quote_id": { "type": "string", "description": "The unique identifier of the conversion quote applied to the intent." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this Payment Intent was created." }, "currency": { "type": "string", "description": "Amount currency." }, "customer": { "$ref": "#/components/schemas/CustomerDetails", "description": "The details of the customer who is making a business payment for this Payment Intent, in which case it's not desired to create a Customer API resource. " }, "customer_id": { "type": "string", "description": "The unique identifier of the Customer who is paying for this Payment Intent." }, "descriptor": { "type": "string", "description": "Descriptor that will be displayed to the customer." }, "funds_split_data": { "type": "array", "description": "The data that will create funds splits automatically after the Payment Intent succeeds.", "items": { "$ref": "#/components/schemas/FundsSplitData" } }, "id": { "type": "string", "description": "Unique identifier for the Payment Intent." }, "invoice_id": { "type": "string", "description": "Invoice unique identifier." }, "latest_payment_attempt": { "$ref": "#/components/schemas/PaymentAttemptId", "description": "Latest Payment Attempt that was created under the Payment Intent." }, "merchant_category_code": { "type": "string", "description": "Four-digit code to categorize the business or service. This field is only applicable for approved merchants to specify an alternative category code." }, "merchant_order_id": { "type": "string", "description": "The order unique identifier created in merchant's order system that corresponds to this Payment Intent." }, "merchant_website_url": { "type": "string", "description": "URL of the merchant's website where the customer is completing the transaction." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this Payment Intent. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "next_action": { "$ref": "#/components/schemas/Payment_Acceptance_NextAction", "description": "Next action for merchant." }, "order": { "$ref": "#/components/schemas/Payment_Acceptance_PurchaseOrder", "description": "Purchase order related to this Payment Intent." }, "payment_consent": { "$ref": "#/components/schemas/PaymentConsentOptions", "description": "The associated **Payment Consent** to set up along with the Payment Intent." }, "payment_consent_id": { "type": "string", "description": "Unique identifier of the Payment Consent related to this Payment Intent." }, "payment_link_id": { "type": "string", "description": "Payment Link unique identifier (if this intent was created by Payment Link)." }, "payment_method_options": { "$ref": "#/components/schemas/PaymentMethodOptionsForCreate", "description": "Options for Payment Method." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "return_url": { "type": "string", "description": "The web page URL or application scheme URI to redirect the customer after payment authentication." }, "risk_control_options": { "$ref": "#/components/schemas/RiskControlOptions", "description": "Risk Control Options." }, "status": { "type": "string", "description": "Please note that this list of statuses is not exhaustive, you should be prepared to handle intent statuses beyond those explicitly mentioned.\n\n- **REQUIRES_PAYMENT_METHOD**: The Payment Intent is waiting for the [confirm](/docs/api/payments/payment_intents/confirm) request.\n - This status is returned right after the Payment Intent is created or the previous Payment Attempt has failed or expired.\n- **REQUIRES_CUSTOMER_ACTION**: The Payment Intent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check the `next_action`.\n- **PENDING_REVIEW**: The Payment Intent was successfully authorized, but it is currently under review for risk compliance.\n- **REQUIRES_CAPTURE**: The Payment Intent is waiting for your [capture](/docs/api/payments/payment_intents/capture) to complete the payment.\n- **PENDING**: The Payment Intent is pending the final result from the provider. No further action is required.\n- **SUCCEEDED**: The Payment Intent has succeeded. The payment is complete.\n- **CANCELLED**: The Payment Intent has been canceled by your [request](/docs/api/payments/payment_intents/cancel). The payment is closed.\n" }, "triggered_by": { "type": "string", "description": "Indicates who initiated the payment — the `merchant` or the `customer`.\n- `merchant`: The payment is initiated by the merchant to collect a subsequent payment where the customer is not in session.\n- `customer`: The payment is initiated by the customer using stored payment method details. \n" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which this Payment Intent was updated or operated on." } } }, "CollectableShopperInfo": { "type": "object", "properties": { "billing_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their billing address." }, "message": { "type": "boolean", "description": "Defaults to `true`. This is an optional field for the shopper to leave a message with their payment." }, "phone_number": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their phone number." }, "reference": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input a reference." }, "shipping_address": { "type": "boolean", "description": "Defaults to `false`. If true, the shopper is required to input their shipping address." } }, "description": "Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link." }, "PaymentLink": { "type": "object", "properties": { "active": { "type": "boolean", "description": "The payment link’s active status, either `true` or `false`." }, "amount": { "type": "number", "description": "The payment amount for Fixed pricing." }, "collectable_shopper_info": { "$ref": "#/components/schemas/CollectableShopperInfo", "description": "Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format when the payment link was created." }, "currency": { "type": "string", "description": "The payment currency for Fixed pricing." }, "customer_id": { "type": "string", "description": "The Customer who is paying for this Payment Link. Only applicable for links with `reusable` equals to `false`. This field is required if you want the payer to see the payment methods saved in the previous checkouts." }, "default_currency": { "type": "string", "description": "The default currency for Flexible pricing." }, "description": { "type": "string", "description": "The additional description text that appears under the title in the payment checkout page." }, "expires_at": { "type": "string", "format": "date-time", "description": "Payment link expiry timestamp in ISO 8601 format." }, "id": { "type": "string", "format": "uuid", "description": "Payment link unique identifier." }, "latest_successful_payment_intent_id": { "type": "string", "description": "Payment Intent unique identifier of the latest payment (if any) successfully paid by your shopper via the payment link." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Payment Link for storing additional information.", "additionalProperties": { "type": "string" } }, "reference": { "type": "string", "description": "A reference only visible to the merchant." }, "reusable": { "type": "boolean", "description": "Specifies whether the payment link can be used once or multiple times." }, "status": { "type": "string", "description": "Status of the payment link, one of `UNPAID` or `PAID`. The payment link transitions from `UNPAID` to `PAID` when a payment is received." }, "successful_payment_intent_count": { "type": "integer", "format": "int64", "description": "The number of Payment Intents successfully paid by your shopper via the payment link." }, "supported_currencies": { "type": "array", "description": "The supported currencies for Flexible pricing.", "items": { "type": "string" } }, "ui_options": { "type": "object", "description": "UI configuration for the payment checkout page.", "properties": { "theme_id": { "type": "string", "description": "ID of the theme to apply to this payment link, overriding the theme configured for its account." } } }, "title": { "type": "string", "description": "The title of the payment link that is displayed in the payment checkout page." }, "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 format when the payment link was last updated." }, "url": { "type": "string", "description": "The payment URL to the checkout page." } } }, "PaymentMethod": { "type": "object", "properties": { "ach_direct_debit": { "$ref": "#/components/schemas/AchDirectDebit", "description": "ACH Direct Debit information. Only provided when `type` is `ach_direct_debit`." }, "applepay": { "$ref": "#/components/schemas/Applepay", "description": "Apple pay information. Only provided when `type` is `applepay`." }, "bacs_direct_debit": { "$ref": "#/components/schemas/BacsDirectDebit", "description": "BACS Direct Debit information. Only provided when `type` is `bacs_direct_debit`." }, "becs_direct_debit": { "$ref": "#/components/schemas/BecsDirectDebit", "description": "BECS Direct Debit information. Only provided when `type` is `becs_direct_debit`." }, "card": { "$ref": "#/components/schemas/Payment_Acceptance_Card", "description": "Card information. Only provided when `type` is `card`." }, "created_at": { "type": "string", "format": "date-time", "description": "Time when the Payment Method was created." }, "customer_id": { "type": "string", "description": "The Customer this Payment Method belongs to." }, "eft_direct_debit": { "$ref": "#/components/schemas/EftDirectDebit", "description": "EFT Direct Debit information. Only provided when `type` is `eft_direct_debit`." }, "googlepay": { "$ref": "#/components/schemas/Googlepay", "description": "Google pay information. Only provided when `type` is `googlepay`." }, "id": { "type": "string", "description": "Unique identifier for the Payment Method." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to this Payment Method. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant." }, "sepa_direct_debit": { "$ref": "#/components/schemas/SepaDirectDebit", "description": "SEPA Direct Debit information. Only provided when `type` is `sepa_direct_debit`." }, "status": { "type": "string", "description": "Status of the Payment Method. One of `CREATED`, `DISABLED`." }, "type": { "type": "string", "description": "Type of the Payment Method. One of `card`, `applepay`, `googlepay`, `ach_direct_debit`, `bacs_direct_debit`, `becs_direct_debit`, `sepa_direct_debit`, `eft_direct_debit`." }, "updated_at": { "type": "string", "format": "date-time", "description": "Time when the Payment Method was last updated." } } }, "IssuerAccountRangeForMerchant": { "type": "object", "required": [ "card_brand", "card_type", "commercial_card" ], "properties": { "card_brand": { "type": "string", "description": "One of `visa`, `mastercard`, `union pay`, `american express`." }, "card_type": { "type": "string", "description": "- Visa: One of `credit`, `debit`, `prepaid`, `charge`, `deferred_debit`, `not_applicable`.\n- Mastercard: One of `debit`, `prepaid`, `credit`, `non_mastercard`.\n- Union Pay: One of `debit`, `prepaid`, `credit`.\n- American Express: One of `consumer`, `corporate`, `small_business`, `debit, prepaid`, `prepaid_reloadable`." }, "commercial_card": { "type": "boolean", "description": "A boolean field referring whether the card is commercial or not." }, "issuer_country_code": { "type": "string", "description": "Issuer country code." }, "issuer_name": { "type": "string", "description": "Issuer name." }, "product_code": { "type": "string", "description": "- Visa: it is `Product ID` description. For more details please refer to base-ii-clearing-data-codes Product ID Values section.\n- Mastercard: it will be `IP0040T1.Card_Program_ID`.\n- Union Pay: it will be one of `UNKNOWN`, `UNION_PAY_CLASSIC`, `RESERVED_2`, `UNION_PAY_GOLD`, `UNION_PAY_PLATINUM`, `UNION_PAY_DIAMOND`, `RESERVED_6`.\n" }, "product_description": { "type": "string", "description": "Description for `product_code`." }, "product_subtype_code": { "type": "string", "description": "- Visa: it will be production `sub-type id` description. For more details please refer to base-ii-clearing-ep-release-4-reports, 'EP-302 — Account Range Table (ARDEF) Field Descriptions' field `SU TY`.\n- Mastercard: it will be `IP0040T1.GCMS_Product_ID`.\n- Union Pay: it will be `BIN_Update_File.Card_Level`." }, "product_subtype_description": { "type": "string", "description": "Description for `product_subtype_code`." } } }, "Refund": { "type": "object", "properties": { "acquirer_reference_number": { "type": "string", "description": "A unique number that tags a credit or debit card transaction when it goes from the merchant's bank through to the cardholder's bank." }, "amount": { "type": "number", "description": "Amount to be refunded." }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which the Refund was created." }, "currency": { "type": "string", "description": "Currency of the Refund." }, "failure_details": { "$ref": "#/components/schemas/Payment_Acceptance_FailureDetails", "description": "Failure details. Only applicable when status is FAILED." }, "id": { "type": "string", "description": "Unique identifier for the Refund." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Refund. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "payment_attempt_id": { "type": "string", "description": "Unique identifier of Payment Attempt on which the Refund is created." }, "payment_intent_id": { "type": "string", "description": "Unique identifier of Payment Intent on which the Refund is created." }, "reason": { "type": "string", "description": "Reason of the Refund." }, "request_id": { "type": "string", "description": "Unique request identifier specified by the merchant in the last operation." }, "status": { "type": "string", "description": "Status of the Refund. One of `RECEIVED`, `ACCEPTED`, `SETTLED` or `FAILED` \n\n- **RECEIVED**: The Refund is created, which means the requested refund amount is valid and the payment is not in dispute.\n- **ACCEPTED**: The Refund has been accepted by the payment method provider and can be considered completed.\n- **SETTLED**: The Refund has been reconciled and will show up in the Airwallex settlement report.\n- **FAILED**: The Refund has been rejected, which can be caused by the insufficient Airwallex receivable/available balance, or by the provider for more channel-specific reasons.\n" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which the Refund was updated." } } }, "FeeRecord": { "type": "object", "properties": { "exchange_rate": { "type": "number", "description": "Exchange rate used for converting the fee currency into the settlement currency, if applicable." }, "fee_currency": { "type": "string", "description": "Three-letter ISO code for the fee." }, "fee_subtotal_amount": { "type": "number", "description": "Fee amount in the fee currency." }, "fee_type": { "type": "string", "description": "Categorisation of fee types." }, "incurred_at": { "type": "string", "description": "Timestamp of when the fee was incurred at." }, "payment_method_number_or_id": { "type": "string", "description": "Unique identifier for the payment method used, such as card BIN and last 4 digits or Alipay and WeChat Pay unique identifiers." }, "settlement_currency": { "type": "string", "description": "Three-letter ISO code for the settlement currency of the fee." }, "settlement_subtotal_amount": { "type": "number", "description": "Fee amount in the settlement currency." }, "settlement_tax_amount": { "type": "number", "description": "Taxes associated with the fee in the settlement currency." }, "settlement_total_amount": { "type": "number", "description": "Total amount of the fee after taxes are included, in the settlement currency." }, "source_status": { "type": "string", "description": "Status of the source, for example: failed, success." } } }, "SettlementRecord": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Unique identifier of your account in Airwallex." }, "acquirer_reference_number": { "type": "string", "description": "A unique number assigned to a card transaction as it moves through the payment flow. It can be used by banks to help trace a transaction if it appears to be missing. An ARN will be available for Visa and Mastercard charges." }, "card_category": { "type": "string", "description": "Card category, such as consumer, commercial, if applicable." }, "card_funding": { "type": "string", "description": "Card funding type, such as credit, debit, prepaid, if applicable." }, "card_issuing_or_shopper_country": { "type": "string", "description": "Country the shopper's payment method was issued in, if applicable." }, "card_transaction_region": { "type": "string", "description": "Identifies what region the card transaction has been classified as, such as domestic, regional or international." }, "connected_account_id": { "type": "string", "description": "Unique identifier of the connected account related to this transaction under the Payments for Platforms model, if applicable." }, "created_at": { "type": "string", "description": "Timestamp of when the financial transaction was created." }, "customer_email": { "type": "string", "description": "Email of the customer, if applicable." }, "customer_id": { "type": "string", "description": "Unique identifier of the customer in Airwallex, if applicable." }, "customer_name": { "type": "string", "description": "Name of the customer, if applicable." }, "customer_phone": { "type": "string", "description": "Phone number of the customer, if applicable." }, "descriptor": { "type": "string", "description": "Transaction descriptor that is displayed to the shopper." }, "dispute_reason": { "type": "string", "description": "Dispute reason from the payment method provider. For more information, refer to https://www.airwallex.com/docs/payments/disputes/dispute-reason-codes." }, "dispute_reason_code": { "type": "string", "description": "Dispute reason code from the payment method provider. For more information, refer to https://www.airwallex.com/docs/payments/disputes/dispute-reason-codes." }, "dispute_status": { "type": "string", "description": "The latest status of the dispute. For more information on dispute statuses, refer to https://www.airwallex.com/docs/payments/manage-payments/disputes/handle-disputes-on-the-airwallex-web-app." }, "exchange_rate": { "type": "number", "description": "Exchange rate used for converting the transaction amount into the settlement amount." }, "fee_details_list": { "type": "array", "description": "List of related fee records.", "items": { "$ref": "#/components/schemas/FeeRecord" } }, "fees": { "type": "number", "description": "Amount of the total fees paid for the transaction in the settlement currency, exclusive of taxes." }, "gross_amount": { "type": "number", "description": "Amount of the transaction, converted into the settlement currency." }, "issuing_or_originating_bank": { "type": "string", "description": "Name of financial institution that the shopper's payment method was issued from, if applicable." }, "merchant_customer_id": { "type": "string", "description": "Unique identifier of the customer provided by you, if applicable. Maximum length is 64." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the Settlement Record. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.", "additionalProperties": { "type": "string" } }, "net_amount": { "type": "number", "description": "Net amount of the transaction in the settlement currency, after subtracting the fees." }, "order_id": { "type": "string", "description": "Unique identifier from your order system associated with a payment intent." }, "payment_attempt_ids": { "type": "array", "description": "Unique identifiers for payment attempt associated with this payment.", "items": { "type": "string" } }, "payment_created_time": { "type": "string", "description": "Time at which the payment intent was created." }, "payment_intent_id": { "type": "string", "description": "Unique identifier for the payment intent." }, "payment_link_reference": { "type": "string", "description": "Reference for the payment link input by your customer, if applicable." }, "payment_method": { "type": "string", "description": "The payment method used by the shopper for this transaction." }, "payment_method_type": { "type": "string", "description": "Helps you identify the payment method, if applicable, for example: Card brand when Apple Pay or Google Pay are used: Visa, Mastercard, etc. Klarna: Pay Now, Pay Later, etc." }, "request_id": { "type": "string", "description": "Unique identifier from your system associated to your request to Airwallex." }, "settled_at": { "type": "string", "description": "Timestamp of when the financial transaction was settled into your wallet." }, "settlement_batch_id": { "type": "string", "description": "Unique identifier associated with the batch settlement." }, "settlement_currency": { "type": "string", "description": "Three-letter ISO code for the settlement currency of the transaction." }, "shipping_address": { "type": "string", "description": "First line of the shipping address associated with this transaction, if applicable." }, "shipping_city": { "type": "string", "description": "City of the shipping address associated with this transaction, if applicable." }, "shipping_country": { "type": "string", "description": "Country of the shipping address associated with this transaction, if applicable." }, "shipping_name": { "type": "string", "description": "Name on the shipping address associated with this transaction, if applicable." }, "shipping_postal_code": { "type": "string", "description": "Postal code of the shipping address associated with this transaction, if applicable." }, "shipping_state": { "type": "string", "description": "State of the shipping address associated with this transaction, if applicable." }, "source_entity": { "type": "string", "description": "Source object associated with the transaction." }, "source_id": { "type": "string", "description": "Unique identifier for the payment attempt, payment consent, refund, or dispute." }, "subscription_id": { "type": "string", "description": "Unique identifier of the subscription related to this transaction, if applicable." }, "taxes_on_fees": { "type": "number", "description": "Amount of the total taxes on fees paid for the transaction in the settlement currency." }, "transaction_amount": { "type": "number", "description": "Amount of the transaction." }, "transaction_currency": { "type": "string", "description": "Three-letter ISO code for the original currency sent to Airwallex for the transaction." }, "transaction_id": { "type": "string", "description": "Unique identifier associated with the financial transaction." }, "transaction_type": { "type": "string", "description": "Categorisation of financial transactions. Possible values: `Payment`, `Payment Reserve Hold`, `Payment Reserve Release`, `Split`, `Split Reversal`, `Dispute`, `Dispute Reversal`, `Dispute Lost`, `Dispute Won`, `Pre Chargeback Accepted`, `Pre Chargeback Withdrawn`, `Refund Pre Chargeback Accepted`, `Refund Chargeback Received`, `Refund Chargeback Withdrawn`, `Refund`, `Refund Reversal`, `Refund Failure`, `Account Verification`, `Verification`." } } }, "Terminal": { "type": "object", "properties": { "admin_password_status": { "type": "string", "description": "The terminal admin password status \n\n- **ACTIVE**: The terminal admin password is active.\n- **LOCKED**: The terminal admin password is locked.\n- **RESET_REQUESTED**: The terminal admin password requires reset.\n" }, "connected_account_id": { "type": "string", "description": "Account identifier of the connected account." }, "id": { "type": "string", "description": "Terminal unique identifier." }, "model": { "type": "string", "description": "Model of the Terminal, possible values are `morefun_m90`." }, "nickname": { "type": "string", "description": "Nickname of the Terminal." }, "refund_password_status": { "type": "string", "description": "The terminal refund password status \n\n- **ACTIVE**: The terminal refund password is active.\n- **LOCKED**: The terminal refund password is locked.\n- **RESET_REQUESTED**: The terminal refund password requires reset.\n- **OPT_OUT**: The terminal refund password is opted out.\n" }, "serial_number": { "type": "string", "description": "Serial number of the Terminal." }, "status": { "type": "string", "description": "Operational status of the Terminal \n\n- **ACTIVE**: The Terminal is activated and ready to use.\n- **INACTIVE**: The Terminal is deactivated for any reason.\n- **TERMINATED**: The Terminal is terminated and can't be used anymore.\n" } }, "description": "Detailed information about the Terminal." }, "ListOfTerminal": { "type": "object", "properties": { "items": { "type": "array", "description": "List items.", "items": { "$ref": "#/components/schemas/Terminal" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results. Provide this identifier in the page request parameter in a subsequent call to retrieve the next page of results. The value will be null for the last page." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list used in pagination to retrieve the previous page of results. Provide this identifier in the page request parameter in a subsequent call to retrieve the previous page of results. The value will be null for the first page." } } }, "Payment_Acceptance_Card": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/CardAdditionalInfo", "description": "Additional information of external network token requestor. Would return when number_type is `EXTERNAL_NETWORK_TOKEN`." }, "billing": { "$ref": "#/components/schemas/Billing", "description": "Billing information." }, "bin": { "type": "string", "description": "Bank identify number of this card." }, "brand": { "type": "string", "description": "Brand of the card. One of `mastercard`, `visa`, `union pay`, `american express`, `jcb`, `discover`, `diners club international`." }, "card_type": { "type": "string", "description": "Funding type of the card." }, "expiry_month": { "type": "string", "description": "Two digit number representing the card’s expiration month." }, "expiry_year": { "type": "string", "description": "Four digit number representing the card’s expiration year." }, "fingerprint": { "type": "string", "description": "Fingerprint of the card." }, "is_commercial": { "type": "boolean", "description": "A boolean field referring whether the card is commercial or not." }, "issuer_country_code": { "type": "string", "description": "Country code of the card issuer." }, "issuer_name": { "type": "string", "description": "Issuer name." }, "korean_card": { "$ref": "#/components/schemas/KoreanCardData", "description": "Information for Korean Card." }, "last4": { "type": "string", "description": "Last four digits of the card number." }, "lifecycle_id": { "type": "string", "description": "Identifier used to link the transaction to the original or previous transaction in a subscription or card-on-file chain. Currently supported only for Mastercard." }, "name": { "type": "string", "description": "Card holder name." }, "number_type": { "type": "string", "description": "Type of the number. One of `PAN`, `EXTERNAL_NETWORK_TOKEN`, `AIRWALLEX_NETWORK_TOKEN`." } }, "description": "Card information. Only provided when `type` is `card`." }, "Payment_Acceptance_Address": { "type": "object", "required": [ "country_code" ], "properties": { "city": { "type": "string", "description": "City of the address. Maximum of 100 characters." }, "country_code": { "type": "string", "description": "The two-letter country code in ISO 3166-1 alpha-2 format." }, "postcode": { "type": "string", "description": "Postcode of the address. Maximum of 10 characters." }, "state": { "type": "string", "description": "State or province of the address. Maximum of 100 characters." }, "street": { "type": "string", "description": "Street of the address. Maximum of 1000 characters." } }, "description": "The billing address as it appears on the credit card issuer’s records." }, "Payment_Acceptance_Shipping": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Payment_Acceptance_Address", "description": "Shipping address." }, "fee_amount": { "type": "number", "description": "Shipping fee amount." }, "first_name": { "type": "string", "description": "First name of the recipient. Maximum of 128 characters." }, "last_name": { "type": "string", "description": "Last name of the recipient. Maximum of 128 characters." }, "phone_number": { "type": "string", "description": "Phone number of the recipient. Maximum of 50 characters." }, "shipping_company": { "type": "string", "description": "Name of the shipping company. Maximum of 100 characters." }, "shipping_delayed_at": { "type": "string", "description": "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": { "type": "string", "description": "Shipping method for the product. Maximum of 128 characters." }, "tracking_number": { "type": "string", "description": "Tracking number of the shipment. Maximum of 100 characters." }, "tracking_url": { "type": "string", "description": "URL where the customer can track the shipment. Maximum of 1024 characters." } }, "description": "Shipping information." }, "Payment_Acceptance_FailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "The failure code returned by Airwallex." }, "details": { "type": "object", "description": "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." }, "message": { "type": "string", "description": "The failure description." }, "trace_id": { "type": "string", "description": "The unique identifier for tracing the failure." } }, "description": "Failure details. Only applicable when status is FAILED." }, "Payment_Acceptance_NextAction": { "type": "object", "properties": { "content_type": { "type": "string", "description": "The content type of the request when `method` is `POST`. If not provided, the content type should be `application/json`." }, "data": { "type": "object", "description": "The additional data that can be used to complete this action." }, "dcc_data": { "$ref": "#/components/schemas/DccData", "description": "The DCC data that can be used to complete this action." }, "fallback_url": { "type": "string", "description": "Fallback url to redirect the shopper to the web page if the redirection to the app fails. Returned only if the flow is `mobile_app`." }, "method": { "type": "string", "description": "The redirect method if the action type is `redirect`. One of `GET`, `POST`." }, "package_name": { "type": "string", "description": "Android package name. Returned only if the flow is `mobile_app` and the os_type is `android`." }, "qrcode": { "type": "string", "description": "QR Code text representation if the action type is `render_qrcode`, only applicable to `wechatpay`, `alipaycn`, `alipayhk`, `kakaopay`, `gcash`, `tng`, `truemoney`, `rabbit_line_pay`, `fps`." }, "type": { "type": "string", "description": "Type of next action. One of `render_qrcode`, `call_sdk`, `redirect`, `redirect_iframe`, `request_pin`." }, "url": { "type": "string", "description": "The redirect url." } }, "description": "Next action for merchant." }, "Payment_Acceptance_Mandate": { "type": "object", "properties": { "accepted_at": { "type": "string", "format": "date-time", "description": "The time at which shopper accepts the mandate." }, "bacs_direct_debit": { "$ref": "#/components/schemas/BacsDirectDebitMandate", "description": "BACS Direct Debit mandate information." }, "sepa_direct_debit": { "$ref": "#/components/schemas/SepaDirectDebitMandate", "description": "SEPA Direct Debit mandate information." }, "type": { "type": "string", "description": "The payment method type of the mandate. Can be `ach_direct_debit`, `bacs_direct_debit`, `becs_direct_debit`, `sepa_direct_debit`, `eft_direct_debit`." }, "version": { "type": "string", "description": "The version of the mandate." } }, "description": "An authorization from shopper to merchant to debit payments from their bank account." }, "Payment_Acceptance_AdditionalInfo": { "type": "object", "properties": { "account_funding_data": { "$ref": "#/components/schemas/AccountFundingData", "description": "Additional info for account funding transactions to ensure compliance with card networks." }, "customer_activity_data": { "$ref": "#/components/schemas/IntentCustomerAdditionalInfo", "description": "(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." }, "enhanced_scheme_data": { "$ref": "#/components/schemas/EnhancedSchemeData", "description": "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." }, "online_ticket_agency_data": { "$ref": "#/components/schemas/OnlineTicketAgencyData", "description": "The additional information for online ticket agency data." }, "online_travel_agency_data": { "$ref": "#/components/schemas/OnlineTravelAgencyData", "description": "The additional information for online travel agency data." } }, "description": "Additional info for the transaction." }, "Payment_Acceptance_PurchaseOrder": { "type": "object", "properties": { "discount": { "$ref": "#/components/schemas/Discount", "description": "Discount used by the customer." }, "foreign_retailer_amount": { "type": "number", "description": "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." }, "products": { "type": "array", "description": "Product list.", "items": { "$ref": "#/components/schemas/Product" } }, "sellers": { "type": "array", "description": "Seller list.", "items": { "$ref": "#/components/schemas/Seller" } }, "shipping": { "$ref": "#/components/schemas/Payment_Acceptance_Shipping", "description": "Shipping information." }, "surcharge": { "$ref": "#/components/schemas/SurchargeRes", "description": "Surcharge Information." }, "tip": { "$ref": "#/components/schemas/Tip", "description": "Tip information." }, "type": { "type": "string", "description": "Industry category of the order. Maximum of 128 characters." } }, "description": "Purchase order related to this Payment Intent." }, "BatchFunding": { "type": "object", "required": [ "status" ], "properties": { "deposit_type": { "type": "string", "description": "Can be one of: `FASTER_DIRECT_DEBIT`, `DIRECT_DEBIT`." }, "failure_details": { "$ref": "#/components/schemas/Payouts_FailureDetails", "description": "Details about why the funding has failed. Only present when the funding is in a failure state." }, "funding_source_id": { "type": "string", "description": "The id of the funding source, it can be null if using a wallet." }, "reference": { "type": "string", "description": "A user specified reference that will be displayed to the Direct Debit bank account owner on the bank statement. " }, "status": { "type": "string", "description": "The [Funding statuses](/docs/payouts/batch-transfers/create-a-batch-transfer/batch-transfer-statuses#funding-statuses) of this batch transfer, can be one of `SCHEDULED`, `PROCESSING`, `FUNDED`, `FAILED`, `REVERSED`." } }, "description": "The funding information of this batch transfer." }, "QuoteDetails": { "type": "object", "properties": { "amount_beneficiary_receives": { "type": "number", "description": "Total amount beneficiary will need receive quoted in `transfer_currency`." }, "amount_payer_pays": { "type": "number", "description": "Total amount payer need to pays quoted in `source_currency`." }, "client_rate": { "type": "number", "description": "Conversion rate. If pure transfer, it will be null." }, "currency_pair": { "type": "string", "description": "Currency pair related with the conversion rate. If pure transfer, it will be null." }, "fee_amount": { "type": "number", "description": "Total fee for this quote." }, "fee_currency": { "type": "string", "description": "Fee currency." }, "source_currency": { "type": "string", "description": "Source currency, i.e. the currency that the Payer uses to fund the transfer (3-letter ISO-4217 code)." }, "transfer_currency": { "type": "string", "description": "Transfer currency, i.e. the currency that the beneficiary receives (3-letter ISO-4217 code)." } } }, "QuoteSummary": { "type": "object", "required": [ "expires_at", "last_quoted_at" ], "properties": { "expires_at": { "type": "string", "description": "The time this batch transfer's quote will expire." }, "last_quoted_at": { "type": "string", "description": "The time this batch transfer last quoted." }, "quotes": { "type": "array", "description": "The quote details of the batch transfer.", "items": { "$ref": "#/components/schemas/QuoteDetails" } }, "validity": { "type": "string", "description": "Quote validity period in the request.", "enum": [ "MIN_1", "MIN_15", "MIN_30", "HR_1", "HR_4", "HR_8", "HR_24" ] } }, "description": "Summary of all transfer quotes in the batch. Quotes are consolidated based on currency pairs." }, "BatchTransfer": { "type": "object", "required": [ "id", "request_id", "short_reference_id", "status", "total_item_count", "updated_at", "valid_item_count" ], "properties": { "funding": { "$ref": "#/components/schemas/BatchFunding", "description": "The funding information of this batch transfer." }, "id": { "type": "string", "description": "System generated batch transfer id." }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the batch transfer.", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "The name of the batch transfer." }, "quote_summary": { "$ref": "#/components/schemas/QuoteSummary", "description": "Summary of all transfer quotes in the batch. Quotes are consolidated based on currency pairs." }, "remarks": { "type": "string", "description": "Additional information about this batch transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique batch transfer reference specified by the client." }, "short_reference_id": { "type": "string", "description": "System generated batch short reference id." }, "status": { "type": "string", "description": "[Batch transfer statuses](/docs/payouts/batch-transfers/create-a-batch-transfer/batch-transfer-statuses), can be one of: `DRAFTING`, `IN_APPROVAL`, `APPROVAL_RECALLED`, `APPROVAL_REJECTED`, `APPROVAL_BLOCKED`, `SCHEDULED`, `OVERDUE`, `BOOKING`, `PARTIALLY_BOOKED`, `BOOKED`, `FAILED`, `CANCELLATION_REQUESTED`, `CANCELLED`." }, "total_item_count": { "type": "integer", "format": "int32", "description": "The total count of items within the batch transfer." }, "transfer_date": { "type": "string", "description": "Date when batch transfer is scheduled to be processed." }, "updated_at": { "type": "string", "description": "The time this batch transfer was last updated." }, "valid_item_count": { "type": "integer", "format": "int32", "description": "The total count of valid batch transfer items contained. Invalid items will also be stored in the batch, you can use add_items and delete_items API to update it or execute without those invalid items." } } }, "CursorBasedPagedQueryResultDtoOfBatchTransfer": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/BatchTransfer" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "ErrorDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "Unique numeric identifier of the specific validation error encountered." }, "params": { "type": "object", "description": "Additional parsable information relating to the specific validation error where applicable, e.g. minimum and maximum character length." }, "source": { "type": "string", "description": "The specific field within the request that has failed." } } }, "ApplicationFeeOption": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } }, "ApplicationFee": { "type": "object", "properties": { "amount": { "type": "string", "description": "The application fee amount." }, "currency": { "type": "string", "description": "The currency of the application fee." }, "source_type": { "type": "string", "description": "Specify the type of source transaction for this application fee.", "enum": [ "CONVERSION", "TRANSFER" ] } } }, "StablecoinWallet": { "type": "object", "required": [ "address", "asset", "network" ], "properties": { "address": { "type": "string", "description": "Blockchain wallet address of the beneficiary." }, "asset": { "type": "string", "description": "Stablecoin asset type, e.g., `USDC`." }, "network": { "type": "string", "description": "Blockchain network, e.g., `ETHEREUM`." } }, "description": "Beneficiary's stablecoin wallet details where the payment will be credited." }, "TransferDraft": { "type": "object", "required": [ "amount_beneficiary_receives", "amount_payer_pays", "beneficiary", "fee_amount", "fee_currency", "fee_paid_by", "payer", "reason", "reference", "request_id", "short_reference_id", "source_amount", "source_currency", "transfer_amount", "transfer_currency", "transfer_date", "transfer_method" ], "properties": { "amount_beneficiary_receives": { "type": "number", "description": "The total amount (in transfer `transfer_currency`) the beneficiary receives for this transfer, and is governed by value specified in `fee_paid_by`, i.e. if `fee_paid_by` is `PAYER`, then the beneficiary receives the exact same `transfer_amount` since payer is responsible for the transfer fee. Otherwise, beneficiary receives `transfer_amount - fee` as the fee is implicitly passed onto the beneficiary." }, "amount_payer_pays": { "type": "number", "description": "The total amount (in `source_currency`) the payer has to pay for making this transfer. For example, if `fee_paid_by` is `PAYER` and FX conversion is not involved, then this is the sum of `transfer_amount + fee` as the payer is responsible for the fee. Otherwise this field is the same as `transfer_amount`." }, "application_fee_options": { "type": "array", "description": "The application fee options applied to the transfer.", "items": { "$ref": "#/components/schemas/ApplicationFeeOption" } }, "application_fees": { "type": "array", "description": "Application fees in this transfer.", "items": { "$ref": "#/components/schemas/ApplicationFee" } }, "beneficiary": { "$ref": "#/components/schemas/Payouts_Beneficiary", "description": "Details of the beneficiary." }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "beneficiary_id of the beneficiary contact used to create this transfer." }, "fee_amount": { "type": "number", "description": "The transfer fee (in `source_currency`) for sending this transfer." }, "fee_currency": { "type": "string", "description": "The transfer fee currency. This should always equal to the `source_currency`." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER` / `BENEFICIARY` will be liable for the the transfer fee. Defaults to `PAYER` unless field is populated in the request." }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "$ref": "#/components/schemas/Payouts_Payer", "description": "Details of the payer." }, "payer_id": { "type": "string", "format": "uuid", "description": "payer_id of the payer contact used to create this transfer." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "Bank transfer reference to be shown on beneficiary's bank transaction history." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request identifier specified in the transfer request." }, "short_reference_id": { "type": "string", "description": "Short transfer reference for support purposes." }, "source_amount": { "type": "number", "description": "Amount to be received." }, "source_currency": { "type": "string", "description": "Copied from the request if specified." }, "transfer_amount": { "type": "number", "description": "Amount to be paid." }, "transfer_currency": { "type": "string", "description": "Currency the transfer should be made in (3-letter ISO-4217 code)." }, "transfer_date": { "type": "string", "description": "Date when transfer should be made (Copied from the request if specified)." }, "transfer_method": { "type": "string", "description": "Copied from the request if specified. Otherwise the system will populate this field automatically." } }, "description": "Transfer draft preview after obtaining a quote. It will no longer be available once batch transfer is booked." }, "BatchTransferItem": { "type": "object", "required": [ "id", "request_id", "status", "updated_at" ], "properties": { "errors": { "type": "array", "description": "Any detailed error codes if status is `VALIDATION_FAILED` or `BOOKING_FAILED`.", "items": { "$ref": "#/components/schemas/ErrorDetails" } }, "id": { "type": "string", "description": "System generated batch transfer item id, can be used to delete batch items." }, "request_id": { "type": "string", "description": "Original request_id of the user for the batch item." }, "status": { "type": "string", "description": "Batch transfer item statuses, can be one of: `VALIDATION_FAILED`, `VALIDATED`, `BOOKING`, `BOOKED`, `BOOKING_FAILED`." }, "transfer_draft": { "$ref": "#/components/schemas/TransferDraft", "description": "Transfer draft preview after obtaining a quote. It will no longer be available once batch transfer is booked." }, "transfer_id": { "type": "string", "description": "System generated transaction id of the batch item, if not booked, return null." }, "updated_at": { "type": "string", "description": "The time this batch transfer was last updated." } } }, "CursorBasedPagedQueryResultDtoOfBatchTransferItem": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/BatchTransferItem" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "BeneficiaryContact": { "type": "object", "required": [ "beneficiary", "id", "transfer_methods" ], "properties": { "beneficiary": { "$ref": "#/components/schemas/Payouts_Beneficiary", "description": "Details of the beneficiary." }, "id": { "type": "string", "format": "uuid", "description": "id used to uniquely identify this beneficiary contact on the Airwallex platform." }, "nickname": { "type": "string", "description": "Nickname of the beneficiary." }, "payer_entity_type": { "type": "string", "description": "The payer entity type that will be used for transfers being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to `COMPANY`." }, "sca_exemptible": { "type": "boolean", "description": "Whether the beneficiary can be exempted from SCA when applicable." }, "transfer_methods": { "type": "array", "description": "Transfer method needs to be specified to ensure that accurate banking details are captured and validated for the specified transfer method. This is required for timely and accurate delivery of funds to the beneficiary account. Should be one of the following: `SWIFT`, `LOCAL`.", "items": { "type": "string" } } } }, "ApiSchemaField": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier of the field." }, "path": { "type": "string", "description": "Parameter path of this field when creating a beneficiary or a transfer, e.g., for the field \"first_name\", its parameter path would be \"beneficiary.first_name\"" }, "required": { "type": "boolean", "description": "Whether this field is required when creating a beneficiary or a transfer." }, "rule": { "type": "object", "description": "Specifies the field type and the field requirement in regular expression using JSON.", "additionalProperties": true } } }, "QueryParam": { "type": "object", "properties": { "name": { "type": "string", "description": "The key of the request parameter in the new API endpoint, e.g., `country_code`." }, "pattern": { "type": "string", "description": "Format requirement in regular expression." }, "required": { "type": "boolean", "description": "Whether this parameter is mandatory." }, "value_of": { "type": "string", "description": "The path to a field in this current API, e.g., `beneficiary.bank_details.bank_country_code`. Specify the value of this field in your request to the new API." } } }, "DynamicOptions": { "type": "object", "description": "Definition of a dedicated API endpoint for searching and retrieving the options of a `DYNAMIC_SELECT` field.", "properties": { "query_params": { "type": "array", "description": "An array of request parameters to use in the new API endpoint with definitions.", "items": { "$ref": "#/components/schemas/QueryParam" } }, "query_url": { "type": "string", "description": "Relative URL of the new API endpoint." } } }, "DynamicSelectField": { "type": "object", "description": "A dynamic single-select field (`type` = `DYNAMIC_SELECT`) whose options are retrieved from a dedicated API endpoint.", "properties": { "default": { "type": "string", "description": "Default value of the field." }, "description": { "type": "string", "description": "Description of the field." }, "example": { "type": "string", "description": "Example of the field." }, "key": { "type": "string", "description": "Key of the field." }, "label": { "type": "string", "description": "Label of the field." }, "placeholder": { "type": "string", "description": "Placeholder of the filed." }, "refresh": { "type": "boolean", "description": "Whether updating this field triggers UI reload event." }, "tip": { "type": "string", "description": "Tip is the information prompted for mouse hover." }, "type": { "type": "string", "description": "UI type of the field.", "enum": [ "INPUT", "SELECT", "RADIO", "TRANSFER_METHOD", "DYNAMIC_SELECT" ] }, "dynamic_options": { "$ref": "#/components/schemas/DynamicOptions", "description": "The definition of a dedicated API endpoint for searching and retrieving the options of this field. See [Get supported financial institutions](/docs/api/payouts/beneficiaries/supported_financial_institutions)." } } }, "FormSchemaField": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "This flag specifies whether a field should be enabled for end users on the user interface." }, "field": { "$ref": "#/components/schemas/DynamicSelectField", "description": "Field attributes define how each field in the form schema can be implemented in a user interface." }, "path": { "type": "string", "description": "Parameter path of this field when creating a beneficiary or a transfer, e.g., for the field \"first_name\", its parameter path would be \"beneficiary.first_name\"" }, "required": { "type": "boolean", "description": "Whether this field is required when creating a beneficiary or a transfer." }, "rule": { "type": "object", "description": "Specifies the field type and the field requirement in regular expression using JSON.", "additionalProperties": true } } }, "BankItem": { "type": "object", "properties": { "label": { "type": "string", "description": "Name of the financial institution." }, "value": { "type": "string", "description": "Routing code of the financial institution." } } }, "FinancialInstitution": { "type": "object", "properties": { "items": { "type": "array", "description": "Unpaginated results.", "items": { "$ref": "#/components/schemas/BankItem" } }, "truncated": { "type": "boolean", "description": "Whether all relevant results are returned. Refine the `keyword` in the request to narrow down results when this is `true`." } } }, "ErrorDetail": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error description." } } }, "ValidationFunction": { "type": "object", "properties": { "name": { "type": "string", "description": "The validation function identifier.\n\nThis can be mapped to a custom error translation or client side validation function.", "enum": [ "AccountCurrencyMatchesPaymentCurrency", "Alphanumeric", "AlphanumericIncludingPunctuation", "AlphanumericIncludingSpaces", "LengthOneOf", "Boolean", "BPayAlphanumeric", "ChineseCharacters", "ChineseCharactersIncludingPunctuation", "CNAccountNameMatchesFirstLastNameInChinese", "CNAccountNameNotFI", "Date", "DateTime", "DigitsOnly", "NotDigitsOnly", "Email", "Equal", "IbanCountryOneOf", "IbanOrAccountNumberIsMandatory", "Length", "MayNotSpecifyPayer", "MaxLength", "MinItems", "MinLength", "MinMaxLength", "NumberOfDecimalPlaces", "OneOf", "PaymentAmountOrSourceAmountIsSpecified", "PositiveNumber", "SwiftCodeMatchesCountry", "NoPOBoxAddress", "EmojisIsNotSupported", "ShouldNotTransferToSameAccountWithFXForward", "ShouldNotFXForwardWithInvalidReason", "AccountNumberIsNotVaild", "PEPersonalNumberIsVaild", "BOPersonalNumberIsVaild", "AlphanumericIncludingDotHyphen", "ValidPostCode", "ShouldNotContainSpace", "BRBranchNameIsVaildForBancodoBrasilSA", "BRBranchNameIsVaildForBancoSantanderBrasilSAORItauUnibancoSA", "BRBranchNameIsVaildForCaixaCEFORBancoBradescoSA", "BRBranchNameIsVaild", "BRCheckingsAccountNumberIsValidForCaixaCEF", "BRSavingsAccountNumberIdValidForCaixaCEF", "BRAccountNumberIsValidForBancodoBrasilSA", "BRAccountNumberIsValidForBancoSantanderBrasilSA", "BRAccountNumberIsValidForBancoBradescoSA", "BRAccountNumberIsValidForItauUnibancoSA", "BRAccountNumberIsValidForHSBCBankBrasilSA", "PhoneNumberFormat", "PhoneNumberCountryCode", "PhoneNumberLength", "BankAccountNumberIsValid", "AccountRoutingValue1IsReal", "MAMXNZAccountPrefixIsReal", "HKAccountPrefixIsReal", "BeneficiaryContactExists", "BeneficiaryContactIsValid", "BeneficiaryContactStreetAddressIsValid", "BeneficiaryContactSupportsPaymentMethod", "BillerIdIsReal", "CNAreaCodeIsReal", "CNBankCodeIsReal", "NepaleseBankCodeIsReal", "GteToday", "IbanIsValid", "IbanBankIsValid", "LocalClearingSystemIrrelevant", "MaxAmount", "MinAmount", "MinMaxAge", "PayerContactExists", "PayerContactIsValid", "PayerFromAccountIsValid", "PaymentChannelNotSupported", "PaymentOrderInfo_ItemTotalCorrect", "PaymentOrderInfo_OrdersAllSameCurrency", "PaymentOrderInfo_TotalEqualsPaymentAmount", "PaymentOrderInfo_TotalEqualsSourceAmount", "ScenarioIsNotSubmit", "SwiftCodeIsReal", "SwiftCodeIsSupported", "WhitespaceTrimmed", "MinCNPersonalIdAge", "PersonalIdAgeRange", "CNPersonalIdIsValid", "CNBankNumberIsQualify", "MetadataSizeIsValid", "PaperCheckEnabled", "CNBeneficiaryIsValid", "CNBeneficiaryCompanyIsValid", "JPBranchCodeIsReal", "RecipientIsAccountUBO", "MyBankDateSharingIsEnabled", "MyBankPaymentCollectionIsEnabled", "CABranchCodeIsReal", "SecurityQuestionAnswerRequired", "StablecoinWalletNetworkIsValid" ] }, "parameters": { "type": "object", "description": "Parameters of the validation rule, as an object.\nThese can be used to retrieve details of the relevant validation rule, as structured data.\nThis can be used for custom rule/error translations, client-side validation, client-side masking, populating dropdowns, etc.\nPlease review the parameterized descriptions below to see which parameters are returned for each type of validation function.\nE.g. `{ min: 5, max: 10 }`\n\n\nValidation functions which can be used for client-side validation (simple logic, no server-side dependencies):\n\n| Name | Description |\n| --- | --- |\n| AccountCurrencyMatchesPaymentCurrency | The bank account currency must match the payment currency |\n| Alphanumeric | Should contain alphanumeric characters only |\n| AlphanumericIncludingPunctuation | Should contain alphanumeric characters or punctuation only |\n| AlphanumericIncludingSpaces | Should contain alphanumeric characters or spaces only |\n| Boolean | Should be either true or false |\n| BPayAlphanumeric | Should only contain valid characters for Customer reference number |\n| ChineseCharacters | Should contain Chinese characters only |\n| ChineseCharactersIncludingPunctuation | Should contain Chinese characters or punctuation only |\n| CNAccountNameMatchesFirstLastNameInChinese | The account name should match the first and last names in Chinese |\n| RecipientIsAccountUBO | The beneficiary to add must belongs to one of the UBOs for the given MyBank account |\n| MyBankDateSharingIsEnabled | Data sharing must be enabled for the given MyBank account |\n| MyBankPaymentCollectionIsEnabled | Payment collection must be activated for the given MyBank account |\n| Date | Should be a valid date, formatted in ISO8601 date format |\n| DateTime | Should be a valid date and time, formatted in ISO8601 datetime format |\n| DigitsOnly | Should contain digits only |\n| Email | Should be a valid email address |\n| Equal | Should equal {value} |\n| IbanCountryOneOf | The country code in the IBAN should match the bank country code |\n| Length | Should be {length} characters long |\n| MaxLength | Should contain at most {max} characters |\n| MinItems | Should contain at least {min} item(s) |\n| MinLength | Should contain at least {min} characters |\n| MinMaxLength | Should contain {min} to {max} characters |\n| NumberOfDecimalPlaces | Should have at most {decimalPlaces} decimal places |\n| OneOf | Should be one of the following: [{values}] |\n| PaymentAmountOrSourceAmountIsSpecified | Either payment_amount or source_amount must be specified |\n| PositiveNumber | Should be a positive number |\n| PositivePrice | Should be positive, max. 2 decimal places |\n| SwiftCodeMatchesCountry | The SWIFT code should match the bank country code selected |\n\n\nValidation functions which should only be used for error/rule translation (complex logic or server-side dependencies):\n\n| Name | Description |\n| --- | --- |\n| AccountRoutingValue1IsReal | Should be valid and supported |\n| BeneficiaryContactExists | Should be an existing beneficiary for this account |\n| BeneficiaryContactIsValid | Should pass beneficiary validation |\n| BeneficiaryContactStreetAddressIsValid | Should provide street address |\n| BeneficiaryContactSupportsPaymentMethod | The specified beneficiary should support the specified payment method |\n| BillerIdIsReal | Should be valid and supported |\n| CNAreaCodeIsReal | Should be valid and supported |\n| CNBankCodeIsReal | Should be valid and supported |\n| GteToday | Should be today or a future date |\n| IbanIsValid | Should be valid and supported |\n| MayNotSpecifyPayer | payer or payer_id may not be provided |\n| MaxAmount | Should be at maximum {currency} {max} in value |\n| MinAmount | Should be at minimum {currency} {min} in value |\n| MinMaxAge | Should be between {min} and {max} years old |\n| PayerContactExists | Should be an existing payer for this account |\n| PayerContactIsValid | Should pass payer validation |\n| PaymentChannelNotSupported | This payment channel is not currently supported |\n| PaymentOrderInfo_ItemTotalCorrect | The line total of each item specified must match the unit price multiplied by the quantity |\n| PaymentOrderInfo_OrdersAllSameCurrency | All orders in this payment must be of the same currency |\n| PaymentOrderInfo_TotalEqualsPaymentAmount | The total amount of all orders for the payment must match the payment amount |\n| PaymentOrderInfo_TotalEqualsSourceAmount | The total amount of all orders for the payment must match the source amount |\n| SwiftCodeIsReal | Should be a valid and supported SWIFT code / BIC |\n| SwiftCodeIsSupported | Should be valid and supported |\n| WhitespaceTrimmed | Should not contain leading or trailing whitespace characters |.\n\n" }, "server_side_only": { "type": "boolean", "description": "Whether this validation function is unsuitable for mapping to a client-side validation function. Generally this indicates a dependence on server-side resources or complex logic." } } }, "FieldValidationError": { "type": "object", "properties": { "code": { "type": "string", "description": "The type of error. This determines the relevance of other error data fields.\n\n| Error code | Description |\n| --- | --- |\n| MISSING_REQUIRED_VALUE | The field is required but was not supplied |\n| FAILED_VALIDATION_FUNCTIONS | The supplied value failed one or more validation rules. Refer to `validation_functions`. |\n| INVALID_TYPE | The supplied value is not the correct data type. Refer to `expected_type`. |\n| IRRELEVANT_VALUE | An irrelevant field was supplied, e.g. company name for personal beneficiary. |\n| MISSING_DECISION_VALUE | The value of this field could not be implied from other supplied fields. |\n| SCHEMA_UNKNOWN | The schema for this field could not be determined. Refer to `schema_unknown_reason`. |\n| INTERNAL_ERROR | An unexpected internal problem has occurred. Please advise support if persists. |.\n", "enum": [ "INTERNAL_ERROR", "INVALID_TYPE", "IRRELEVANT_VALUE", "MISSING_DECISION_VALUE", "MISSING_REQUIRED_VALUE", "SCHEMA_UNKNOWN", "FAILED_VALIDATION_FUNCTIONS", "ERROR_VALIDATION_FAILED", "PROVIDER_VERIFICATION_FAILED" ] }, "description": { "type": "string", "description": "A display-friendly description of the error code.\n\nE.g. \"This field is required\"" }, "error_details": { "type": "array", "description": "A list of error detail, supporting validation revamp response standard.", "items": { "$ref": "#/components/schemas/ErrorDetail" } }, "expected_type": { "type": "string", "description": "The data type that should have been supplied.\n\nRelevant for error codes: `INVALID_TYPE`.", "enum": [ "array", "boolean", "number", "object", "string", "date", "enum" ] }, "schema_depends_on": { "type": "string", "description": "The field whose value is required to determine this field's schema.\n\nRelevant for schema unknown reasons: `DEPENDENCY_NOT_PROVIDED`, `DEPENDENCY_INVALID`.\n\n*[test-only]*: This field is for integration debugging purposes only and should not be used in production flows. It may be removed in future as a backwards-compatible change.\n" }, "schema_unknown_reason": { "type": "string", "description": "When schema rules are unknown, provides the reason why.\n\nRelevant for error codes: `SCHEMA_UNKNOWN`.\n\n*[test-only]*: This field is for integration debugging purposes only and should not be used in production flows. It may be removed in future as a backwards-compatible change.", "enum": [ "DEPENDENCY_NOT_PROVIDED", "DEPENDENCY_INVALID", "INTERNAL_ERROR" ], "x-enumDescriptions": { "DEPENDENCY_NOT_PROVIDED": "This field's rules could not be determined, as they depend on another field which was not supplied. Refer to `schema_depends_on` for the other field's path.", "DEPENDENCY_INVALID": "This field's rules could not be determined, as they depend on another field whose value is invalid. Refer to `schema_depends_on` for the other field's path, and check for a validation error reported against it.", "INTERNAL_ERROR": "An unexpected internal problem has occurred whilst trying to determine the schema for this field. Please advise support if persists." } }, "validation_functions": { "type": "array", "description": "A list of the validation functions which failed, including display-friendly descriptions and structured data for custom translation.\n\nRelevant for error codes: `FAILED_VALIDATION_FUNCTIONS`.", "items": { "$ref": "#/components/schemas/ValidationFunction" } }, "value": { "type": "object", "description": "The supplied value.\n\nRelevant for error codes: `INVALID_TYPE`, `IRRELEVANT_VALUE`, `SCHEMA_UNKNOWN`, `FAILED_VALIDATION_FUNCTIONS`." } } }, "Schema": { "type": "object", "properties": { "depends_on": { "type": "string", "description": "\nWhen dependency error, indicates the field whose value is required to determine this field's schema.\n\nApplicable for schema unknown reasons: `DEPENDENCY_NOT_PROVIDED`, `DEPENDENCY_INVALID`.\n\n*[test-only]*: This field is for integration debugging purposes only and should not be used in production flows. It may be removed in future as a backwards-compatible change.\n" }, "relevant": { "type": "boolean", "description": "When schema known, indicates whether the field is relevant in this scenario. This can be used to determine whether to display the field in the user interface.\n\nApplicable when `rules_known` is true." }, "required": { "type": "boolean", "description": "When relevant, indicates whether the field is mandatory (true) or optional (false).\n\nApplicable when `relevant` is true." }, "rules_known": { "type": "boolean", "description": "Indicates whether the schema could be determined for this field. If false, refer to `schema_unknown_reason`." }, "schema_input_only": { "type": "boolean", "description": "When relevant, indicates that this field is only used for specifying options during schema retrieval. These options are generally implied during creation requests.\n\nE.g. `locked_amount` is a decision field that specifies whether to use source amount or payment amount.\n\nApplicable when `relevant` is true." }, "schema_unknown_reason": { "type": "string", "description": "When schema rules are unknown, provides the reason why.\n\nApplicable when `rules_known` is false.\n\n*[test-only]*: This field is for integration debugging purposes only and should not be used in production flows. It may be removed in future as a backwards-compatible change.", "enum": [ "DEPENDENCY_NOT_PROVIDED", "DEPENDENCY_INVALID", "INTERNAL_ERROR" ], "x-enumDescriptions": { "DEPENDENCY_NOT_PROVIDED": "This field's rules could not be determined, as they depend on another field which was not supplied. Refer to `schema_depends_on` for the other field's path.", "DEPENDENCY_INVALID": "This field's rules could not be determined, as they depend on another field whose value is invalid. Refer to `schema_depends_on` for the other field's path, and check for a validation error reported against it.", "INTERNAL_ERROR": "An unexpected internal problem has occurred whilst trying to determine the schema for this field. Please advise support if persists." } }, "type": { "type": "string", "description": "When relevant, indicates the data type of the field.\n\nApplicable when `rules_known` is true.", "enum": [ "array", "boolean", "number", "object", "string", "date", "enum" ] }, "validation_functions": { "type": "array", "description": "When relevant, provides the rules this field must pass to be valid.\n\nThese include both textual descriptions and data, allowing for displaying rules/errors, client side validation, dropdown values, client side masking, etc.\n\nApplicable when `relevant` is true.", "items": { "$ref": "#/components/schemas/ValidationFunction" } } } }, "SchemaResult": { "type": "object", "properties": { "errors": { "type": "object", "description": "If the provided request is invalid, provides a map from field path to field validation failure details. Similar to the validation endpoint's response. May be used to both validate existing user form input and retrieve other fields in a single call.", "additionalProperties": { "$ref": "#/components/schemas/FieldValidationError" } }, "schema": { "type": "object", "description": "The schema for the given request, as a map from field path to field schema.", "additionalProperties": { "$ref": "#/components/schemas/Schema" } } } }, "BeneficiaryVerifyAccount": { "type": "object", "properties": { "account_name_match_result": { "type": "string", "description": "The result of account name check based on the `account_name` provided. See details in [Product Docs](/docs/payouts/beneficiaries/verify-a-beneficiary-account)." }, "resolved_account_name": { "type": "string", "description": "The account holder's name of the account specified if available." }, "resolved_bank_name": { "type": "string", "description": "Name of the account-holding bank if available." } }, "description": "Detailed verification results including name match results if available." }, "VerifyAccountApiResponseOfBeneficiaryVerifyAccount": { "type": "object", "properties": { "code": { "type": "string", "description": "The high-level outcome of account verification. Could be one of the following:\n- `VERIFIED`: This is a valid account (name match is not guaranteed).\n- `INVALID`: This account does not exist.\n- `CANNOT_VERIFY`: We cannot verify this account due to external restrictions.\n- `EXTERNAL_SERVICE_UNAVAILABLE`: The request failed due to unavailability of external services. Trying again later." }, "details": { "$ref": "#/components/schemas/BeneficiaryVerifyAccount", "description": "Detailed verification results including name match results if available." }, "message": { "type": "string", "description": "A descriptional message of the verification result." } } }, "PayerContact": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "id used to uniquely identify this payer contact on the Airwallex platform." }, "nickname": { "type": "string", "description": "Nickname of the payer." }, "payer": { "$ref": "#/components/schemas/Payouts_Payer", "description": "Details of the payer." } } }, "UnderlyingConversion": { "type": "object", "required": [ "currency_pair", "rate" ], "properties": { "currency_pair": { "type": "string", "description": "The currency pair of the conversion." }, "rate": { "type": "number", "description": "The rate of the conversion." } }, "description": "Conversion details of a transfer with currency conversions." }, "DispatchInfo": { "type": "object", "properties": { "external_reference": { "type": "string", "description": "A reference ID to track a transfer after it's dispatched from Airwallex. For stablecoin transfers, this is the on-chain transaction hash." }, "external_reference_type": { "type": "string", "description": "The definition of the `external_reference` in the payment system. Possible values include `NETWORK_TRANSACTION_ID` for stablecoin transfers (blockchain transaction hash)." } }, "description": "Additional details populated after the transaction is sent to Airwallex's downstream for processing. Only available for some transfer methods - see [Product Docs](/docs/payouts/transfers/create-a-transfer) for details." }, "Failure": { "type": "object", "properties": { "code": { "type": "string", "description": "Failure code." }, "message": { "type": "string", "description": "Failure message." }, "details": { "type": "object", "description": "Additional failure details.", "properties": { "type": { "type": "string", "description": "Failure type." }, "reason_codes": { "type": "array", "description": "Detailed reason code.", "items": { "type": "string" } } } } }, "description": "Failure details if the transfer is in an error state." }, "Prepayment": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "The prepayment amount to be paid." }, "currency": { "type": "string", "description": "The prepayment currency." } }, "description": "Prepayment details for a schedule transfer with currency conversions at a confirmed rate." }, "Transfer": { "type": "object", "required": [ "amount_beneficiary_receives", "amount_payer_pays", "beneficiary", "created_at", "fee_amount", "fee_currency", "fee_paid_by", "funding", "id", "payer", "reason", "reference", "request_id", "short_reference_id", "source_amount", "source_currency", "status", "transfer_amount", "transfer_currency", "transfer_date", "transfer_method", "updated_at" ], "properties": { "amount_beneficiary_receives": { "type": "number", "description": "The total amount (in transfer `transfer_currency`) the beneficiary receives for this transfer, and is governed by value specified in `fee_paid_by`, i.e. if `fee_paid_by` is `PAYER`, then the beneficiary receives the exact same `transfer_amount` since payer is responsible for the transfer fee. Otherwise, beneficiary receives `transfer_amount - fee` as the fee is implicitly passed onto the beneficiary." }, "amount_payer_pays": { "type": "number", "description": "The total amount (in `source_currency`) the payer has to pay for making this transfer. For example, if `fee_paid_by` is `PAYER` and FX conversion is not involved, then this is the sum of `transfer_amount + fee` as the payer is responsible for the fee. Otherwise this field is the same as `transfer_amount`." }, "application_fee_options": { "type": "array", "description": "The application fee options applied to this transfer.", "items": { "$ref": "#/components/schemas/ApplicationFeeOption" } }, "application_fees": { "type": "array", "description": "Application fees in this transfer.", "items": { "$ref": "#/components/schemas/ApplicationFee" } }, "batch_transfer_id": { "type": "string", "description": "Unique identifier of the batch containing the transfer." }, "beneficiary": { "$ref": "#/components/schemas/Payouts_Beneficiary", "description": "Details of the beneficiary." }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "beneficiary_id of the beneficiary contact used to create this transfer." }, "conversion": { "$ref": "#/components/schemas/UnderlyingConversion", "description": "Conversion details of a transfer with currency conversions." }, "created_at": { "type": "string", "description": "The time this transfer request was created." }, "dispatch_date": { "type": "string", "description": "Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the transfer date." }, "dispatch_info": { "$ref": "#/components/schemas/DispatchInfo", "description": "Additional details populated after the transaction is sent to Airwallex's downstream for processing. Only available for some transfer methods - see [Product Docs](/docs/payouts/transfers/create-a-transfer) for details." }, "failure": { "$ref": "#/components/schemas/Failure", "description": "Failure details if the transfer is in an error state." }, "fee_amount": { "type": "number", "description": "The transfer fee (in `source_currency`) for sending this transfer." }, "fee_currency": { "type": "string", "description": "The transfer fee currency. This should always equal to the `source_currency`." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER` / `BENEFICIARY` will be liable for the the transfer fee. Defaults to `PAYER` unless field is populated in the request." }, "funding": { "$ref": "#/components/schemas/Payouts_Funding", "description": "The funding information of this transfer." }, "id": { "type": "string", "format": "uuid", "description": "Returned `id` that can be used to query the status of the transfer." }, "lock_rate_on_create": { "type": "boolean", "description": "Denotes whether to lock the conversion rate for a scheduled transfer with value `TRUE` or `FALSE`.This field should only be specified when a conversion is involved. If not specified, the default value is `TRUE`. " }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "$ref": "#/components/schemas/Payouts_Payer", "description": "Details of the payer." }, "payer_id": { "type": "string", "format": "uuid", "description": "payer_id of the payer contact used to create this transfer." }, "prepayment": { "$ref": "#/components/schemas/Prepayment", "description": "Prepayment details for a schedule transfer with currency conversions at a confirmed rate." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "Bank transfer reference to be shown on beneficiary's bank transaction history." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request identifier specified in the transfer request." }, "short_reference_id": { "type": "string", "description": "Short transfer reference for support purposes." }, "source_amount": { "type": "number", "description": "Amount to be received." }, "source_currency": { "type": "string", "description": "Copied from the request if specified." }, "status": { "type": "string", "description": "The transfer status. Please see details in [Transfer Statuses](/docs/payouts/transfers/create-a-transfer/transfer-statuses)." }, "swift_charge_option": { "type": "string", "description": "(For SWIFT transfers only), specify who should bear SWIFT charges, either `SHARED` (default) or `PAYER`." }, "transfer_amount": { "type": "number", "description": "Amount to be paid." }, "transfer_currency": { "type": "string", "description": "Currency the transfer should be made in (3-letter ISO-4217 code)." }, "transfer_date": { "type": "string", "description": "Date when transfer should be made (Copied from the request if specified)." }, "transfer_method": { "type": "string", "description": "Copied from the request if specified. Otherwise the system will populate this field automatically." }, "updated_at": { "type": "string", "description": "The time this transfer request was last updated." } } }, "CursorBasedPagedQueryResultDtoOfTransfer": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/Transfer" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "Payouts_Card": { "type": "object", "required": [ "cardholder_name", "token" ], "properties": { "brand": { "type": "string", "description": "Card brand.", "readOnly": true }, "cardholder_name": { "type": "string", "description": "Cardholder name." }, "currency": { "type": "string", "description": "Card currency.", "readOnly": true }, "expiry_month": { "type": "string", "description": "Expiry month." }, "expiry_year": { "type": "string", "description": "Expiry year." }, "number": { "type": "string", "description": "Card number.", "readOnly": true }, "token": { "type": "string", "description": "Tokenised card number, which can be retrieved from Airwallex beneficiary component." } }, "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access" }, "Payouts_Beneficiary": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/BeneficiaryAdditionalInfo", "description": "Additional information about the beneficiary." }, "address": { "$ref": "#/components/schemas/BeneficiaryAddress", "description": "Beneficiary's address details." }, "bank_details": { "$ref": "#/components/schemas/BankDetails", "description": "Beneficiary's bank account details where the payment will be credited." }, "card": { "$ref": "#/components/schemas/Payouts_Card", "description": "Beneficiary's card details where the payment will be credited.", "x-stage": "early_access" }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "$ref": "#/components/schemas/DigitalWallet", "description": "Beneficiary's digital wallet details where the payment will be credited." }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "stablecoin_wallet": { "$ref": "#/components/schemas/StablecoinWallet", "description": "Beneficiary's stablecoin wallet details where the payment will be credited." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds." } }, "description": "Details of the beneficiary." }, "Payouts_Payer": { "type": "object", "required": [ "address", "entity_type" ], "properties": { "additional_info": { "$ref": "#/components/schemas/PayerAdditionalInfo", "description": "Additional information about the payer." }, "address": { "$ref": "#/components/schemas/PayerAddress", "description": "Payer's address details." }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } }, "description": "Details for the payer in the transfer request. If payer_id provided in the transfer request then payer should be empty." }, "Payouts_FailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "iso_code": { "type": "string", "description": "Error code [ISO 20022](https://www.iso20022.org/about-iso-20022) (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "provider_failure_details": { "$ref": "#/components/schemas/ProviderFailureDetails", "description": "A set of original information received from the local clearing system." } }, "description": "Details about why the funding has failed. Only present when the funding is in a failure state." }, "Payouts_Funding": { "type": "object", "required": [ "status" ], "properties": { "deposit_type": { "type": "string", "description": "Can be one of: `FASTER_DIRECT_DEBIT`, `DIRECT_DEBIT`." }, "failure_details": { "$ref": "#/components/schemas/Payouts_FailureDetails", "description": "Details about why the funding has failed. Only present when the funding is in a failure state." }, "failure_reason": { "type": "string", "description": "Empty unless the funding is in an error state." }, "funding_source_id": { "type": "string", "description": "The id of the funding source, it can be null if using a wallet." }, "status": { "type": "string", "description": "The funding status of this payment. Please see details in [Funding Statuses](/docs/payouts/transfers/create-a-transfer/transfer-statuses#funding-statuses)." } }, "description": "The funding information of this transfer." }, "UserAuthorizationRespond": { "type": "object", "properties": { "authorization_id": { "type": "string", "description": "Unique id for the authorization." }, "card_id": { "type": "string", "description": "Card id for the authorization." }, "cardholder_decision": { "type": "string", "description": "User Response to authorization." } } }, "RfiAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Response for `ADDRESS` type." }, "RfiFileId": { "type": "object", "properties": { "file_id": { "type": "string", "description": "File id provided in the response from the File Service API." } } }, "RfiIdentityDocument": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "issuing_country": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Identity number." }, "type": { "type": "string", "description": "Type of identity document. One of `DRIVING_LICENSE`,`PASSPORT`,`IDENTITY_CARD`,`MEDICARE_CARD`,`SSN`,`ITIN`." } }, "description": "Response for `IDENTITY_DOCUMENT` type." }, "RfiRequestItemResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/RfiAddress", "description": "Response for `ADDRESS` type." }, "attachments": { "type": "array", "description": "Response for `ATTACHMENT` type.", "items": { "$ref": "#/components/schemas/RfiFileId" } }, "comment": { "type": "string", "description": "comment for this response." }, "confirmed": { "type": "boolean", "description": "Response for `CONFIRMATION` type." }, "identity_document": { "$ref": "#/components/schemas/RfiIdentityDocument", "description": "Response for `IDENTITY_DOCUMENT` type." }, "text": { "type": "string", "description": "Response for `TEXT` type." }, "type": { "type": "string", "description": "The type of response to the question.", "enum": [ "TEXT", "ATTACHMENT", "IDENTITY_DOCUMENT", "CONFIRMATION", "LIVENESS", "ADDRESS" ] } }, "description": "Response to the question." }, "RfiSupportingDoc": { "type": "object", "properties": { "file_id": { "type": "string", "description": "File id used in File Service API to get file download link." } } }, "RfiRequestItemContent": { "type": "object", "properties": { "en": { "type": "string", "description": "Content in English." }, "zh": { "type": "string", "description": "Content in Chinese." } }, "description": "The description of the question." }, "Liveness": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the liveness verification.", "enum": [ "NOT_STARTED", "STARTED", "SUBMITTED", "SUCCEEDED", "FAILED" ] }, "url": { "type": "string", "description": "This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera. \n \nPlease note: \n\n- If `LIVENESS` is the only question in the RFI, the `Respond to an RFI` API does not need a separate call. It will be auto-resolved after verification.\n- For RFIs with both `LIVENESS` and other questions, please complete liveness verification before responding to the rest." } }, "description": "Information for the `LIVENESS` type questions." }, "RfiRequestItemSourcePerson": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name of the person." }, "last_name": { "type": "string", "description": "Last name of the person." } }, "description": "Information for `PERSON` source." }, "RfiRequestItemSource": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the source." }, "person": { "$ref": "#/components/schemas/RfiRequestItemSourcePerson", "description": "Information for `PERSON` source." }, "type": { "type": "string", "description": "The type of the source. Type of values and their corresponding API:\n\n\n- `PERSON`: [Get account by ID](/docs/api/scale/accounts/retrieve)\n\n- `BUSINESS`: match `account_details.business_person_details.person_id` with the source id\n- `INDIVIDUAL`: match `account_details.individual_details.person_id` with the source id\n- If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.\n\n- `CARDHOLDER`: [Get cardholder details](/docs/api/issuing/cardholders/retrieve)\n- `PAYMENT_INTENT`: [Retrieve a PaymentIntent](/docs/api/payments/payment_intents/retrieve)\n\nFor `TRANSACTION` RFI:\n\n- `CHARGE`: [Get a charge by ID](/docs/api/scale/charges/retrieve)\n- `CONNECTED_ACCOUNT_TRANSFER`: [Get a connected account transfer by ID](/docs/api/scale/connected_account_transfers/retrieve)\n- `DIRECT_DEBIT`: [Get direct debit by ID](/docs/api/core_resources/direct_debits/retrieve)\n- `DEPOSIT`: [Get a deposit by ID](/docs/api/core_resources/deposits/retrieve)\n- `TRANSFER`: [Get a transfer by ID](/docs/api/payouts/transfers/retrieve)." } } }, "UploadedOrder": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Unique identifier of the uploaded order." } } }, "RfiRequestItem": { "type": "object", "properties": { "answer": { "$ref": "#/components/schemas/RfiRequestItemResponse", "description": "Response to the question." }, "attachments": { "type": "array", "description": "The supporting documents of the question.", "items": { "$ref": "#/components/schemas/RfiSupportingDoc" } }, "comment": { "type": "string", "description": "Additional description for this question." }, "description": { "$ref": "#/components/schemas/RfiRequestItemContent", "description": "The description of the question." }, "id": { "type": "string", "description": "Unique identifier for the question." }, "key": { "type": "string", "description": "The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements \n \nPossible values: \n\n- `PROOF_OF_ADDRESS`\n- `ID_COPY`." }, "liveness": { "$ref": "#/components/schemas/Liveness", "description": "Information for the `LIVENESS` type questions." }, "sources": { "type": "array", "description": "In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified.", "items": { "$ref": "#/components/schemas/RfiRequestItemSource" } }, "title": { "$ref": "#/components/schemas/RfiRequestItemContent", "description": "The title of the question." }, "uploaded_orders": { "type": "array", "description": "The uploaded orders which are related to the transaction, only applicable for `TRANSACTION` RFI.", "items": { "$ref": "#/components/schemas/UploadedOrder" } } } }, "RfiRequest": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Timestamp the RFI request was created." }, "expires_at": { "type": "string", "description": "Timestamp the RFI request will expire, and the RFI status will be transited to `CLOSED`." }, "questions": { "type": "array", "description": "List of questions.", "items": { "$ref": "#/components/schemas/RfiRequestItem" } }, "updated_at": { "type": "string", "description": "The latest timestamp the RFI request was updated." } }, "description": "The current RFI request you are required to respond to." }, "RfiSession": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Airwallex account unique identifier." }, "active_request": { "$ref": "#/components/schemas/RfiRequest", "description": "The current RFI request you are required to respond to." }, "answered_requests": { "type": "array", "description": "The list of RFI requests that have already been responded to.", "items": { "$ref": "#/components/schemas/RfiRequest" } }, "created_at": { "type": "string", "description": "Timestamp the RFI was created." }, "id": { "type": "string", "description": "Unique identifier for the RFI." }, "status": { "type": "string", "description": "The status of the RFI. Possible values: \n \n\n- `ACTION_REQUIRED`: Airwallex requires you to respond to the RFI request\n- `ANSWERED`: You have already responded to the RFI request and your response is being reviewed by Airwallex\n- `CLOSED`: The review is complete and no further information is required." }, "sub_type": { "type": "string", "description": "The sub type of RFI. \nFor `TRANSACTION` RFI: \n- `TRANSACTION_MONITORING`: Internal transaction monitoring\n- `TRANSACTION_SCREENING`: Internal transaction screening\n- `BANKING_PARTNER_INQUIRY`: External banking partner inquiry." }, "type": { "type": "string", "description": "The type of RFI. Currently supports `KYC`, `KYC_ONGOING`, `CARDHOLDER`, `TRANSACTION`, `PAYMENT_ENABLEMENT` and `MERCHANT_RISK` types." }, "updated_at": { "type": "string", "description": "The latest timestamp the RFI was updated." } } }, "PagedRfiSessionQueryResult": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/RfiSession" } }, "page_after": { "type": "string", "description": "A bookmark for use in pagination to retrieve the next page of results. Provide this identifier in the page request parameter in a subsequent call to retrieve the next page of results. The value will be null for the last page." }, "page_before": { "type": "string", "description": "A bookmark for use in pagination to retrieve the previous page of results. Provide this identifier in the page request parameter in a subsequent call to retrieve the previous page of results. The value will be null for the first page." } } }, "SubsellerStatus": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Creation timestamp in ISO8601 format." }, "id": { "type": "string", "description": "Unique identifier of the seller." }, "status": { "type": "string", "description": "Status of the seller." }, "updated_at": { "type": "string", "description": "Last update timestamp in ISO8601 format." } } }, "SubsellerAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "Address line 1." }, "address_line2": { "type": "string", "description": "Address line 2." }, "country_code": { "type": "string", "description": "Country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postal code." }, "state": { "type": "string", "description": "State or province." }, "suburb": { "type": "string", "description": "Suburb or city." } }, "description": "Business address." }, "SubsellerWebsite": { "type": "object", "properties": { "url": { "type": "string", "description": "Website URL." } } }, "SubsellerDetails": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/SubsellerAddress", "description": "Business address." }, "business_identification_number": { "type": "string", "description": "Business identification number." }, "email": { "type": "string", "description": "Contact email." }, "industry_code": { "type": "string", "description": "Industry code." }, "legal_entity_name": { "type": "string", "description": "Legal entity name." }, "merchant_category_code": { "type": "string", "description": "Merchant category code." }, "phone_number": { "type": "string", "description": "Phone number." }, "registration_country": { "type": "string", "description": "Registration country code." }, "registration_date": { "type": "string", "description": "Registration date in YYYY-MM-DD format." }, "trading_name": { "type": "string", "description": "Trading name." }, "websites": { "type": "array", "description": "List of websites.", "items": { "$ref": "#/components/schemas/SubsellerWebsite" } } }, "description": "Seller details." }, "SubsellerDetailsResponse": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Creation timestamp in ISO8601 format." }, "details": { "$ref": "#/components/schemas/SubsellerDetails", "description": "Seller details." }, "id": { "type": "string", "description": "Unique identifier of the seller." }, "status": { "type": "string", "description": "Status of the seller." }, "updated_at": { "type": "string", "description": "Last update timestamp in ISO8601 format." } } }, "ListItem": { "type": "object", "properties": { "action": { "type": "string", "description": "Risk action to be taken by the risk engine: Use `BLOCK`, `VERIFY`, `ACCEPT` to always perform the associated risk action. The risk engine will prioritize actions in the following order: `BLOCK`>`VERIFY`>`ACCEPT`.\nPlease note that `ACCEPT` functionality will only be available to users with good fraud performance and will be subject to reasonable usage limits." }, "created_at": { "type": "string", "description": "The latest timestamp the Watchlist item was created." }, "id": { "type": "string", "description": "Unique identifier for the item." }, "reason": { "type": "string", "description": "The reason for adding this item to the Watchlist." }, "request_id": { "type": "string", "description": "Unique request id for the item." }, "status": { "type": "string", "description": "The status of the list item will be one of: `ACTIVE`, `INACTIVE`, `DEACTIVATED`. Default is `ACTIVE`. Some list items may be forcefully `DEACTIVATED` based on fraud performance." }, "type": { "type": "string", "description": "The type of the Watchlist item." }, "updated_at": { "type": "string", "description": "The latest timestamp the Watchlist item was updated." }, "value": { "type": "string", "description": "The value of the item corresponding to the correct type." } } }, "ListCursorBasedPagedQueryResult": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/ListItem" } }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." }, "page_before": { "type": "string", "description": "The page cursor used for search before page." } } }, "AdditionalAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the additional file.", "enum": [ "DRIVERS_LICENSE_FRONT", "DRIVERS_LICENSE_BACK", "PERSONAL_ID_FRONT", "PERSONAL_ID_BACK", "PASSPORT", "MEDICARE_CARD", "OTHER" ] } } }, "SupplementaryMaterials": { "type": "object", "properties": { "additional_files": { "type": "array", "description": "Additional files.", "items": { "$ref": "#/components/schemas/AdditionalAttachment" } } }, "description": "Supplementary files gathered during onboarding. May contain supplementary materials for BusinessEntity and BusinessPersons (UBO, etc)." }, "RevenueVolume": { "type": "object", "properties": { "amount": { "type": "string", "description": "The approximate amount of revenue a business generates in a month." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } }, "description": "The approximate amount of revenue a business generates in a month." }, "BusinessAccountUsage": { "type": "object", "properties": { "estimated_monthly_revenue": { "$ref": "#/components/schemas/RevenueVolume", "description": "The approximate amount of revenue a business generates in a month." }, "product_reference": { "type": "array", "description": "Intended product usage. \n`ACCEPT_ONLINE_PAYMENTS`,`COLLECT_MARKETPLACE_PROCEEDS`, \n`RECEIVE_TRANSFERS`,`GET_PAID`,`CONVERT_FUNDS`, \n`MAKE_TRANSFERS`,`CREATE_CARDS`,`MANAGE_EXPENSES`, \n`USE_AWX_API`,`TRANSFER_CNY_INBOUND`.", "items": { "type": "string" } } }, "description": "The intended purpose of the account, such as product usage and monthly turnover." }, "BusinessAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "TRUST_DEED", "UNIT_HOLDER_REGISTER", "UBO_SUPPORTIVE", "THIRD_PARTY_SHAREHOLDING_DOCUMENT", "EIN_LETTER" ] } } }, "BusinessDocumentation": { "type": "object", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "$ref": "#/components/schemas/BusinessAttachment" } } }, "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "BusinessIdentifier": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } }, "BusinessDetails": { "type": "object", "properties": { "account_usage": { "$ref": "#/components/schemas/BusinessAccountUsage", "description": "The intended purpose of the account, such as product usage and monthly turnover." }, "as_trustee": { "type": "boolean", "description": "Whether this account is set up as a trustee on behalf of a trust." }, "attachments": { "$ref": "#/components/schemas/BusinessDocumentation", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "business_address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business operates and conducts its activities." }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/BusinessIdentifier" } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_name_trading": { "type": "string", "description": "Also known as a \"doing business as\" (DBA) name, refers to a name under which the business operates and conducts its activities, which may differ from its legal name." }, "business_start_date": { "type": "string", "description": "The date on which the business officially begins its operations in YYYY-MM-DD format." }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "CORPORATION", "GENERAL_PARTNERSHIP", "LIMITED_LIABILITY_COMPANY", "LIMITED_LIABILITY_PARTNERSHIP", "LIMITED_PARTNERSHIP", "PARTNERSHIP", "SELF_MANAGED_SUPER_FUND", "SOLE_PROPRIETOR", "NON_REGISTERED_SOLE_PROPRIETOR", "TRUST", "OTHER" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "exports_goods_or_services": { "type": "boolean", "description": "Indicate whether the business engages in the export of goods and/or services." }, "fax_number": { "type": "string", "description": "Business fax number." }, "has_governing_document": { "type": "boolean", "description": "Indicate whether the NZ business has a governing document (e.g. a constitution, charter, rules, or a shareholders' agreement). Leave null when undeclared (do not default to false)." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_nominee_shareholders": { "type": "boolean", "description": "Indicate whether any of the individuals hold their shares on behalf of a third party." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "has_ringgit_borrowing": { "type": "boolean", "description": "Indicate whether the business engages in domestic Ringgit borrowing." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "no_shareholders_with_over_25percent": { "type": "boolean", "description": "Attestation of ownership structure without shareholders holding above 25% shares." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business is registered." }, "registration_address_english": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "state_of_incorporation": { "type": "string", "description": "The state where the business incorporated, different from registration state. (2-letter ISO 3166-2 state code)." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } }, "description": "General information about the business, such as its name, address, and other relevant details." }, "BusinessPersonAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PERSON_NAME_CHANGE_CERTIFICATE", "APPLICANT_SIGNATURE", "PROOF_OF_ADDRESS", "VIDEO_SELFIE", "PHOTO_SELFIE", "SUPPORTIVE_OTHER", "APPOINTMENT_DOCUMENT" ] } } }, "BusinessPersonDocumentation": { "type": "object", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "$ref": "#/components/schemas/BusinessPersonAttachment" } } }, "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.)." }, "DriverLicence": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } }, "description": "Driver's license." }, "Passport": { "type": "object", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } }, "description": "Passport." }, "PersonalId": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } }, "description": "Other government-issued unique identifier card." }, "BusinessPersonTaxId": { "type": "object", "properties": { "number": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Tax unique identifier number (e.g., SSN or ITIN for US persons)." }, "type": { "type": "string", "description": "**Required.** Tax unique identifier type.", "enum": [ "SSN", "VAT", "ITIN", "OTHERS" ] } }, "description": "Tax unique identifier." }, "BusinessIdentification": { "type": "object", "properties": { "drivers_license": { "$ref": "#/components/schemas/DriverLicence", "description": "Driver's license." }, "identification_type": { "type": "string", "description": "**Required.** Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "**Required** (optional if a document file is provided for OCR processing). Country where the identification document is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "$ref": "#/components/schemas/Passport", "description": "Passport." }, "personal_id": { "$ref": "#/components/schemas/PersonalId", "description": "Other government-issued unique identifier card." }, "tax_id": { "$ref": "#/components/schemas/BusinessPersonTaxId", "description": "Tax unique identifier." } }, "description": "Details of the primary identification." }, "BusinessIdentifications": { "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/BusinessIdentification", "description": "**Required when identifications is provided.** Details of the primary identification." }, "secondary": { "$ref": "#/components/schemas/BusinessIdentification", "description": "Details of the secondary identity verification." } }, "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "BusinessPersonDetail": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/BusinessPersonDocumentation", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format. Required for US accounts." }, "email": { "type": "string", "description": "Email of the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "first_name": { "type": "string", "description": "**Required for submit.** First name of the business person. 1–250 characters." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if first_name contains non-ASCII characters." }, "identifications": { "$ref": "#/components/schemas/BusinessIdentifications", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card. Required for all persons except director-only persons in AU/NZ, or when deferred identity verification is enabled." }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "**Required for submit.** Last name of the business person. 1–250 characters." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if last_name contains non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters). Required if middle_name contains non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code) Required for all persons except director-only persons in AU/NZ." }, "person_id": { "type": "string", "description": "Read-only. Unique Id of this person. Returned in responses after the person is created. Include this field when updating existing persons (API version 2023-06-01+) to update the correct record; omitting it creates a new person.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person. Note: this field may not be visible in the embedded KYC component for all regions." }, "residential_address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Residential address of the business person. Required for all persons except director-only persons in AU/NZ." }, "roles": { "type": "array", "description": "**Required for submit.** Roles of the business person. At least one role must be specified. Allowed values: `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. A maximum of one person can hold AUTHORISED_PERSON, CONTROLLING_PERSON, or LEGAL_REPRESENTATIVE. The order is not guaranteed in response.", "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } }, "TransactionVolume": { "type": "object", "properties": { "amount": { "type": "string", "description": "Estimate of the expected amount of money to be collected or paid out each month, in US dollars." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } }, "description": "Estimate of expected monthly transaction volume." }, "IndividualAccountUsage": { "type": "object", "properties": { "card_usage": { "type": "array", "description": "Ways in which the account will use Airwallex borderless cards. \n`GENERAL_EXPENSES`, `BUSINESS_EXPENSES`, `EDUCATION`, \n`TRAVEL_TRANSPORT`, `INSURANCE`, `SERVICES`, \n`BILLS_UTILITIES`, `INVESTMENT`, `FEES_CHARGES`, \n`HEALTHCARE`, `HOUSING`, `NO_CARD_USAGE`.", "items": { "type": "string", "enum": [ "GENERAL_EXPENSES", "BUSINESS_EXPENSES", "EDUCATION", "TRAVEL_TRANSPORT", "INSURANCE", "SERVICES", "BILLS_UTILITIES", "INVESTMENT", "FEES_CHARGES", "HEALTHCARE", "HOUSING", "NO_CARD_USAGE" ] } }, "collection_country_codes": { "type": "array", "description": "Countries from which the account will be collecting funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "collection_from": { "type": "array", "description": "Sources and counterparties from which the account will be collecting funds. \n`ALLOWANCE_FROM_FAMILY`, `BENEFITS_FROM_STATE`, `EMPLOYMENT_INCOME`, \n`INVESTMENT_INCOME_NONPROPERTY`, `INCOME_FROM_PROPERTY`, \n`INCOME_FROM_MARKETPLLACES`, \n`INSURANCE`, `LOANS`, `SAVINGS`, `OTHER_THIRD_PARTIES`, \n`PAYMENT_REFUNDS`.", "items": { "type": "string", "enum": [ "ALLOWANCE_FROM_FAMILY", "BENEFITS_FROM_STATE", "EMPLOYMENT_INCOME", "INVESTMENT_INCOME_NONPROPERTY", "INCOME_FROM_PROPERTY", "INCOME_FROM_MARKETPLLACES", "INSURANCE", "LOANS", "SAVINGS", "OTHER_THIRD_PARTIES", "PAYMENT_REFUNDS" ] } }, "expected_monthly_transaction_volume": { "$ref": "#/components/schemas/TransactionVolume", "description": "Estimate of expected monthly transaction volume." }, "payout_country_codes": { "type": "array", "description": "Countries to which the account will be paying funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "payout_to": { "type": "array", "description": "Beneficiaries and counterparties to which the account will be paying funds. \n`CONNECTED_AWX_ACCOUNT`, `EDUCATIONAL_INSTITUTIONS`, `FRIENDS_OR_RELATIVES`, \n`MARKETPLACE_PLATFORM`, `MARKETPLACE_SELLERS`, `MOBILITY_PLATFORM`, \n`OTHER_THIRD_PARTY_INDIVIDUALS`, `OWN_BANK_ACCOUNT`.", "items": { "type": "string", "enum": [ "CONNECTED_AWX_ACCOUNT", "EDUCATIONAL_INSTITUTIONS", "FRIENDS_OR_RELATIVES", "MARKETPLACE_PLATFORM", "MARKETPLACE_SELLERS", "MOBILITY_PLATFORM", "OTHER_THIRD_PARTY_INDIVIDUALS", "OWN_BANK_ACCOUNT" ] } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`CREATE_CARDS`, `MAKE_TRANSFERS`, `MARKETPLACE_WALLET`, \n`MOBILITY_WALLET`, `OTHERS`, `PAYROLL_WALLET`, \n`RECEIVE_TRANSFERS`, `TRADE_SECURITIES`, `TUITION_PAYMENTS`.", "items": { "type": "string", "enum": [ "CREATE_CARDS", "MAKE_TRANSFERS", "MARKETPLACE_WALLET", "MOBILITY_WALLET", "OTHERS", "PAYROLL_WALLET", "RECEIVE_TRANSFERS", "TRADE_SECURITIES", "TUITION_PAYMENTS" ] } } }, "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume." }, "IndividualAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "PERSON_NAME_CHANGE_CERTIFICATE", "PROOF_OF_ADDRESS", "SUPPORTIVE_OTHER", "VIDEO_SELFIE", "PHOTO_SELFIE" ] } } }, "IndividualDocuments": { "type": "object", "properties": { "individual_documents": { "type": "array", "description": "Identity files for individual accounts.", "items": { "$ref": "#/components/schemas/IndividualAttachment" } } }, "description": "Reference to uploaded identification document." }, "Employer": { "type": "object", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/BusinessIdentifier" } }, "business_name": { "type": "string", "description": "Name of the employer." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with the individual's employer. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." } }, "description": "Information of the individual's employer." }, "EstimatedMonthlyIncome": { "type": "object", "properties": { "amount": { "type": "string", "description": "Estimate of monthly income." }, "currency": { "type": "string", "description": "Currency of the income. (3-letter ISO 4217 currency code)." } }, "description": "Estimate of monthly income." }, "IndividualDriverLicence": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } }, "description": "Driver's license." }, "IndividualMedicareCard": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } }, "description": "Medicare card." }, "IndividualPassport": { "type": "object", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } }, "description": "Passport." }, "IndividualPersonalId": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } }, "description": "Personal unique identifier." }, "IndividualTaxId": { "type": "object", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "SSN", "ITIN" ] } }, "description": "Tax unique identifier." }, "IndividualIdDocumentation": { "type": "object", "properties": { "drivers_license": { "$ref": "#/components/schemas/IndividualDriverLicence", "description": "Driver's license." }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "$ref": "#/components/schemas/IndividualMedicareCard", "description": "Medicare card." }, "passport": { "$ref": "#/components/schemas/IndividualPassport", "description": "Passport." }, "personal_id": { "$ref": "#/components/schemas/IndividualPersonalId", "description": "Personal unique identifier." }, "tax_id": { "$ref": "#/components/schemas/IndividualTaxId", "description": "Tax unique identifier." } } }, "IndividualIdentifications": { "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/IndividualIdDocumentation" }, "secondary": { "$ref": "#/components/schemas/IndividualIdDocumentation" } }, "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "OtherName": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name (given name) of the individual person if different." }, "last_name": { "type": "string", "description": "Last name (family name) of the individual person if different." }, "middle_name": { "type": "string", "description": "Middle name of the individual person if different." } } }, "IndividualDetails": { "type": "object", "properties": { "account_usage": { "$ref": "#/components/schemas/IndividualAccountUsage", "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume." }, "attachments": { "$ref": "#/components/schemas/IndividualDocuments", "description": "Reference to uploaded identification document." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the account user in YYYY-MM-DD format." }, "employer": { "$ref": "#/components/schemas/Employer", "description": "Information of the individual's employer." }, "estimated_monthly_income": { "$ref": "#/components/schemas/EstimatedMonthlyIncome", "description": "Estimate of monthly income." }, "first_name": { "type": "string", "description": "First name of the account user." }, "first_name_english": { "type": "string", "description": "First name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "identifications": { "$ref": "#/components/schemas/IndividualIdentifications", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "last_name": { "type": "string", "description": "Last name of the account user." }, "last_name_english": { "type": "string", "description": "Last name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the account user." }, "middle_name_english": { "type": "string", "description": "Middle name of the account user. (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the account user. (2-letter ISO 3166-2 country code)." }, "occupation": { "type": "string", "description": "Occupation of the individual person.", "enum": [ "ACCOUNTANT", "ADMINISTRATION", "ARCHITECTURE", "ARTIST", "ATHLETE", "BEAUTY", "BUSINESSMAN", "CONSTRUCTION", "COOK", "DELIVERY", "DESIGNER", "ENGINEER", "FINANCE", "GOVERNMENT", "HEALTHCARE", "INSURANCE", "JOURNALIST", "LEGAL", "MANAGER", "MARKETING", "MEDIA", "MILITARY", "NURSE", "OFFICER", "OTHERS", "PILOT", "PROGRAMMER", "PRODUCTION", "REAL_ESTATE", "SALESPERSON", "SELF_EMPLOYMENT", "STUDENT", "SURVEYOR", "TEACHER", "TECHNICIAN", "TRAVEL", "UNEMPLOYED", "WAITER" ] }, "other_names": { "type": "array", "description": "Alias or other names of the individual person if different.", "items": { "$ref": "#/components/schemas/OtherName" } }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "Phone number of the account user, used for identity verification." }, "photo_holding_identification_file_id": { "type": "string", "description": "File id of a photo of the individual holding their identification. Applicable only if specifically requested by Airwallex." }, "residential_address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address of the account user." }, "residential_address_english": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the address field includes non-ASCII characters." } }, "description": "Individual details including name, including name, address, face photo, and documents." }, "EstimatedTransactionVolume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } }, "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex." }, "FinancialStatement": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } }, "PaymentDistribution": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "CARDS", "BANK_DIRECT_DEBIT", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } }, "StoreAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Physical address of the store." }, "StorePhoto": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } }, "StoreWebsite": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } }, "StoreDetails": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "$ref": "#/components/schemas/EstimatedTransactionVolume", "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex." }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "$ref": "#/components/schemas/FinancialStatement" } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "$ref": "#/components/schemas/PaymentDistribution" } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "$ref": "#/components/schemas/StoreAddress", "description": "Physical address of the store." }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "$ref": "#/components/schemas/StorePhoto" } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "$ref": "#/components/schemas/StoreWebsite" } } }, "description": "Relevant information associated with the store you are applying payment solutions for." }, "TrusteeBusiness": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/BusinessDocumentation", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/BusinessIdentifier" } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority.." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business.", "items": { "$ref": "#/components/schemas/BusinessPersonDetail" } }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "PARTNERSHIP", "SOLE_PROPRIETOR" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business is registered." }, "registration_address_english": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } }, "description": "Business details including the type of business, primary place of business, and industry type." }, "IdentityAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "DRIVERS_LICENSE_FRONT", "DRIVERS_LICENSE_BACK", "PERSONAL_ID_FRONT", "PERSONAL_ID_BACK", "PASSPORT" ] } } }, "IdentityInfo": { "type": "object", "properties": { "identity_files": { "type": "array", "description": "Identity files.", "items": { "$ref": "#/components/schemas/IdentityAttachment" } } }, "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.)." }, "TrusteeIndividual": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Embedded_Finance_Address", "description": "Address where the business is registered." }, "attachments": { "$ref": "#/components/schemas/IdentityInfo", "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the trustee in YYYY-MM-DD format." }, "first_name": { "type": "string", "description": "First name of the trustee." }, "first_name_english": { "type": "string", "description": "First name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identification_drivers_license_version": { "type": "string", "description": "Driver's license card number (not driver's license number) the trustee can provide." }, "identification_number": { "type": "string", "description": "Identification number the trustee can provide." }, "identification_type": { "type": "string", "description": "Identification type the trustee can provide." }, "last_name": { "type": "string", "description": "Last name of the trustee." }, "last_name_english": { "type": "string", "description": "Last name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the trustee. (2-letter ISO 3166-2 country code)." } } }, "TrusteeDetails": { "type": "object", "properties": { "business_details": { "$ref": "#/components/schemas/TrusteeBusiness", "description": "Business details including the type of business, primary place of business, and industry type." }, "individual_details": { "type": "array", "description": "Individual details including name, including name, address, face photo, and documents.", "items": { "$ref": "#/components/schemas/TrusteeIndividual" } }, "legal_entity_type": { "type": "string", "description": "Type of trustee. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } }, "description": "Only applicable for SELF_MANAGED_SUPER_FUND business structure, information about the trustee which can be a business or an individual." }, "AccountDetails": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/SupplementaryMaterials", "description": "Supplementary Materials." }, "business_details": { "$ref": "#/components/schemas/BusinessDetails", "description": "Business details including the type of business, primary place of business and industry type." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business. Each object represents an individual associated with the business (e.g., beneficial owner, director, authorized person).\n\n**Validation timing:** Most fields are accepted during an update call regardless of completeness. However, all fields marked as required below must be populated before the account can be submitted for KYC review via the Submit endpoint or the embedded KYC component.\n\n**Role requirements by country:** The array must collectively include at least one person for each required role: GB requires AUTHORISED_PERSON + BENEFICIAL_OWNER + DIRECTOR; US requires AUTHORISED_PERSON + BENEFICIAL_OWNER + DIRECTOR or CONTROLLING_PERSON; CN requires AUTHORISED_PERSON + BENEFICIAL_OWNER + LEGAL_REPRESENTATIVE; all other countries require AUTHORISED_PERSON + BENEFICIAL_OWNER.\n\n**Prefill behavior:** Data saved via this API is automatically prefilled in the embedded KYC component. For a person to appear in the KYC form, the `roles` field must be populated with at least one valid role. We recommend including `first_name`, `last_name`, and `roles` as the minimum payload for a visible, identifiable person entry.", "items": { "$ref": "#/components/schemas/BusinessPersonDetail" } }, "individual_details": { "$ref": "#/components/schemas/IndividualDetails", "description": "Individual details including name, address, face photo, and documents." }, "legal_entity_id": { "type": "string", "description": "Legal Entity unique identifier of the account." }, "legal_entity_type": { "type": "string", "description": "Type of account. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "store_details": { "$ref": "#/components/schemas/StoreDetails", "description": "Relevant information associated with the store you are applying payment solutions for." }, "trustee_details": { "$ref": "#/components/schemas/TrusteeDetails", "description": "Details identifying the trustee of the business." } }, "description": "Relevant information associated with Airwallex account specified in the request." }, "DeviceData": { "type": "object", "properties": { "ip_address": { "type": "string", "description": "The IP address from which the account representative accepted their service agreement." }, "user_agent": { "type": "string", "description": "The user agent of the browser from which the account representative accepted their service agreement." } }, "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis." }, "TermsAndConditions": { "type": "object", "properties": { "agreed_at": { "type": "string", "description": "The timestamp marking when the account representative agreed to their service agreement in ISO 8601 format." }, "device_data": { "$ref": "#/components/schemas/DeviceData", "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis." }, "service_agreement_type": { "type": "string", "description": "The user’s service type of their agreement. Default to FULL.", "enum": [ "FULL", "RECIPIENT" ], "x-enumDescriptions": { "FULL": "[FULL service agreement](https://www.airwallex.com/terms/scale-user-terms-global) creates a service relationship between Airwallex and the account holder.", "RECIPIENT": "[RECIPIENT service agreement](https://www.airwallex.com/terms/recipient-agreement-global) clarifies that there is no service relationship between Airwallex and the recipient, and that the recipient’s relationship is with the platform. This service agreement type is required for creating [Ledger Account](/docs/payments-for-platforms/use-cases/payments-for-marketplaces)." } } }, "description": "Terms and conditions between Airwallex and the account holder." }, "CustomerAgreements": { "type": "object", "properties": { "agreed_to_biometrics_consent": { "type": "boolean", "description": "Consent to Airwallex collecting and processing the biometrics data (applicable if liveness check is conducted)." }, "agreed_to_data_usage": { "type": "boolean", "description": "Consent to Airwallex using the provided data, including consent for Airwallex to verify the identity of relevant individuals with Airwallex service providers and database owners in accordance with the Identity Verification Terms." }, "agreed_to_terms_and_conditions": { "type": "boolean", "description": "Agreement to abide by the Airwallex terms and conditions." }, "opt_in_for_marketing": { "type": "boolean", "description": "Agreement to receive email from Airwallex on news, promotions, etc." }, "terms_and_conditions": { "$ref": "#/components/schemas/TermsAndConditions", "description": "Terms and conditions between Airwallex and the account holder." } }, "description": "Agreements collected from the user, such as acceptance of terms and conditions, or opt in for marketing." }, "PrimaryContact": { "type": "object", "properties": { "email": { "type": "string", "description": "A valid email address." }, "mobile": { "type": "string", "description": "A valid mobile phone number." } }, "description": "Contact information for the the primary contact of the Airwallex specified account. It is required to provide at least one form of contact information." }, "ReactivateDetail": { "type": "object", "properties": { "message": { "type": "string" }, "reactivated_at": { "type": "string" } }, "description": "The reactivate details for ACTIVE account with reactivation history." }, "AgreementToTermsAndConditionsRequired": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Call this endpoint to agree to terms and conditions.", "readOnly": true }, "message": { "type": "string", "description": "Message describing what needs to be done to agree to terms and conditions.", "readOnly": true }, "method": { "type": "string", "description": "Call the endpoint with this http method to agree to terms and conditions.", "readOnly": true } }, "description": "Agreement to terms and conditions required, only if account is submitted without having agreed." }, "OtherRequirement": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "OTHER" ] }, "message": { "type": "string", "description": "Information on requirement.", "readOnly": true } } }, "PhotoFileRequirement": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "FACE_CLOSE_TO_BORDER", "FACE_CROPPED", "FACE_IS_BLOCKED", "FACE_NOT_FOUND", "FACE_OVER_ROTATED", "FACE_TOO_CLOSE", "FACE_TOO_SMALL", "FAILED_TO_PROCESS_IMAGE", "LIVENESS_CHECK_FAILED", "OTHER", "TOO_MANY_FACES", "UNKNOWN" ] }, "message": { "type": "string", "description": "Information on requirement for Photo File.", "readOnly": true }, "photo_file_id": { "type": "string", "description": "Photo file as provided in the response from the File Service API.", "readOnly": true } }, "description": "File id of the photo file, only required if facial liveness check failed." }, "PhotoHoldingIdRequired": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "FACE_MATCHING_FAILED" ] }, "front_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "message": { "type": "string", "description": "Information on requirement for photo of person holding their id.", "readOnly": true }, "photo_file_id": { "type": "string", "description": "Photo file as provided in the response from the File Service API.", "readOnly": true } } }, "IdRequirement": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "ADDRESS_NOT_FOUND", "BLURRY_IMAGE", "DATA_COMPARISON_TOO_LOW", "DOCUMENT_TYPE_FAILED", "DOCUMENT_VALIDATION_FAILED", "EXPIRED_DOCUMENT", "FACE_MATCHING_FAILED", "FAILED_TO_PROCESS", "GLARE_IMAGE", "OTHER" ] }, "first_name": { "type": "string", "description": "First name of person requiring identification.", "readOnly": true }, "front_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "last_name": { "type": "string", "description": "Last name of person requiring identification.", "readOnly": true }, "message": { "type": "string", "description": "Information on requirement for identification.", "readOnly": true }, "middle_name": { "type": "string", "description": "Middle name of person requiring identification.", "readOnly": true } } }, "ReasonForDuplicateAccountRequired": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "OTHER" ] }, "message": { "type": "string", "description": "Information on requirement when the account appears to be a duplicate.", "readOnly": true } } }, "AccountRequirement": { "type": "object", "properties": { "agreement_to_terms_and_conditions_required": { "$ref": "#/components/schemas/AgreementToTermsAndConditionsRequired", "description": "Agreement to terms and conditions required, only if account is submitted without having agreed." }, "other": { "type": "array", "description": "Any other requirements.", "items": { "$ref": "#/components/schemas/OtherRequirement" } }, "photo_file_id_required": { "$ref": "#/components/schemas/PhotoFileRequirement", "description": "File id of the photo file, only required if facial liveness check failed." }, "photo_holding_id_required": { "type": "array", "description": "Photo of user holding their id, only required if document face matching failed.", "items": { "$ref": "#/components/schemas/PhotoHoldingIdRequired" } }, "primary_identification_required": { "type": "array", "description": "The primary form of identification, only required if document verification failed.", "items": { "$ref": "#/components/schemas/IdRequirement" } }, "reason_for_duplicate_account_required": { "type": "array", "description": "An explanation for why you are creating a second account, only required if one already exists.", "items": { "$ref": "#/components/schemas/ReasonForDuplicateAccountRequired" } }, "secondary_identification_required": { "type": "array", "description": "A secondary form of identification, only required if otherwise provided identification is insufficient to proceed.", "items": { "$ref": "#/components/schemas/IdRequirement" } } }, "description": "Further information required in order to proceed with this account." }, "SuspendDetail": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "message": { "type": "string" }, "suspended_at": { "type": "string" } } }, "Account": { "type": "object", "properties": { "account_details": { "$ref": "#/components/schemas/AccountDetails", "description": "Relevant information associated with Airwallex account specified in the request." }, "created_at": { "type": "string", "description": "Time the account was created.", "readOnly": true }, "customer_agreements": { "$ref": "#/components/schemas/CustomerAgreements", "description": "Agreements collected from the user, such as acceptance of terms and conditions, or opt in for marketing." }, "id": { "type": "string", "description": "Airwallex account unique identifier. Once this new account is created, it will be connected to your account and becomes the key value you communicate with Airwallex for any activities in the future." }, "identifier": { "type": "string", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format.", "additionalProperties": { "type": "string" } }, "next_action": { "$ref": "#/components/schemas/Embedded_Finance_NextAction", "description": "Further information required in order to proceed with this account." }, "nickname": { "type": "string", "description": "Optional human-friendly account name." }, "primary_contact": { "$ref": "#/components/schemas/PrimaryContact", "description": "Contact information for the primary contact of the Airwallex specified account." }, "reactivate_details": { "$ref": "#/components/schemas/ReactivateDetail", "description": "The reactivate details for ACTIVE account with reactivation history." }, "requirements": { "$ref": "#/components/schemas/AccountRequirement", "description": "Further information required in order to proceed with this account." }, "status": { "type": "string", "description": "Status of the account. One of `CREATED`, `SUBMITTED`, `ACTION_REQUIRED`, `ACTIVE`, `SUSPENDED`, `DORMANT`, `CLOSED`. After a completed offboarding the account enters pending closure and is returned as `SUSPENDED` on all API versions; after a 30-day grace period it is permanently closed (`CLOSED` on this version, `SUSPENDED` on earlier versions). Additional values may be introduced over time; handle unknown values gracefully.", "enum": [ "CREATED", "SUBMITTED", "ACTION_REQUIRED", "ACTIVE", "SUSPENDED", "DORMANT", "CLOSED" ], "x-enumDescriptions": { "CREATED": "Account has been created but not yet submitted.", "SUBMITTED": "Account has been submitted for review.", "ACTION_REQUIRED": "Additional information or action is required to continue.", "ACTIVE": "Account is active.", "SUSPENDED": "Account is temporarily suspended.", "DORMANT": "Account is inactive due to prolonged inactivity.", "CLOSED": "Account has been closed." } }, "suspend_details": { "type": "array", "description": "Details about why the account was suspended.", "readOnly": true, "items": { "$ref": "#/components/schemas/SuspendDetail" } }, "view_type": { "type": "string", "description": "Information on whether the response contains complete or PII excluded data." } } }, "Amendment": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier of the amendment." }, "primary_contact": { "$ref": "#/components/schemas/PrimaryContact", "description": "Contact information for the primary contact of the Airwallex specified account." }, "status": { "type": "string", "description": "Status of the amendment. One of `PENDING`, `APPROVED`, `REJECTED`." }, "store_details": { "$ref": "#/components/schemas/StoreDetails", "description": "Relevant information associated with the store you are applying payment solutions for." }, "target": { "type": "string", "description": "Target of the amendment.", "enum": [ "account_details.store_details", "primary_contact" ] } } }, "AccountWalletInfo": { "type": "object", "required": [ "account_name", "account_number" ], "properties": { "account_name": { "type": "string", "description": "The business name of an Airwallex account." }, "account_number": { "type": "string", "description": "A proxy unique identifier consists of 16 digits to represent an Airwallex account." } } }, "Charge": { "type": "object", "required": [ "amount", "created_at", "currency", "fee", "id", "reason", "reference", "request_id", "short_reference_id", "source", "status", "updated_at" ], "properties": { "amount": { "type": "number", "description": "Amount of the charge in `currency` specified in the request." }, "created_at": { "type": "string", "description": "The time this charge was created." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) specified in the request." }, "fee": { "type": "number", "description": "Fee of the charge in `currency` specified in the request." }, "id": { "type": "string", "description": "Unique identifier for the charge." }, "reason": { "type": "string", "description": "Reason for the charge instruction specified in the request." }, "reference": { "type": "string", "description": "User specified reference that will be displayed to the beneficiary specified in the request." }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request." }, "short_reference_id": { "type": "string", "description": "Short reference for support purposes." }, "source": { "type": "string", "description": "Airwallex account unique identifier specified in the request." }, "status": { "type": "string", "description": "Status of the charge. One of: `NEW`, `PENDING`,`SETTLED`,`SUSPENDED`, `FAILED`." }, "updated_at": { "type": "string", "description": "The time this charge was updated." } } }, "CardPaymentData": { "type": "object", "properties": { "amount": { "type": "string", "description": "The payment amount for this transaction." }, "brand": { "type": "string", "description": "The card brand. Possible enum values:", "enum": [ "MASTERCARD", "VISA", "UNION_PAY", "AMERICAN_EXPRESS", "JCB", "DISCOVER", "DINERS_CLUB_INTERNATIONAL" ] }, "card_issuing_country": { "type": "string", "description": "Country code where the card was issued (e.g., `US`, `GB`, `CN`)." }, "card_token": { "type": "string", "description": "A unique token (GUID) representing the customer’s card number." }, "card_type": { "type": "string", "description": "The card type. Possible enum values:", "enum": [ "CREDIT", "DEBIT", "PREPAID" ] }, "cardholder_name": { "type": "string", "description": "The cardholder's name. Not applicable to `APPLE_PAY` and `GOOGLE_PAY`." }, "created_at": { "type": "string", "description": "The timestamp when the customer created the payment transaction." }, "deposit_id": { "type": "string", "description": "The unique identifier of the deposit that corresponds to the settlement into Airwallex's Global Account." }, "ip_address": { "type": "string", "description": "IP address (IPv4 or IPv6) of the payer’s device at the time of payment." }, "payment_method": { "type": "string", "description": "The payment method used for this transaction. Possible enum values:", "enum": [ "APPLE_PAY", "GOOGLE_PAY", "CARD_ON_FILE" ] }, "three_dsecure_outcome": { "type": "string", "description": "The outcome of a 3D Secure authentication process, which verifies the identity of a cardholder during an online purchase. Possible enum values:", "enum": [ "ATTEMPTED", "AUTHENTICATED", "FAILED", "NOT_APPLICABLE", "NOT_REQUESTED" ] } }, "description": "Additional information about the card payment funding the connected account transfer." }, "MerchantData": { "type": "object", "properties": { "business_name": { "type": "string", "description": "The merchant's official legal name." }, "business_registration_date": { "type": "string", "description": "The date when the merchant's business was registered, in `YYYY-MM-DD` format. For example, `2025-03-15`." }, "business_registration_number": { "type": "string", "description": "The merchant's Business Registration Number (BRN) or equivalent identifier." }, "business_trading_name": { "type": "string", "description": "The merchant's trading or DBA (doing business as) name." }, "industry_category_code": { "type": "string", "description": "The merchant's industry category code." }, "merchant_identifier": { "type": "string", "description": "The merchant's unique identifier on the platform." }, "registration_country": { "type": "string", "description": "The merchant's country of registration in ISO 3166-1 alpha-2 format. For example, `CN` or `HK`." }, "store_urls": { "type": "array", "description": "The merchant's store URL(s).", "items": { "type": "string" } } }, "description": "Structured merchant information for nested-flow transfers." }, "ConnectedAccountTransfer": { "type": "object", "required": [ "amount", "created_at", "currency", "destination", "fee", "id", "reason", "reference", "request_id", "short_reference_id", "status", "updated_at" ], "properties": { "additional_info": { "$ref": "#/components/schemas/Embedded_Finance_AdditionalInfo", "description": "Additional information about the transaction." }, "amount": { "type": "number", "description": "Amount of the transfer in `currency` specified in the request." }, "created_at": { "type": "string", "description": "The time this transfer was created." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) specified in the request." }, "destination": { "type": "string", "description": "Airwallex account unique identifier specified in the request." }, "failure_reasons": { "type": "array", "description": "List of failure reason codes when status is FAILED.", "items": { "type": "string" } }, "fee": { "type": "number", "description": "Fee of the transfer in `currency` specified in the request." }, "id": { "type": "string", "description": "Unique identifier for the transfer." }, "reason": { "type": "string", "description": "Reason for the transfer instruction specified in the request." }, "reference": { "type": "string", "description": "User specified reference that will be displayed to the beneficiary specified in the request." }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request." }, "short_reference_id": { "type": "string", "description": "Short reference for support purposes." }, "status": { "type": "string", "description": "Status of the transfer. One of: `NEW`, `SETTLED`, `PENDING`, `SUSPENDED`, `FAILED`." }, "updated_at": { "type": "string", "description": "The time this transfer was updated." } } }, "AuthorizedAWXHostedFlow": { "type": "object", "properties": { "authorization_code": { "type": "string", "description": "This is a unique code embedded in url to authorize the user into the hosted flow. This code expires after 15 seconds." }, "id": { "type": "string", "description": "Unique identifier of the hosted flow instance." }, "metadata": { "type": "object", "description": "A set of key-value pairs that were specified in the request." }, "result": { "type": "object", "description": "The result of the flow execution, `null` if status is not `FINISHED`." }, "status": { "type": "string", "description": "The status of the flow instance.", "enum": [ "INIT", "PROCESSING", "FINISHED" ] }, "url": { "type": "string", "description": "The URL by which your authorized user can enter the hosted flow. This link is unique to the connected account id specified in the request and expires after 15 seconds." } } }, "AWXHostedFlow": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the hosted flow instance." }, "metadata": { "type": "object", "description": "The metadata set when creating the flow." }, "result": { "type": "object", "description": "The result of the flow execution, containing optional additional information for each flow action if status is `FINISHED`. It is usually empty." }, "status": { "type": "string", "description": "The `status` of the flow instance.", "enum": [ "INIT", "PROCESSING", "FINISHED" ] }, "url": { "type": "string", "description": "The URL by which only users with Airwallex login credentials can enter the flow. For your own users, make sure to [authorize](/docs/api/scale/hosted_flows/authorize) the flow next. This link is unique to the connected `account_id` specified in the request and expires after 15 seconds." } } }, "OauthReq": { "type": "object", "required": [ "redirect_uri", "response_type", "scope" ], "properties": { "redirect_uri": { "type": "string", "description": "The platform callback URL redirected to after auth." }, "response_type": { "type": "string", "description": "This tells the Airwallex authorization server that the platform is initiating a Scale Invitation Link flow with OAuth mode. One of `code`." }, "scope": { "type": "array", "description": "The permissions the platform is requesting from the user.", "items": { "type": "string" } }, "state": { "type": "string", "description": "The platform generates a random string and includes it in the request. It should then check that the same value is returned after the user authorizes the app. Max length is 100 characters." } }, "description": "OAuth parameters, if invitation link mode is `oauth2`." }, "PrefilledFormData": { "type": "object", "required": [ "field", "value" ], "properties": { "field": { "type": "string", "description": "the field name of pre filled form data.", "enum": [ "email", "first_name", "last_name", "mobile_number", "business_name", "country", "contact_name" ] }, "value": { "type": "string", "description": "The field value of pre-filled form data." }, "verified": { "type": "boolean", "description": "Whether the platform has verified the value." }, "editable": { "type": "boolean", "description": "Whether the user can edit the value." } } }, "ConnectReq": { "type": "object", "required": [ "redirect_uri" ], "properties": { "redirect_uri": { "type": "string", "description": "The platform callback URL redirected to after scale connect." } }, "description": "Scale connect parameters, if invitation link mode is `scale_connect`." }, "AccountLink": { "type": "object", "required": [ "scale_connect" ], "properties": { "account_id": { "type": "string", "description": "Invite Airwallex account Id." }, "created_at": { "type": "string", "description": "Time the account link was created.", "readOnly": true }, "expire_at": { "type": "string", "description": "Time the account link will expire.", "readOnly": true }, "id": { "type": "string", "description": "Airwallex account link unique identifier.", "readOnly": true }, "identifier": { "type": "string", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier. In oauth2 mode, identifier will be included in the query parameter when redirecting a user back to the client's redirect_uri. Max length is 1000 characters." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format. You can specify up to 5 keys, with key names up to 20 characters long and values up to 150 characters long.", "additionalProperties": { "type": "string" } }, "mode": { "type": "string", "description": "Invitation link mode.", "readOnly": true }, "oauth2": { "$ref": "#/components/schemas/OauthReq", "description": "OAuth parameters, if invitation link mode is `oauth2`." }, "prefilled_formdata": { "type": "array", "description": "Data pre-filled by platform during new user signup.", "items": { "$ref": "#/components/schemas/PrefilledFormData" } }, "scale_connect": { "$ref": "#/components/schemas/ConnectReq", "description": "Scale connect parameters, if invitation link mode is `scale_connect`." }, "url": { "type": "string", "description": "URL provided by Airwallex for the end user to use in order to complete their OAuth 2.0 authorization.", "readOnly": true } } }, "CreateProgramSpendingAccountResponse": { "type": "object", "properties": { "connected_account_id": { "type": "string", "description": "Unique identifier of the Connected Account that the spending account is linked to." }, "created_at": { "type": "string", "description": "The time the spending account was created." }, "funding_source_id": { "type": "string", "description": "Unique identifier of the funding source. Use this identifier to link a card to the program's spending account. Refer to [Create a Card](/docs/api/issuing/cards/create)." }, "id": { "type": "string", "description": "Unique identifier of the program spending account." }, "status": { "type": "string", "description": "Status of the spending account, either `ACTIVE` or `INACTIVE`." }, "updated_at": { "type": "string", "description": "The time the spending account was last updated." } }, "description": "Created Program Spending Account." }, "LimitBalance": { "type": "object", "properties": { "available_amount": { "type": "number", "description": "Available balance." }, "currency": { "type": "string", "description": "Three-letter ISO 4217 currency code." }, "reserved_amount": { "type": "number", "description": "Reserved balance." }, "total_amount": { "type": "number", "description": "Account total balance." } }, "description": "Limit balance information." }, "SupportedCurrency": { "type": "object", "properties": { "currency": { "type": "string", "description": "Three-letter ISO 4217 currency code." }, "low_balance_threshold": { "type": "number", "description": "Low balance threshold amount. When the available balance drops below this threshold, the low balance webhook will be triggered." } }, "description": "Currency configuration." }, "PlatformLiquidityProgram": { "type": "object", "properties": { "supported_connected_account_regions": { "type": "array", "description": "Array of two-letter region codes, in ISO 3166-1 alpha-2 format, that determine which connected account regions may onboard to this program.", "items": { "type": "string" } }, "created_at": { "type": "string", "description": "The time the program was created." }, "id": { "type": "string", "description": "Unique identifier of the Platform Liquidity Program." }, "limit_balances": { "type": "array", "description": "Array of program balance information.", "items": { "$ref": "#/components/schemas/LimitBalance" } }, "name": { "type": "string", "description": "Name of the Platform Liquidity Program." }, "status": { "type": "string", "description": "Status of the Platform Liquidity Program, either `ACTIVE` or `INACTIVE`." }, "supported_currencies": { "type": "array", "deprecated": true, "description": "Array of currency configurations.", "items": { "$ref": "#/components/schemas/SupportedCurrency" } }, "updated_at": { "type": "string", "description": "The time the program was last updated." } }, "description": "Platform Liquidity Program." }, "ProgramSpendingAccountLimitBalance": { "type": "object", "required": [ "available_amount", "currency", "reserved_amount", "total_amount" ], "properties": { "available_amount": { "type": "number", "description": "Amount available for new spending." }, "currency": { "type": "string", "description": "Three-letter ISO 4217 currency code." }, "reserved_amount": { "type": "number", "description": "Amount reserved by pending spending." }, "total_amount": { "type": "number", "description": "Sum of `available_amount` and `reserved_amount`." } }, "description": "Per-currency limit balance for a program spending account." }, "ProgramSpendingAccount": { "type": "object", "required": [ "limit_policy" ], "properties": { "connected_account_id": { "type": "string", "description": "Unique identifier of the Connected Account that the spending account is linked to." }, "created_at": { "type": "string", "description": "The time the spending account was created." }, "funding_source_id": { "type": "string", "description": "Unique identifier of the funding source. Use this identifier to link a card to the program's spending account. Refer to [Create a Card](/docs/api/issuing/cards/create)." }, "id": { "type": "string", "description": "Unique identifier of the program spending account." }, "limit_balances": { "type": "array", "description": "Per-currency balances when `limit_policy` is `ENFORCED`; `null` when `limit_policy` is `BYPASSED`.", "items": { "$ref": "#/components/schemas/ProgramSpendingAccountLimitBalance" } }, "limit_policy": { "type": "string", "description": "Policy controlling whether local spending limits are enforced.", "enum": [ "BYPASSED", "ENFORCED" ] }, "status": { "type": "string", "description": "Status of the spending account, either `ACTIVE` or `INACTIVE`." }, "updated_at": { "type": "string", "description": "The time the spending account was last updated." } }, "description": "Program Spending Account." }, "GetProgramSpendingAccounts": { "type": "object", "properties": { "items": { "type": "array", "description": "Array of program spending accounts.", "items": { "$ref": "#/components/schemas/ProgramSpendingAccount" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } }, "description": "Response containing list of program spending accounts." }, "ProgramTransaction": { "type": "object", "properties": { "amount": { "type": "number", "description": "The transaction amount." }, "available_limit": { "type": "number", "description": "The available limit after this transaction." }, "connected_account_id": { "type": "string", "description": "Unique identifier of the Connected Account to which the spending account is linked. Empty for `DC_CREDIT/DEBIT` transactions, which represent limit updates resulting from deposits and withdrawals." }, "currency": { "type": "string", "description": "The transaction currency in 3-letter ISO-4217 format." }, "id": { "type": "string", "description": "Unique identifier of the transaction object." }, "posted_at": { "type": "string", "description": "Timestamp of the transaction posted to balance." }, "source_id": { "type": "string", "description": "Unique identifier of the source transaction. For `LIQUIDITY_*` transactions, this is the Issuing card transaction event identifier, which can be retrieved using [Retrieve a Card Transaction Event](/docs/api/issuing/card_transaction_events/retrieve). For `DC_CREDIT` and `DC_DEBIT` transactions, this is the financial transaction identifier, which can be looked up using [List Financial Transactions](/docs/api/financial_platform/financial_transactions/list) by passing it as the `source_id` query parameter." }, "transaction_type": { "type": "string", "description": "The type of this transaction. Possible values:\n * `DC_CREDIT`: Increase of the program balance after a deposit.\n * `DC_DEBIT`: Decrease of the program balance after a withdrawal.\n * `LIQUIDITY_AUTH_CREDIT`: Increase of the program balance when a card authorization is released.\n * `LIQUIDITY_AUTH_DEBIT`: Decrease of the program balance to reserve funds for a card authorization.\n * `LIQUIDITY_FUNDING_CREDIT`: Increase of the program balance when a card transaction is refunded.\n * `LIQUIDITY_FUNDING_DEBIT`: Decrease of the program balance to fund a card capture.\n" } }, "description": "Program transaction." }, "GetProgramTransactions": { "type": "object", "properties": { "items": { "type": "array", "description": "Array of program transactions.", "items": { "$ref": "#/components/schemas/ProgramTransaction" } }, "page_after": { "type": "string", "description": "A marker for retrieving the next page of results. Include this value in the `page` request parameter to retrieve subsequent pages." }, "page_before": { "type": "string", "description": "A marker for retrieving the previous page of results. Include this value in the `page` request parameter to retrieve previous pages." } }, "description": "Response containing list of program transactions." }, "CreateScaleReportRes": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Airwallex-generated unique identifier for the report." } } }, "GetScaleReportRes": { "type": "object", "properties": { "download_url": { "type": "string", "description": "URL that can be used to retrieve the file. For security reasons, this URL expires 1 minute after it is generated. Only returned if the report status is `COMPLETED`." }, "download_url_expires_at": { "type": "string", "description": "Download URL expiry timestamp in ISO8601 standard (UTC). Only returned if the status is `COMPLETED`." }, "failed_reason": { "type": "string", "description": "Reason for the report generation failing. Only returned if the status is `FAILED`.", "enum": [ "REPORT_SIZE_LIMIT_EXCEEDED", "SYSTEM_FAILURE" ] }, "file_format": { "type": "string", "description": "File format of the report. Currently supported formats: `CSV`." }, "file_name": { "type": "string", "description": "File name of the report." }, "from_created_at": { "type": "string", "description": "Timestamp (inclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `created_at` field in the `TRANSACTION_RECON_REPORT`\n * `created_at` field in the `PAYOUT_REPORT`\n * `created_at` field in the `ISSUING_TRANSACTION_REPORT`\n * `created_at` field in the `APPLICATION_FEE_REPORT`\n * `created_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n * `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_created_at` = `2023-01-01` and `to_created_at` = `2023-01-02` to obtain records created during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_created_at` and `to_created_at` is 366 days." }, "from_updated_at": { "type": "string", "description": "Timestamp (inclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `last_update` field in the `TRANSACTION_RECON_REPORT`\n * `last_update` field in the `PAYOUT_REPORT`\n * `last_update` field in the `ISSUING_TRANSACTION_REPORT`\n * `last_update` field in the `APPLICATION_FEE_REPORT`\n * `updated_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n * `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_updated_at` = `2023-01-01` and `to_updated_at` = `2023-01-02` to obtain records last updated during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_updated_at` and `to_updated_at` is 366 days." }, "id": { "type": "string", "description": "Airwallex-generated unique identifier for the report." }, "status": { "type": "string", "description": "Status of the report availability for download.", "enum": [ "PENDING", "COMPLETED", "FAILED" ] }, "to_created_at": { "type": "string", "description": "Timestamp (exclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `created_at` field in the `TRANSACTION_RECON_REPORT`\n * `created_at` field in the `PAYOUT_REPORT`\n * `created_at` field in the `ISSUING_TRANSACTION_REPORT`\n * `created_at` field in the `APPLICATION_FEE_REPORT`\n * `created_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n * `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_created_at` = `2023-01-01` and `to_created_at` = `2023-01-02` to obtain records created during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_created_at` and `to_created_at` is 366 days." }, "to_updated_at": { "type": "string", "description": "Timestamp (exclusive, in ISO8601 standard, UTC) to specify data records that the report should include. This parameter is a filter for:\n * `last_update` field in the `TRANSACTION_RECON_REPORT`\n * `last_update` field in the `PAYOUT_REPORT`\n * `last_update` field in the `ISSUING_TRANSACTION_REPORT`\n * `last_update` field in the `APPLICATION_FEE_REPORT`\n * `updated_at` field in the `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`\n * `date` field in the `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`\n\nFor example, request a Platform report with `from_updated_at` = `2023-01-01` and `to_updated_at` = `2023-01-02` to obtain records last updated during the day `2023-01-01` in UTC.\n\nThe max interval size between `from_updated_at` and `to_updated_at` is 366 days." }, "type": { "type": "string", "description": "Type of report requested. Currently supported report types:\n * `TRANSACTION_RECON_REPORT`: All financial transactions having occurred on your Platform account and connected accounts.\n * `PAYOUT_REPORT`: Details of all payouts out of your Platform account and connected accounts, across all payout statuses.\n * `BALANCE_REPORT`: Balances of your Platform account and connected accounts.\n * `ACCOUNT_REPORT`: Account-related information for your Platform and connected accounts, including KYC & KYB information.\n * `ISSUING_TRANSACTION_REPORT`: All issuing transactions having occurred on your Platform account and connected accounts.\n * `APPLICATION_FEE_REPORT`: A consolidated list of application fees that a Platform account charges its connected accounts.\n * `PLATFORM_LIQUIDITY_TRANSACTION_REPORT`: Transactions across all Platform Liquidity Program accounts under your Platform account, including both program accounts and program subscriber accounts.\n * `PLATFORM_LIQUIDITY_EOD_BALANCE_REPORT`: End-of-day balances across all Platform Liquidity Program accounts under your Platform account, with one record per program, currency, and UTC calendar day." } } }, "MatchingPspSettlementRequired": { "type": "object", "properties": { "message": { "type": "string", "description": "Information about this requirement." } }, "description": "The amount of associated PSP settlement deposits does not match the amount of the PSP settlement intent." }, "PspSettlementIntentRequired": { "type": "object", "properties": { "message": { "type": "string", "description": "Information about this requirement." } }, "description": "Awaiting a PSP settlement intent." }, "ReferenceDisambiguationRequired": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } }, "description": "PSP settlement deposit reference corresponds to multiple PSP settlement intents. Please specify in the PSP settlement intents which PSP settlement deposits correspond to them." }, "SettlementDepositRequirements": { "type": "object", "properties": { "matching_psp_settlement_required": { "$ref": "#/components/schemas/MatchingPspSettlementRequired", "description": "The amount of associated PSP settlement deposits does not match the amount of the PSP settlement intent." }, "psp_settlement_intent_required": { "$ref": "#/components/schemas/PspSettlementIntentRequired", "description": "Awaiting a PSP settlement intent." }, "reference_disambiguation_required": { "$ref": "#/components/schemas/ReferenceDisambiguationRequired", "description": "PSP settlement deposit reference corresponds to multiple PSP settlement intents. Please specify in the PSP settlement intents which PSP settlement deposits correspond to them." } }, "description": "Further actions required in order to proceed with this PSP settlement deposit." }, "SettlementDeposit": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of the PSP settlement deposit." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) of the PSP settlement deposit." }, "deposit_id": { "type": "string", "description": "The unique identifier of the deposit associated with this PSP settlement deposit." }, "deposited_at": { "type": "string", "description": "The time this deposit was created." }, "global_account_id": { "type": "string", "description": "The unique identifier of the global account to which the funds were sent." }, "holding_account_id": { "type": "string", "description": "Holding account unique identifier into which the funds were deposited." }, "payer": { "$ref": "#/components/schemas/Embedded_Finance_Payer", "description": "The Payer provided along with the deposit." }, "psp_settlement_intent_id": { "type": "string", "description": "The unique identifier of the PSP settlement intent, if any, associated with this PSP settlement deposit." }, "reference": { "type": "string", "description": "Reference provided along with the deposit, which will be used to associate this PSP settlement deposit with PSP settlement splits." }, "requirements": { "$ref": "#/components/schemas/SettlementDepositRequirements", "description": "Further actions required in order to proceed with this PSP settlement deposit." }, "status": { "type": "string", "description": "Status of the PSP settlement deposit. One of: `NEW`, `ACTION_REQUIRED`, `MATCHED`, `SETTLED`." } } }, "SettlementIntentRequirements": { "type": "object", "properties": { "matching_psp_settlement_required": { "$ref": "#/components/schemas/MatchingPspSettlementRequired", "description": "Funds have been received that correspond to this PSP settlement intent, but the total amounts do not match." }, "reference_disambiguation_required": { "$ref": "#/components/schemas/ReferenceDisambiguationRequired", "description": "PSP settlement deposit reference corresponds to multiple PSP settlement intents." } }, "description": "Further actions required in order to proceed with this settlement intent." }, "SettlementIntent": { "type": "object", "properties": { "associate_by_deposit_ids": { "type": "array", "description": "Unique identifiers of the deposits that should be associated with this PSP settlement intent. If present, these will be used instead of the `settlement_reference` field to associate deposits with this intent.", "items": { "type": "string" } }, "associated_deposit_ids": { "type": "array", "description": "Unique identifiers of the deposits currently associated with this PSP settlement intent. If `associate_by_deposit_ids` is not empty, then these have been associated based on that list. Otherwise, they are associated by reference.", "items": { "type": "string" } }, "created_at": { "type": "string", "description": "The time this PSP settlement intent was created." }, "currency": { "type": "string", "description": "Currency (3-letter ISO-4217 code) specified in the request." }, "expected_settlement_date": { "type": "string", "description": "Expected date on which these funds will be deposited by the PSP into the global account, in `YYYY-MM-DD` format in the UTC timezone." }, "global_account_id": { "type": "string", "description": "The unique identifier of the global account in which this settlement will be deposited." }, "id": { "type": "string", "description": "Unique identifier for the PSP settlement intent." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to the PSP settlement intent.", "additionalProperties": { "type": "string" } }, "request_id": { "type": "string", "description": "Unique request identifier specified in the request." }, "requirements": { "$ref": "#/components/schemas/SettlementIntentRequirements", "description": "Further actions required in order to proceed with this settlement intent." }, "settlement_reference": { "type": "string", "description": "The reference value expected to be included by the PSP in its PSP settlement deposit." }, "status": { "type": "string", "description": "Status of the PSP settlement intent. One of: `NEW`, `SUBMITTED`, `ACTION_REQUIRED`, `MATCHED`, `SETTLED`." } } }, "SettlementSplit": { "type": "object", "properties": { "amount": { "type": "string", "description": "Amount of the transfer in `currency` specified in the request." }, "created_at": { "type": "string", "description": "The time this PSP settlement split was created." }, "id": { "type": "string", "description": "Unique identifier for the PSP settlement split." }, "settlement_type": { "type": "string", "description": "settlement type of the split, could be either `CREDIT` or `DEBIT`." }, "status": { "type": "string", "description": "Status of the PSP settlement split. One of: `NEW`, `MATCHED`, `CANCELLED`, `PENDING`,`FAILED`,`SETTLED`." }, "target_account_id": { "type": "string", "description": "Airwallex target account unique identifier specified in the request." } } }, "CreateIntentSplit": { "type": "object", "required": [ "psp_settlement_intent_id", "request_id" ], "properties": { "psp_settlement_intent_id": { "type": "string", "description": "PSP Settlement Intent unique identifier for which this PSP Settlement Split is a part. The value is returned by the API endpoint for creating or getting a PSP Settlement Intent." }, "request_id": { "type": "string", "description": "Unique request identifier. Max length 50 characters." } } }, "Embedded_Finance_Payer": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the payer." } }, "description": "The Payer provided along with the deposit." }, "Embedded_Finance_Address": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Address where the business operates and conducts its activities." }, "Embedded_Finance_NextAction": { "type": "object", "properties": { "type": { "type": "string", "description": "Code that describes what to do next when status is ACTION_REQUIRED.", "readOnly": true } }, "description": "Further information required in order to proceed with this account." }, "Embedded_Finance_AdditionalInfo": { "type": "object", "properties": { "card_payment_data": { "$ref": "#/components/schemas/CardPaymentData", "description": "Additional information about the card payment funding the connected account transfer." }, "merchant_data": { "$ref": "#/components/schemas/MerchantData", "description": "Structured merchant information for nested-flow transfers." } }, "description": "Additional information about the transaction." }, "Embedded_Finance_Offboarding": { "type": "object", "properties": { "comment": { "type": "string", "description": "Optional comment specified in the request." }, "created_at": { "type": "string", "format": "date-time", "description": "The time when this case was created." }, "id": { "type": "string", "format": "uuid", "description": "A unique ID of the offboarding case." }, "reason_code": { "type": "string", "description": "Reason for the offboarding specified in the request." }, "status": { "type": "string", "description": "Status of the offboarding case. One of: `PENDING`, `COMPLETED`, `CANCELLED`. While an offboarding is `PENDING`, the connected account status does not change. After the offboarding is `COMPLETED`, the account enters pending closure and the client API returns `SUSPENDED` on all API versions. After a 30-day grace period the account is permanently closed (`CLOSED` from API version `2026-08-21`; `SUSPENDED` on earlier versions)." }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when this case was last updated." } } }, "ExternalUserInfo": { "type": "object", "properties": { "email": { "type": "string", "description": "User email." }, "mobile": { "type": "string", "description": "User mobile." }, "type": { "type": "string", "description": "Type of the operator user." } }, "description": "Operator info of the user trigger the event." }, "ExternalSessionInfo": { "type": "object", "properties": { "application": { "type": "string", "description": "Web browser or Airwallex app, derived from User agent info." }, "ip_address": { "type": "string", "description": "Ip address." }, "location": { "type": "string", "description": "Location info derived from ip address." }, "operating_system": { "type": "string", "description": "Operating system info." }, "user_agent": { "type": "string", "description": "User agent info." } }, "description": "Session info of where and what device trigger the event." }, "AuditLog": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Account id." }, "event_details": { "type": "object", "description": "Optional. Detail infos related to the event, differ for different action types." }, "event_time": { "type": "string", "format": "date-time", "description": "Event timestamp, UTC timezone." }, "event_type": { "type": "string", "description": "Event type." }, "id": { "type": "string", "format": "uuid", "description": "An unique UUID id of the event." }, "operator_info": { "$ref": "#/components/schemas/ExternalUserInfo", "description": "Operator info of the user trigger the event." }, "session_info": { "$ref": "#/components/schemas/ExternalSessionInfo", "description": "Session info of where and what device trigger the event." } } }, "PagedSecurityAuditLog": { "type": "object", "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/AuditLog" } }, "page_after": { "type": "string", "description": "The page bookmark used for search the item after the result." }, "page_before": { "type": "string", "description": "The page bookmark used for search the item before the result." } } }, "SimulationPrimaryContact": { "type": "object", "properties": { "email": { "type": "string", "description": "A valid email address." }, "mobile": { "type": "string", "description": "A valid mobile phone number." } }, "description": "Contact information for the primary contact of the Airwallex specified account." }, "SimulationEstimatedTransactionVolume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } }, "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex." }, "SimulationFinancialStatement": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } }, "SimulationPaymentDistribution": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "BANK_DIRECT_DEBIT", "CARDS", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } }, "SimulationStoreAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Physical address of the store." }, "SimulationStorePhoto": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } }, "SimulationStoreWebsite": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } }, "SimulationStoreDetails": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "$ref": "#/components/schemas/SimulationEstimatedTransactionVolume", "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex." }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "$ref": "#/components/schemas/SimulationFinancialStatement" } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON", "ONLINE_CHECKOUT" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "$ref": "#/components/schemas/SimulationPaymentDistribution" } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "$ref": "#/components/schemas/SimulationStoreAddress", "description": "Physical address of the store." }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "$ref": "#/components/schemas/SimulationStorePhoto" } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "$ref": "#/components/schemas/SimulationStoreWebsite" } } }, "description": "Relevant information associated with the store you are applying payment solutions for." }, "SimulationAmendment": { "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier of the amendment." }, "primary_contact": { "$ref": "#/components/schemas/SimulationPrimaryContact", "description": "Contact information for the primary contact of the Airwallex specified account." }, "status": { "type": "string", "description": "Status of the amendment. One of `PENDING`, `APPROVED`, `REJECTED`." }, "store_details": { "$ref": "#/components/schemas/SimulationStoreDetails", "description": "Relevant information associated with the store you are applying payment solutions for." }, "target": { "type": "string", "description": "Target of the amendment.", "enum": [ "account_details.store_details", "primary_contact" ] } } }, "SimulationAdditionalAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the additional file.", "enum": [ "DRIVERS_LICENSE_BACK", "DRIVERS_LICENSE_FRONT", "MEDICARE_CARD", "OTHER", "PASSPORT", "PERSONAL_ID_BACK", "PERSONAL_ID_FRONT" ] } } }, "SimulationSupplementaryMaterials": { "type": "object", "properties": { "additional_files": { "type": "array", "description": "Additional files.", "items": { "$ref": "#/components/schemas/SimulationAdditionalAttachment" } } }, "description": "Supplementary Materials." }, "SimulationRevenueVolume": { "type": "object", "properties": { "amount": { "type": "string", "description": "The approximate amount of revenue a business generates in a month." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } }, "description": "The approximate amount of revenue a business generates in a month." }, "SimulationBusinessAccountUsage": { "type": "object", "properties": { "estimated_monthly_revenue": { "$ref": "#/components/schemas/SimulationRevenueVolume", "description": "The approximate amount of revenue a business generates in a month." }, "product_reference": { "type": "array", "description": "Intended product usage. \n`ACCEPT_ONLINE_PAYMENTS`,`COLLECT_MARKETPLACE_PROCEEDS`, \n`RECEIVE_TRANSFERS`,`GET_PAID`,`CONVERT_FUNDS`, \n`MAKE_TRANSFERS`,`CREATE_CARDS`,`MANAGE_EXPENSES`, \n`USE_AWX_API`,`TRANSFER_CNY_INBOUND`.", "items": { "type": "string" } } }, "description": "The intended purpose of the account, such as product usage and monthly turnover." }, "SimulationBusinessAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the business file.", "enum": [ "ACRA_COMPANY_PROFILE_DOCUMENT", "ANNUAL_REPORT", "ANNUAL_RETURN", "ARTICLES_OF_ASSOCIATION", "ASIC_CURRENT_COMPANY_EXTRACT", "ASSUMED_NAME_CERTIFICATE", "AUTHORIZED_SIGNATORY_DISCLOSURE", "BUSINESS_LICENSE", "CERTIFICATE_OF_INCORPORATION", "CERTIFICATION_REGISTRATION", "COMPANY_CERTIFICATE", "COMPANY_CONSTITUTION", "COMPANY_PROFILE", "CONFIRMATION_STATEMENT", "DIRECTOR_LIST", "LEGAL_NAME_AND_ADDRESS", "OPERATING_AGREEMENT", "PARTNERSHIP_AGREEMENT", "REGISTRATION_CERTIFICATE", "SHAREHOLDING_STRUCTURE_CHART", "SUPPORTIVE_OTHER", "THIRD_PARTY_SHAREHOLDING_DOCUMENT", "TRUST_DEED", "UBO_SUPPORTIVE", "UNIT_HOLDER_REGISTER" ] } } }, "SimulationBusinessDocumentation": { "type": "object", "properties": { "business_documents": { "type": "array", "description": "All business documents, such as incorporation certificates, ownershipship structure, and other relevant documentation.", "items": { "$ref": "#/components/schemas/SimulationBusinessAttachment" } } }, "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "SimulationAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Address where the business operates and conducts its activities." }, "SimulationBusinessIdentifier": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Local business registration number i.e. an official signal of identification for the business." }, "type": { "type": "string", "description": "Type of business registration number, depending on what's applicable to the country the business is registered in.", "enum": [ "BRN", "EIN", "SSN", "VAT" ], "x-enumDescriptions": { "BRN": "Business Registration Number", "EIN": "Employer Identification Number", "SSN": "Social Security Number", "VAT": "Value Added Tax Number" } } } }, "SimulationBusinessDetails": { "type": "object", "properties": { "account_usage": { "$ref": "#/components/schemas/SimulationBusinessAccountUsage", "description": "The intended purpose of the account, such as product usage and monthly turnover." }, "as_trustee": { "type": "boolean", "description": "Whether this account is set up as a trustee on behalf of a trust." }, "attachments": { "$ref": "#/components/schemas/SimulationBusinessDocumentation", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "business_address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business operates and conducts its activities." }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/SimulationBusinessIdentifier" } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_name_trading": { "type": "string", "description": "Also known as a \"doing business as\" (DBA) name, refers to a name under which the business operates and conducts its activities, which may differ from its legal name." }, "business_start_date": { "type": "string", "description": "The date on which the business officially begins its operations in YYYY-MM-DD format." }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "CORPORATION", "GENERAL_PARTNERSHIP", "LIMITED_LIABILITY_COMPANY", "LIMITED_LIABILITY_PARTNERSHIP", "LIMITED_PARTNERSHIP", "NON_REGISTERED_SOLE_PROPRIETOR", "OTHER", "PARTNERSHIP", "SELF_MANAGED_SUPER_FUND", "SOLE_PROPRIETOR", "TRUST" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "exports_goods_or_services": { "type": "boolean", "description": "Indicate whether the business engages in the export of goods and/or services." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_nominee_shareholders": { "type": "boolean", "description": "Indicate whether any of the individuals hold their shares on behalf of a third party." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "has_ringgit_borrowing": { "type": "boolean", "description": "Indicate whether the business engages in domestic Ringgit borrowing." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "no_shareholders_with_over_25percent": { "type": "boolean", "description": "Attestation of ownership structure without shareholders holding above 25% shares." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered." }, "registration_address_english": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "state_of_incorporation": { "type": "string", "description": "The state where the business incorporated, different from registration state. (2-letter ISO 3166-2 state code)." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } }, "description": "Business details including the type of business, primary place of business and industry type." }, "SimulationBusinessPersonAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the personal document.", "enum": [ "APPLICANT_SIGNATURE", "PERSON_NAME_CHANGE_CERTIFICATE", "PERSON_PURPORTING_TO_ACT_AUTHORISATION_LETTER", "PROOF_OF_ADDRESS", "SUPPORTIVE_OTHER" ] } } }, "SimulationBusinessPersonDocumentation": { "type": "object", "properties": { "business_person_documents": { "type": "array", "description": "All personal documents, such as PPTA letter, change or name certificate, or other supporting documents.", "items": { "$ref": "#/components/schemas/SimulationBusinessPersonAttachment" } } }, "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.)." }, "SimulationDriverLicence": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state where the license is issued. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } }, "description": "Driver's license." }, "SimulationPassport": { "type": "object", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } }, "description": "Passport." }, "SimulationPersonalId": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } }, "description": "Other government-issued unique identifier card." }, "SimulationBusinessPersonTaxId": { "type": "object", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Tax unique identifier type.", "enum": [ "ITIN", "OTHERS", "SSN", "VAT" ] } }, "description": "Tax unique identifier." }, "SimulationBusinessIdentification": { "type": "object", "properties": { "drivers_license": { "$ref": "#/components/schemas/SimulationDriverLicence", "description": "Driver's license." }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENCE", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country where the license is issued. (2-letter ISO 3166-2 country code)." }, "passport": { "$ref": "#/components/schemas/SimulationPassport", "description": "Passport." }, "personal_id": { "$ref": "#/components/schemas/SimulationPersonalId", "description": "Other government-issued unique identifier card." }, "tax_id": { "$ref": "#/components/schemas/SimulationBusinessPersonTaxId", "description": "Tax unique identifier." } }, "description": "Details of the primary identification." }, "SimulationBusinessIdentifications": { "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/SimulationBusinessIdentification", "description": "Details of the primary identification." }, "secondary": { "$ref": "#/components/schemas/SimulationBusinessIdentification", "description": "Details of the secondary identity verification." } }, "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "SimulationBusinessPersonDetail": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/SimulationBusinessPersonDocumentation", "description": "Reference to uploaded business person document. (For file upload instructions, refer to 'File Service API'.)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the business person in YYYY-MM-DD format." }, "email": { "type": "string", "description": "Email of the business person." }, "first_name": { "type": "string", "description": "First name of the business person." }, "first_name_english": { "type": "string", "description": "First name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identifications": { "$ref": "#/components/schemas/SimulationBusinessIdentifications", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "job_title": { "type": "string", "description": "Job title of the business person within the business." }, "last_name": { "type": "string", "description": "Last name of the business person." }, "last_name_english": { "type": "string", "description": "Last name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the business person." }, "middle_name_english": { "type": "string", "description": "Middle name of the business person (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the business person. (2-letter ISO 3166-2 country code)." }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "A valid phone number for the business person." }, "residential_address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered." }, "roles": { "type": "array", "description": "Roles of the business person. Any of `AUTHORISED_PERSON`, `BENEFICIAL_OWNER`, `CONTROLLING_PERSON`, `DIRECTOR`, `LEGAL_REPRESENTATIVE`, `SIGNATORY`. The order is not guaranteed in response.", "uniqueItems": true, "items": { "type": "string", "enum": [ "AUTHORISED_PERSON", "BENEFICIAL_OWNER", "CONTROLLING_PERSON", "DIRECTOR", "LEGAL_REPRESENTATIVE", "SIGNATORY" ] } } } }, "SimulationTransactionVolume": { "type": "object", "properties": { "amount": { "type": "string", "description": "Estimate of the expected amount of money to be collected or paid out each month, in US dollars." }, "currency": { "type": "string", "description": "Currency of the revenue. (3-letter ISO 4217 currency code)." } }, "description": "Estimate of expected monthly transaction volume." }, "SimulationIndividualAccountUsage": { "type": "object", "properties": { "card_usage": { "type": "array", "description": "Ways in which the account will use Airwallex borderless cards. \n`GENERAL_EXPENSES`, `BUSINESS_EXPENSES`, `EDUCATION`, \n`TRAVEL_TRANSPORT`, `INSURANCE`, `SERVICES`, \n`BILLS_UTILITIES`, `INVESTMENT`, `FEES_CHARGES`, \n`HEALTHCARE`, `HOUSING`, `NO_CARD_USAGE`.", "items": { "type": "string" } }, "collection_country_codes": { "type": "array", "description": "Countries from which the account will be collecting funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "collection_from": { "type": "array", "description": "Sources and counterparties from which the account will be collecting funds. \n`ALLOWANCE_FROM_FAMILY`, `BENEFITS_FROM_STATE`, `EMPLOYMENT_INCOME`, \n`INVESTMENT_INCOME_NONPROPERTY`, `INCOME_FROM_PROPERTY`, \n`INCOME_FROM_MARKETPLLACES`, \n`INSURANCE`, `LOANS`, `SAVINGS`, `OTHER_THIRD_PARTIES`, \n`PAYMENT_REFUNDS`.", "items": { "type": "string" } }, "expected_monthly_transaction_volume": { "$ref": "#/components/schemas/SimulationTransactionVolume", "description": "Estimate of expected monthly transaction volume." }, "payout_country_codes": { "type": "array", "description": "Countries to which the account will be paying funds. (2-letter ISO 3166-2 country code).", "items": { "type": "string" } }, "payout_to": { "type": "array", "description": "Beneficiaries and counterparties to which the account will be paying funds. \n`CONNECTED_AWX_ACCOUNT`, `EDUCATIONAL_INSTITUTIONS`, `FRIENDS_OR_RELATIVES`, \n`MARKETPLACE_PLATFORM`, `MARKETPLACE_SELLERS`, `MOBILITY_PLATFORM`, \n`OTHER_THIRD_PARTY_INDIVIDUALS`, `OWN_BANK_ACCOUNT`.", "items": { "type": "string" } }, "product_reference": { "type": "array", "description": "Intended product usage. \n`CREATE_CARDS`, `MAKE_TRANSFERS`, `MARKETPLACE_WALLET`, \n`MOBILITY_WALLET`, `OTHERS`, `PAYROLL_WALLET`, \n`RECEIVE_TRANSFERS`, `TRADE_SECURITIES`, `TUITION_PAYMENTS`.", "items": { "type": "string" } } }, "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume." }, "SimulationIndividualAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "PERSON_NAME_CHANGE_CERTIFICATE", "PROOF_OF_ADDRESS", "SUPPORTIVE_OTHER" ] } } }, "SimulationIndividualDocuments": { "type": "object", "properties": { "individual_documents": { "type": "array", "description": "Identity files for individual accounts.", "items": { "$ref": "#/components/schemas/SimulationIndividualAttachment" } } }, "description": "Reference to uploaded identification document." }, "SimulationEmployer": { "type": "object", "properties": { "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/SimulationBusinessIdentifier" } }, "business_name": { "type": "string", "description": "Name of the employer." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with the individual's employer. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." } }, "description": "Information of the individual's employer." }, "SimulationEstimatedMonthlyIncome": { "type": "object", "properties": { "amount": { "type": "string", "description": "Estimate of monthly income." }, "currency": { "type": "string", "description": "Currency of the income. (3-letter ISO 4217 currency code)." } }, "description": "Estimate of monthly income." }, "SimulationIndividualDriverLicence": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "gender": { "type": "string", "description": "Gender listed on document." }, "issuing_state": { "type": "string", "description": "Name of state issuing the license. Only applicable if relevant to selected country." }, "number": { "type": "string", "description": "Driver's license number." }, "version": { "type": "string", "description": "Version listed on the document. Only applicable if relevant to selected country." } }, "description": "Driver's license." }, "SimulationIndividualMedicareCard": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "card_number": { "type": "string", "description": "Medicare card number." }, "color": { "type": "string", "description": "Card color.", "enum": [ "BLUE", "GREEN", "YELLOW" ] }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "reference_number": { "type": "string", "description": "Reference number listed on the document." } }, "description": "Medicare card." }, "SimulationIndividualPassport": { "type": "object", "properties": { "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "mrz_line1": { "type": "string", "description": "First line of passport MRZ (machine-readable zone)." }, "mrz_line2": { "type": "string", "description": "Second line of passport MRZ (machine-readable zone)." }, "number": { "type": "string", "description": "Passport number." } }, "description": "Passport." }, "SimulationIndividualPersonalId": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "effective_at": { "type": "string", "format": "date", "description": "Document effective as of this date in YYYY-MM-DD format." }, "expire_at": { "type": "string", "format": "date", "description": "Document expiry date in YYYY-MM-DD format." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "number": { "type": "string", "description": "Document unique identifier number." } }, "description": "Personal unique identifier." }, "SimulationIndividualTaxId": { "type": "object", "properties": { "number": { "type": "string", "description": "Tax unique identifier number." }, "type": { "type": "string", "description": "Type of Tax unique identifier commonly used in the selected country.", "enum": [ "ITIN", "SSN" ] } }, "description": "Tax unique identifier." }, "SimulationIndividualIdDocumentation": { "type": "object", "properties": { "drivers_license": { "$ref": "#/components/schemas/SimulationIndividualDriverLicence", "description": "Driver's license." }, "identification_type": { "type": "string", "description": "Type of identification.", "enum": [ "DRIVERS_LICENSE", "MEDICARE_CARD", "PASSPORT", "PERSONAL_ID", "TAX_ID" ] }, "issuing_country_code": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "medicare_card": { "$ref": "#/components/schemas/SimulationIndividualMedicareCard", "description": "Medicare card." }, "passport": { "$ref": "#/components/schemas/SimulationIndividualPassport", "description": "Passport." }, "personal_id": { "$ref": "#/components/schemas/SimulationIndividualPersonalId", "description": "Personal unique identifier." }, "tax_id": { "$ref": "#/components/schemas/SimulationIndividualTaxId", "description": "Tax unique identifier." } } }, "SimulationIndividualIdentifications": { "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/SimulationIndividualIdDocumentation" }, "secondary": { "$ref": "#/components/schemas/SimulationIndividualIdDocumentation" } }, "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "SimulationOtherName": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name (given name) of the individual person if different." }, "last_name": { "type": "string", "description": "Last name (family name) of the individual person if different." }, "middle_name": { "type": "string", "description": "Middle name of the individual person if different." } } }, "SimulationIndividualDetails": { "type": "object", "properties": { "account_usage": { "$ref": "#/components/schemas/SimulationIndividualAccountUsage", "description": "Information on how the account will be used, such as sending/receiving countries and monthly volume." }, "attachments": { "$ref": "#/components/schemas/SimulationIndividualDocuments", "description": "Reference to uploaded identification document." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the account user in YYYY-MM-DD format." }, "employer": { "$ref": "#/components/schemas/SimulationEmployer", "description": "Information of the individual's employer." }, "estimated_monthly_income": { "$ref": "#/components/schemas/SimulationEstimatedMonthlyIncome", "description": "Estimate of monthly income." }, "first_name": { "type": "string", "description": "First name of the account user." }, "first_name_english": { "type": "string", "description": "First name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "has_member_holding_public_office": { "type": "boolean", "description": "Indicate whether the customer, close family member, or business partner holds public office." }, "has_prior_financial_institution_refusal": { "type": "boolean", "description": "Indicate whether the customer has been refused service from a financial institution due to ML/TF concerns." }, "identifications": { "$ref": "#/components/schemas/SimulationIndividualIdentifications", "description": "Details of the business person for identity verification, such as a passport, driver's license, or other government-issued unique identifier card." }, "last_name": { "type": "string", "description": "Last name of the account user." }, "last_name_english": { "type": "string", "description": "Last name of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "live_selfie_file_id": { "type": "string", "description": "File id for live-photo of the individual." }, "middle_name": { "type": "string", "description": "Middle name of the account user." }, "middle_name_english": { "type": "string", "description": "Middle name of the account user. (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the first name, middle name or last name fields include non-ASCII characters." }, "nationality": { "type": "string", "description": "Nationality of the account user. (2-letter ISO 3166-2 country code)." }, "occupation": { "type": "string", "description": "Occupation of the individual person.", "enum": [ "ACCOUNTANT", "ADMINISTRATION", "ARCHITECTURE", "ARTIST", "ATHLETE", "BEAUTY", "BUSINESSMAN", "CONSTRUCTION", "COOK", "DELIVERY", "DESIGNER", "ENGINEER", "FINANCE", "GOVERNMENT", "HEALTHCARE", "INSURANCE", "JOURNALIST", "LEGAL", "MANAGER", "MARKETING", "MEDIA", "MILITARY", "NURSE", "OFFICER", "OTHERS", "PILOT", "PRODUCTION", "PROGRAMMER", "REAL_ESTATE", "SALESPERSON", "SELF_EMPLOYMENT", "STUDENT", "SURVEYOR", "TEACHER", "TECHNICIAN", "TRAVEL", "UNEMPLOYED", "WAITER" ] }, "other_names": { "type": "array", "description": "Alias or other names of the individual person if different.", "items": { "$ref": "#/components/schemas/SimulationOtherName" } }, "person_id": { "type": "string", "description": "Unique Id of this person. This field is only available when the account has passed KYC.", "readOnly": true }, "phone_number": { "type": "string", "description": "Phone number of the account user, used for identity verification." }, "photo_holding_identification_file_id": { "type": "string", "description": "File id of a photo of the individual holding their identification. Applicable only if specifically requested by Airwallex." }, "residential_address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address of the account user." }, "residential_address_english": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address of the account user (in ASCII characters only, e.g. romanization of non-Latin characters) Required if the address field includes non-ASCII characters." } }, "description": "Individual details including name, address, face photo, and documents." }, "SimulationStoreDetails-2": { "type": "object", "required": [ "cross_border_transaction_percent", "estimated_transaction_volume", "fulfillment_days", "industry_code", "operating_models", "store_description", "store_name" ], "description": "Relevant information associated with the store you are applying payment solutions for.", "properties": { "cross_border_transaction_percent": { "type": "string", "description": "Percentage of products or services provided to international customers residing outside of where your business's registered." }, "dispute_percent": { "type": "string", "description": "Average dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months." }, "employee_size": { "type": "integer", "format": "int32", "description": "Total number of staff in all stores." }, "estimated_transaction_volume": { "type": "object", "required": [ "average_amount_per_transaction", "currency", "max_amount_per_transaction", "monthly_transaction_amount" ], "description": "Your store's anticipated volume of transactions in the next 12 months with Airwallex.", "properties": { "average_amount_per_transaction": { "type": "string", "description": "The average transaction size of your store." }, "currency": { "type": "string", "description": "Currency of the transaction volume. (3-letter ISO 4217 currency code)." }, "max_amount_per_transaction": { "type": "string", "description": "The maximum transaction size of your store." }, "monthly_transaction_amount": { "type": "string", "description": "The average monthly volume of your store." } } }, "financial_statements": { "type": "array", "description": "Additional documents about your store's financials.", "items": { "type": "object", "properties": { "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." } } } }, "fulfillment_days": { "type": "integer", "format": "int32", "description": "Number of days your customers will typically need to wait to receive their goods or services after paying for their orders." }, "industry_code": { "type": "string", "description": "The code of the industry category most aligned with your store. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "mcc": { "type": "string", "description": "Current or desired MCC for your store." }, "operating_models": { "type": "array", "description": "The model of which our customers pay for their orders. Refer to https://www.airwallex.com/docs/payments/about-airwallex-payments/choose-your-payments-solution#what-is-your-payments-use-case \nOne or more of `ONLINE_CHECKOUT`, `INVOICES_OR_CUSTOM_ORDER_LINKS`, `IN_PERSON`.", "items": { "type": "string", "enum": [ "ONLINE_CHECKOUT", "INVOICES_OR_CUSTOM_ORDER_LINKS", "IN_PERSON" ] } }, "payment_distribution": { "type": "array", "description": "Anticipated transaction volume split by payment methods.", "items": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "Type of payment methods.", "enum": [ "CARDS", "BANK_DIRECT_DEBIT", "OTHER" ] }, "percentage": { "type": "string", "description": "Percentage of anticipated transaction volume." } } } }, "refund_percent": { "type": "string", "description": "Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months." }, "selling_to_country_codes": { "type": "array", "description": "List of country codes where products are sold.", "items": { "type": "string" } }, "shipping_from_country_codes": { "type": "array", "description": "List of country codes from which goods are shipped.", "items": { "type": "string" } }, "store_address": { "type": "object", "description": "Physical address of the store.", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } } }, "store_description": { "type": "string", "description": "Free text description of your store's goods or services offerings. Max length is 500 characters." }, "store_name": { "type": "string", "description": "The trading name your store is operating as. This name will also appear on the receipts to your customers." }, "store_photos": { "type": "array", "description": "Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed.", "items": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "All relevant store photos, if more than 1 physical store, provide one photo of each." } } } }, "store_websites": { "type": "array", "description": "All websites associated with the store you are applying payment solutions for. They must be in the same industry selling the same or similar goods and services, otherwise you will need to submit another application as a different store.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites." } } } } } }, "SimulationTrusteeBusiness": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/SimulationBusinessDocumentation", "description": "Reference to uploaded files of business documentation. (For file upload instructions, refer to 'File Service API'.)." }, "business_identifiers": { "type": "array", "description": "Local business registration number i.e. an official signal of identification for the business.", "items": { "$ref": "#/components/schemas/SimulationBusinessIdentifier" } }, "business_name": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority.." }, "business_name_english": { "type": "string", "description": "The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business.", "items": { "$ref": "#/components/schemas/SimulationBusinessPersonDetail" } }, "business_structure": { "type": "string", "description": "Type of business structure.", "enum": [ "COMPANY", "PARTNERSHIP", "SOLE_PROPRIETOR" ] }, "contact_number": { "type": "string", "description": "Primary business phone number." }, "description_of_goods_or_services": { "type": "string", "description": "Free text description of goods or services. Max length is 500 characters." }, "explanation_for_high_risk_countries_exposure": { "type": "string", "description": "Free text description of business activities conducted in high-risk countries if any. Max length is 500 characters." }, "industry_category_code": { "type": "string", "description": "The code of the industry category most aligned with your business. Please navigate to the 'Supporting Services' > 'Reference Data' > 'Industry categories' section for an endpoint to pull a tree of categories." }, "operating_country": { "type": "array", "description": "The countries in which the business conducts its operations, such as selling products or services, or providing support to customers. Multiple country codes (2-letter ISO 3166-2 country code) may be provided.", "items": { "type": "string" } }, "registration_address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered." }, "registration_address_english": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered. (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "url": { "type": "string", "description": "Websites associated with the business, such as its official website, social media pages, or other online profiles." } }, "description": "Business details including the type of business, primary place of business, and industry type." }, "SimulationIdentityAttachment": { "type": "object", "properties": { "description": { "type": "string", "description": "Optional field for any additional notes or text description for the file." }, "file_id": { "type": "string", "description": "Unique identifier of file as provided in the response from the File Service API." }, "tag": { "type": "string", "description": "Tag of the identity file.", "enum": [ "DRIVERS_LICENSE_BACK", "DRIVERS_LICENSE_FRONT", "PASSPORT", "PERSONAL_ID_BACK", "PERSONAL_ID_FRONT" ] } } }, "SimulationIdentityInfo": { "type": "object", "properties": { "identity_files": { "type": "array", "description": "Identity files.", "items": { "$ref": "#/components/schemas/SimulationIdentityAttachment" } } }, "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.)." }, "SimulationTrusteeIndividual": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/SimulationAddress", "description": "Address where the business is registered." }, "attachments": { "$ref": "#/components/schemas/SimulationIdentityInfo", "description": "Reference to uploaded identification document. (For file upload instructions, refer to 'File Service API'.)." }, "date_of_birth": { "type": "string", "format": "date", "description": "Birth date of the trustee in YYYY-MM-DD format." }, "first_name": { "type": "string", "description": "First name of the trustee." }, "first_name_english": { "type": "string", "description": "First name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "identification_drivers_license_version": { "type": "string", "description": "Driver's license card number (not driver's license number) the trustee can provide." }, "identification_number": { "type": "string", "description": "Identification number the trustee can provide." }, "identification_type": { "type": "string", "description": "Identification type the trustee can provide." }, "last_name": { "type": "string", "description": "Last name of the trustee." }, "last_name_english": { "type": "string", "description": "Last name of the trustee (in ASCII characters only, e.g. romanization of non-Latin characters)." }, "nationality": { "type": "string", "description": "Nationality of the trustee. (2-letter ISO 3166-2 country code)." } } }, "SimulationTrusteeDetails": { "type": "object", "properties": { "business_details": { "$ref": "#/components/schemas/SimulationTrusteeBusiness", "description": "Business details including the type of business, primary place of business, and industry type." }, "individual_details": { "type": "array", "description": "Individual details including name, including name, address, face photo, and documents.", "items": { "$ref": "#/components/schemas/SimulationTrusteeIndividual" } }, "legal_entity_type": { "type": "string", "description": "Type of trustee. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] } }, "description": "Details identifying the trustee of the business." }, "SimulationAccountDetails": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/SimulationSupplementaryMaterials", "description": "Supplementary Materials." }, "business_details": { "$ref": "#/components/schemas/SimulationBusinessDetails", "description": "Business details including the type of business, primary place of business and industry type." }, "business_person_details": { "type": "array", "description": "Details identifying the related persons of the business.", "items": { "$ref": "#/components/schemas/SimulationBusinessPersonDetail" } }, "individual_details": { "$ref": "#/components/schemas/SimulationIndividualDetails", "description": "Individual details including name, address, face photo, and documents." }, "legal_entity_id": { "type": "string", "description": "Legal Entity unique identifier of the account." }, "legal_entity_type": { "type": "string", "description": "Type of account. Defaults to `BUSINESS`.", "enum": [ "BUSINESS", "INDIVIDUAL" ] }, "store_details": { "$ref": "#/components/schemas/SimulationStoreDetails-2", "description": "Relevant information associated with the store you are applying payment solutions for." }, "trustee_details": { "$ref": "#/components/schemas/SimulationTrusteeDetails", "description": "Details identifying the trustee of the business." } }, "description": "Relevant information associated with Airwallex account specified in the request." }, "SimulationDeviceData": { "type": "object", "properties": { "ip_address": { "type": "string", "description": "The IP address from which the account representative accepted their service agreement." }, "user_agent": { "type": "string", "description": "The user agent of the browser from which the account representative accepted their service agreement." } }, "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis." }, "SimulationTermsAndConditions": { "type": "object", "properties": { "agreed_at": { "type": "string", "description": "The timestamp marking when the account representative agreed to their service agreement in ISO 8601 format." }, "device_data": { "$ref": "#/components/schemas/SimulationDeviceData", "description": "Client device information applicable when agreement is accepted. It is recommended to provide this data for risk analysis." }, "service_agreement_type": { "type": "string", "description": "The user’s service type of their agreement. Default to FULL.", "enum": [ "FULL", "RECIPIENT" ], "x-enumDescriptions": { "FULL": "[FULL service agreement](https://www.airwallex.com/terms/scale-user-terms-global) creates a service relationship between Airwallex and the account holder.", "RECIPIENT": "[RECIPIENT service agreement](https://www.airwallex.com/terms/recipient-agreement-global) clarifies that there is no service relationship between Airwallex and the recipient, and that the recipient’s relationship is with the platform. This service agreement type is required for creating [Ledger Account](/docs/payments-for-platforms/use-cases/payments-for-marketplaces)." } } }, "description": "Terms and conditions between Airwallex and the account holder." }, "SimulationCustomerAgreements": { "type": "object", "properties": { "agreed_to_biometrics_consent": { "type": "boolean", "description": "Consent to Airwallex collecting and processing the biometrics data (applicable if liveness check is conducted)." }, "agreed_to_data_usage": { "type": "boolean", "description": "Consent to Airwallex using the provided data, including consent for Airwallex to verify the identity of relevant individuals with Airwallex service providers and database owners in accordance with the Identity Verification Terms." }, "agreed_to_terms_and_conditions": { "type": "boolean", "description": "Agreement to abide by the Airwallex terms and conditions." }, "opt_in_for_marketing": { "type": "boolean", "description": "Agreement to receive email from Airwallex on news, promotions, etc." }, "terms_and_conditions": { "$ref": "#/components/schemas/SimulationTermsAndConditions", "description": "Terms and conditions between Airwallex and the account holder." } }, "description": "Agreements collected from the user, such as acceptance of terms and conditions, or opt in for marketing." }, "SimulationNextAction": { "type": "object", "properties": { "type": { "type": "string", "description": "Code that describes what to do next when status is ACTION_REQUIRED.", "readOnly": true } }, "description": "Further information required in order to proceed with this account." }, "SimulationReactivateDetail": { "type": "object", "properties": { "message": { "type": "string" }, "reactivated_at": { "type": "string" } }, "description": "The reactivate details for ACTIVE account with reactivation history." }, "SimulationAgreementToTermsAndConditionsRequired": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Call this endpoint to agree to terms and conditions.", "readOnly": true }, "message": { "type": "string", "description": "Message describing what needs to be done to agree to terms and conditions.", "readOnly": true }, "method": { "type": "string", "description": "Call the endpoint with this http method to agree to terms and conditions.", "readOnly": true } }, "description": "Agreement to terms and conditions required, only if account is submitted without having agreed." }, "SimulationOtherRequirement": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "OTHER" ] }, "message": { "type": "string", "description": "Information on requirement.", "readOnly": true } } }, "SimulationPhotoFileRequirement": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "FACE_CLOSE_TO_BORDER", "FACE_CROPPED", "FACE_IS_BLOCKED", "FACE_NOT_FOUND", "FACE_OVER_ROTATED", "FACE_TOO_CLOSE", "FACE_TOO_SMALL", "FAILED_TO_PROCESS_IMAGE", "LIVENESS_CHECK_FAILED", "OTHER", "TOO_MANY_FACES", "UNKNOWN" ] }, "message": { "type": "string", "description": "Information on requirement for Photo File.", "readOnly": true }, "photo_file_id": { "type": "string", "description": "Photo file as provided in the response from the File Service API.", "readOnly": true } }, "description": "File id of the photo file, only required if facial liveness check failed." }, "SimulationPhotoHoldingIdRequired": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "FACE_MATCHING_FAILED" ] }, "front_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "message": { "type": "string", "description": "Information on requirement for photo of person holding their id.", "readOnly": true }, "photo_file_id": { "type": "string", "description": "Photo file as provided in the response from the File Service API.", "readOnly": true } } }, "SimulationIdRequirement": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "ADDRESS_NOT_FOUND", "BLURRY_IMAGE", "DATA_COMPARISON_TOO_LOW", "DOCUMENT_TYPE_FAILED", "DOCUMENT_VALIDATION_FAILED", "EXPIRED_DOCUMENT", "FACE_MATCHING_FAILED", "FAILED_TO_PROCESS", "GLARE_IMAGE", "OTHER" ] }, "first_name": { "type": "string", "description": "First name of person requiring identification.", "readOnly": true }, "front_file_id": { "type": "string", "description": "File id of identification file.", "readOnly": true }, "last_name": { "type": "string", "description": "Last name of person requiring identification.", "readOnly": true }, "message": { "type": "string", "description": "Information on requirement for identification.", "readOnly": true }, "middle_name": { "type": "string", "description": "Middle name of person requiring identification.", "readOnly": true } } }, "SimulationReasonForDuplicateAccountRequired": { "type": "object", "properties": { "error_code": { "type": "string", "description": "Error code for what caused this requirement.", "readOnly": true, "enum": [ "CONFIRM_REASON_FOR_SECOND_ACCOUNT", "OTHER" ] }, "message": { "type": "string", "description": "Information on requirement when the account appears to be a duplicate.", "readOnly": true } } }, "SimulationAccountRequirement": { "type": "object", "properties": { "agreement_to_terms_and_conditions_required": { "$ref": "#/components/schemas/SimulationAgreementToTermsAndConditionsRequired", "description": "Agreement to terms and conditions required, only if account is submitted without having agreed." }, "other": { "type": "array", "description": "Any other requirements.", "items": { "$ref": "#/components/schemas/SimulationOtherRequirement" } }, "photo_file_id_required": { "$ref": "#/components/schemas/SimulationPhotoFileRequirement", "description": "File id of the photo file, only required if facial liveness check failed." }, "photo_holding_id_required": { "type": "array", "description": "Photo of user holding their id, only required if document face matching failed.", "items": { "$ref": "#/components/schemas/SimulationPhotoHoldingIdRequired" } }, "primary_identification_required": { "type": "array", "description": "The primary form of identification, only required if document verification failed.", "items": { "$ref": "#/components/schemas/SimulationIdRequirement" } }, "reason_for_duplicate_account_required": { "type": "array", "description": "An explanation for why you are creating a second account, only required if one already exists.", "items": { "$ref": "#/components/schemas/SimulationReasonForDuplicateAccountRequired" } }, "secondary_identification_required": { "type": "array", "description": "A secondary form of identification, only required if otherwise provided identification is insufficient to proceed.", "items": { "$ref": "#/components/schemas/SimulationIdRequirement" } } }, "description": "Further information required in order to proceed with this account." }, "SimulationSuspendDetail": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "message": { "type": "string" }, "suspended_at": { "type": "string" } } }, "SimulationAccount": { "type": "object", "properties": { "account_details": { "$ref": "#/components/schemas/SimulationAccountDetails", "description": "Relevant information associated with Airwallex account specified in the request." }, "created_at": { "type": "string", "description": "Time the account was created.", "readOnly": true }, "customer_agreements": { "$ref": "#/components/schemas/SimulationCustomerAgreements", "description": "Agreements collected from the user, such as acceptance of terms and conditions, or opt in for marketing." }, "id": { "type": "string", "description": "Airwallex account unique identifier. Once this new account is created, it will be connected to your account and becomes the key value you communicate with Airwallex for any activities in the future." }, "identifier": { "type": "string", "description": "The identifier that the platform uses to identify a merchant, usually a unique merchant identifier." }, "metadata": { "type": "object", "description": "A set of key-value pairs that you can attach to an Account object. This can be useful for storing additional information about the account in a structured format.", "additionalProperties": { "type": "string" } }, "next_action": { "$ref": "#/components/schemas/SimulationNextAction", "description": "Further information required in order to proceed with this account." }, "nickname": { "type": "string", "description": "Optional human-friendly account name." }, "primary_contact": { "$ref": "#/components/schemas/SimulationPrimaryContact", "description": "Contact information for the primary contact of the Airwallex specified account." }, "reactivate_details": { "$ref": "#/components/schemas/SimulationReactivateDetail", "description": "The reactivate details for ACTIVE account with reactivation history." }, "requirements": { "$ref": "#/components/schemas/SimulationAccountRequirement", "description": "Further information required in order to proceed with this account." }, "status": { "type": "string", "description": "Status of the account. One of `CREATED`, `SUBMITTED`, `ACTION_REQUIRED`, `ACTIVE`, `SUSPENDED`." }, "suspend_details": { "type": "array", "description": "The suspend details for SUSPENDED account.", "readOnly": true, "items": { "$ref": "#/components/schemas/SimulationSuspendDetail" } }, "view_type": { "type": "string", "description": "Information on whether the response contains complete or PII excluded data." } } }, "SimulationCurrency": { "type": "object", "required": [ "precision", "value" ], "properties": { "currency_code": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UNDEFINED", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "precision": { "type": "integer", "format": "int32" }, "value": { "type": "string" } }, "description": "Fee currency of the transaction (3-letter ISO-4217 code)." }, "SimulationGaDeposit": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "Amount of the transaction in `transaction currency`.", "maximum": 100000000, "minimum": 0 }, "create_time": { "type": "string", "format": "date-time", "description": "The time of the transaction created." }, "currency": { "type": "string", "description": "Currency of the transaction (3-letter ISO-4217 code)." }, "deposit_type": { "type": "string", "description": "Type of the transaction, can be one of: `DEBIT`, `CREDIT`." }, "fee_amount": { "type": "number", "description": "Fee amount of the transaction in transaction currency." }, "fee_currency": { "$ref": "#/components/schemas/SimulationCurrency", "description": "Fee currency of the transaction (3-letter ISO-4217 code)." }, "id": { "type": "string", "format": "uuid", "description": "Unique id of the transaction." }, "payer_country": { "type": "string", "description": "Payer country code of the transaction (2-letter ISO 3166-2 country code).", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "UNDEFINED", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XK", "XU", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "payer_name": { "type": "string", "description": "Payer name of the transaction.", "maxLength": 255, "minLength": 0 }, "reference": { "type": "string", "description": "Description of the transaction.", "maxLength": 255, "minLength": 0 }, "statement_ref": { "type": "string", "description": "The statement reference of this deposit.", "maxLength": 255, "minLength": 0 }, "status": { "type": "string", "description": "Status of the transaction.", "enum": [ "PENDING", "REJECTED", "SETTLED" ] } } }, "SimulationMerchant": { "type": "object", "properties": { "category_code": { "type": "string", "description": "Merchant category code." }, "city": { "type": "string", "description": "Merchant city." }, "country": { "type": "string", "description": "Merchant country." }, "name": { "type": "string", "description": "Merchant Name." } }, "description": "Merchant of the card transaction." }, "SimulationTransaction": { "type": "object", "properties": { "auth_code": { "type": "string", "description": "Authorization Code." }, "billing_amount": { "type": "number", "description": "Billing amount." }, "billing_currency": { "type": "string", "description": "Billing Currency." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique Identifier for card." }, "card_transaction_event_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the card transaction event created by the simulation operation." }, "card_transaction_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the card transaction created or updated by the simulation operation." }, "card_transaction_lifecycle_id": { "type": "string", "format": "uuid", "description": "The unique identifier of the card transaction lifecycle created or updated by the simulation operation." }, "card_nickname": { "type": "string", "description": "The nickname of the card used." }, "client_data": { "type": "string", "description": "Client data stored against the card record." }, "failure_reason": { "type": "string", "description": "The reason the event was declined. Only present when `process_result` is `DECLINED`. Learn more about [transaction failure reasons](/docs/issuing/transactions/transaction-failure-reasons).", "enum": [ "ACCOUNT_INVALID", "CARDHOLDER_VERIFICATION_FAILED", "CARD_CLOSED", "CARD_INACTIVE", "CARD_INVALID", "CARD_LOST_STOLEN", "CARD_NOT_ACTIVATED", "CARD_REISSUED_TO_NEW_NUMBER", "CURRENCY_NOT_ALLOWED", "CVV_INVALID", "EXPIRY_MISSING", "INSUFFICIENT_AVAILABLE_CREDIT", "INSUFFICIENT_FUNDS", "INTERNAL_ERROR", "INVALID_EXPIRY_DATE", "LIMIT_EXCEEDED", "MERCHANT_CATEGORY_NOT_ALLOWED", "MERCHANT_COUNTRY_NOT_ALLOWED", "MERCHANT_BRAND_NOT_ALLOWED", "MERCHANT_BRAND_CATEGORY_NOT_ALLOWED", "MERCHANT_BRAND_SUBCATEGORY_NOT_ALLOWED", "NOT_SUPPORTED", "OUT_OF_ALLOWED_TIME_RANGE", "PIN_INVALID", "PIN_RETRIES_EXCEEDED", "REMOTE_AUTH_DECLINED", "RESTRICTED_COUNTRY", "SUSPECTED_FRAUD", "TRANSACTION_BLOCKED", "TRANSACTION_BLOCKED_AT_TERMINAL", "TRANSACTION_USAGE_DISABLED" ] }, "masked_card_number": { "type": "string", "description": "Masked card number." }, "merchant": { "$ref": "#/components/schemas/SimulationMerchant", "description": "Merchant of the card transaction." }, "network_transaction_id": { "type": "string", "description": "The transaction unique identifier from VISA network." }, "process_result": { "type": "string", "description": "The processing result of the card transaction event.", "enum": [ "APPROVED", "DECLINED" ] }, "retrieval_ref": { "type": "string", "description": "Transaction retrieval reference number. Data element 37 of an financial transaction message (https://en.wikipedia.org/wiki/ISO_8583)." }, "subtype": { "type": "string", "description": "The card transaction event subtype.", "enum": [ "AUTHORIZATION", "INCREMENTAL_AUTHORIZATION", "VERIFICATION", "REVERSAL", "PARTIAL_REVERSAL", "EXPIRED_AUTHORIZATION", "CLEARING", "PARTIAL_CLEARING", "CLEARING_REVERSAL" ] }, "transaction_amount": { "type": "number", "description": "Transaction amount." }, "transaction_currency": { "type": "string", "description": "Transaction currency." }, "transacted_at": { "type": "string", "format": "date-time", "description": "The network-reported transaction time." }, "type": { "type": "string", "description": "The card transaction event type.", "enum": [ "AUTHORIZATION", "CLEARING", "REVERSAL_AUTH" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the card transaction event was last updated, in ISO 8601 format." } } }, "SimulationThreedsNotification": { "type": "object", "properties": { "status": { "type": "string", "description": "Notification Status." } } }, "SimulationError": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "source": { "type": "string" } } }, "SimulationRefundRequest": { "type": "object", "properties": { "amount": { "type": "number", "description": "The refund amount when accepting `RFI`. If not specified, it will be same as the remaining amount that has been captured but not yet refunded. Please refer to [supported currencies](/docs/payments/reference/supported-currencies) for supported minor units." }, "reason": { "type": "string", "description": "The refund reason when accepting `RFI`. `OTHERS` is used by default. One of `REQUESTED_BY_CUSTOMER`, `DUPLICATE`, `FRAUDULENT`, `ABANDONED`, and `OTHERS`." } }, "description": "The Refund requested to be created." }, "SimulationAcceptDetails": { "type": "object", "properties": { "accepted_at": { "type": "string", "format": "date-time", "description": "The time when the user accepted the PaymentDispute." }, "accepted_by": { "type": "string", "description": "User unique identifier of person/system actioned on case." }, "description": { "type": "string", "description": "The accept description." }, "reason": { "type": "string", "description": "The accept reason. One of \n\n- `AGREEMENT_REACHED_WITH_CUSTOMER`\n- `CUSTOMER_RELATIONSHIP_MAINTENANCE` \n- `LOW_VALUE_TRANSACTION`\n- `VALID_CUSTOMER_DISPUTE` \n- `NO_ACTION_TAKEN_BY_MERCHANT`\n- `RDR_AUTO_ACCEPTED` \n- `COLLABORATION_ACCEPTED_MANUAL`\n- `COLLABORATION_AUTO_ACCEPTED`\n- `COLLABORATION_AUTO_ACCEPTED_BY_EXPIRY`\n- `OTHERS`.\n" }, "refund": { "$ref": "#/components/schemas/SimulationRefundRequest", "description": "The Refund requested to be created." }, "stage": { "type": "string", "description": "The stage when dispute is accepted." } } }, "SimulationCustomerInformation": { "type": "object", "properties": { "billing_address": { "type": "string", "description": "Customer billing address." }, "device_id": { "type": "string", "description": "Customer device unique identifier." }, "email": { "type": "string", "description": "Customer email." }, "ip": { "type": "string", "description": "Customer ip." }, "name": { "type": "string", "description": "Customer name." }, "phone_number": { "type": "string", "description": "Customer phone number." } }, "description": "Customer information." }, "SimulationDeliveryInformation": { "type": "object", "properties": { "address": { "type": "string", "description": "The shipping address. Applicable at stage `RFI`." }, "delivered_at": { "type": "string", "format": "date-time", "description": "The date when services or goods are delivered." }, "fee_amount": { "type": "number", "description": "The amount of shipping fee. Applicable at stage `RFI`." }, "fee_currency": { "type": "string", "description": "The currency of shipping fee. Applicable at stage `RFI`." }, "name": { "type": "string", "description": "The recipient's name. Applicable at stage `RFI`." }, "phone_number": { "type": "string", "description": "The recipient's phone number. Applicable at stage `RFI`." }, "shipped_at": { "type": "string", "format": "date-time", "description": "The shipping date (the expected delivery date for `RFI`)." }, "shipping_company": { "type": "string", "description": "The company name managing this delivery, such as asendia-usa, 4px, and so on." }, "shipping_method": { "type": "string", "description": "The shipping method, such as Priority Mail, Flat rate, and so on. Applicable at stage `RFI`." }, "status": { "type": "string", "description": "The shipping status, such as `SHIPPED`, `DELIVERED`, and so on. Applicable at stage `RFI`." }, "tracking_number": { "type": "string", "description": "The shipping tracking number." } }, "description": "The delivery information." }, "SimulationProduct": { "type": "object", "properties": { "currency": { "type": "string", "description": "The product currency. Please refer to [supported currencies](/docs/payments/reference/supported-currencies)." }, "name": { "type": "string", "description": "The product name." }, "quantity": { "type": "number", "description": "The product quantity." }, "unit_price": { "type": "number", "description": "The product unit price." } } }, "SimulationOrderInformation": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Time at which this order was created." }, "id": { "type": "string", "description": "The order unique identifier." }, "invoice_number": { "type": "string", "description": "The invoice number of order." }, "products": { "type": "array", "description": "The products of order.", "items": { "$ref": "#/components/schemas/SimulationProduct" } }, "total_amount": { "type": "number", "description": "The total amount of order." }, "total_currency": { "type": "string", "description": "The currency of total amount." } }, "description": "The order information. Applicable when the stage is `RFI`." }, "SimulationSellerInformation": { "type": "object", "properties": { "name": { "type": "string", "description": "Seller name." }, "store_name": { "type": "string", "description": "Store name." }, "store_physical_address": { "type": "string", "description": "Store physical address." }, "store_url": { "type": "string", "description": "Store URL." } }, "description": "Merchant information." }, "SimulationDisputeDocument": { "type": "object", "properties": { "description": { "type": "string", "description": "Additional file descriptions or explanations." }, "file_ids": { "type": "array", "description": "File unique identifiers of the documents.", "items": { "type": "string" } }, "type": { "type": "string", "description": "Type of the documents. Possible values: `PRIMARY`, `ORDER`, `CUSTOMER`, `OTHER`.\n\n- **PRIMARY**: The primary evidence depends on the challenge reason.\n- **ORDER**: Order related evidence.\n- **CUSTOMER**: Customer related evidence.\n- **OTHER**: Other supporting evidence.\n" } } }, "SimulationSupportingDocuments": { "type": "object", "properties": { "customer_communication_documents": { "type": "array", "description": "The file IDs of customer communication. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "customer_signature_documents": { "type": "array", "description": "The file IDs of customer signature. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "documents": { "type": "array", "description": "List of documents.", "items": { "$ref": "#/components/schemas/SimulationDisputeDocument" } }, "duplicate_charge_defense_documents": { "type": "array", "description": "The file IDs of duplicate payment evidence. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "generated_files": { "type": "array", "description": "The file unique identifiers of the files generated by Airwallex automatically based on text evidence or refund information.", "items": { "type": "string" } }, "other_documents": { "type": "array", "description": "The list of file IDs of other documents. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "proof_of_delivery_documents": { "type": "array", "description": "The file IDs of proof of delivery. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "receipt_documents": { "type": "array", "description": "The file IDs of the receipt. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } }, "refund_policy_documents": { "type": "array", "description": "The file IDs of the refund policy. Applicable when stage is `CHARGEBACK`. \nDeprecated. Use `documents` instead.", "items": { "type": "string" } } }, "description": "The file unique identifiers of support documents." }, "SimulationChallengeDetails": { "type": "object", "properties": { "challenged_at": { "type": "string", "format": "date-time", "description": "The time when the user challenges PaymentDispute." }, "challenged_by": { "type": "string", "description": "User unique identifier of person/system challenges PaymentDispute." }, "customer_info": { "$ref": "#/components/schemas/SimulationCustomerInformation", "description": "Customer information." }, "delivery_info": { "$ref": "#/components/schemas/SimulationDeliveryInformation", "description": "The delivery information." }, "order_info": { "$ref": "#/components/schemas/SimulationOrderInformation", "description": "The order information. Applicable when the stage is `RFI`." }, "product_description": { "type": "string", "description": "The description of product." }, "product_type": { "type": "string", "description": "The type of Product." }, "reason": { "type": "string", "description": "The reason why the merchant challenges the dispute. Possible values: \n\n- **CUSTOMER_WITHDRAWN**: The customer withdrew the dispute\n- **CUSTOMER_REFUNDED**: The customer has already been refunded\n- **PRODUCT_RECEIVED**: The customer has already received / will receive the product or service\n- **NOT_ENTITLED**: The customer is not entitled to refund\n- **AUTHENTIC_PRODUCT**: The product is not damaged, defective or counterfeit\n- **OTHER_REASONS**: Other reasons for challenging.\n" }, "refund_refusal_reason": { "type": "string", "description": "Explanation of why refund is refused." }, "seller_info": { "$ref": "#/components/schemas/SimulationSellerInformation", "description": "Merchant information." }, "stage": { "type": "string", "description": "The stage when evidence is submitted." }, "supporting_documents": { "$ref": "#/components/schemas/SimulationSupportingDocuments", "description": "The file unique identifiers of support documents." } } }, "SimulationReasonDetails": { "type": "object", "properties": { "description": { "type": "string", "description": "PaymentDispute reason description." }, "original_code": { "type": "string", "description": "PaymentDispute reason code." }, "type": { "type": "string", "description": "PaymentDispute reason type. Possible values: `CREDIT_NOT_PROCESSED`, `FRAUDULENT`, `DUPLICATE_CHARGE`, `PRODUCT_NOT_RECEIVED`, `PRODUCT_UNACCEPTABLE`, `UNRECOGNIZED_CHARGE`, `CANCELLED_PRODUCT`, `MISREPRESENTATION`, `COUNTERFEIT_PRODUCT`, `PROCESSING_ERRORS`, `AUTHORIZATION`, `NOT_RECOGNIZED`, `BANK_REJECTION`, `FUND_REVERSAL`, `CONSUMER_DISPUTE`, `POINT_OF_INTERACTION_ERROR` and `UNKNOWN`." } }, "description": "PaymentDispute reason." }, "SimulationRefundDetails": { "type": "object", "properties": { "acquirer_reference_number": { "type": "string", "description": "The acquirer reference number of Refund." }, "id": { "type": "string", "description": "Refund unique identifier." } } }, "SimulationPaymentDispute": { "type": "object", "properties": { "accept_details": { "type": "array", "description": "Further details on why the client is accepting the PaymentDispute event.", "items": { "$ref": "#/components/schemas/SimulationAcceptDetails" } }, "acquirer_reference_number": { "type": "string", "description": "The acquirer reference number of original payment." }, "amount": { "type": "number", "description": "PaymentDispute amount." }, "card_brand": { "type": "string", "description": "The card brand of original payment, applicable when payment_method_type is `CARD`. Possible values: `visa`, `mastercard`, `maestro`, `union pay`, `american express`, `jcb`, `diners club international` and `discover`." }, "challenge_details": { "type": "array", "description": "The challenge data submitted at each stage.", "items": { "$ref": "#/components/schemas/SimulationChallengeDetails" } }, "created_at": { "type": "string", "format": "date-time", "description": "Time at which this PaymentDispute was created." }, "currency": { "type": "string", "description": "PaymentDispute currency." }, "customer_id": { "type": "string", "description": "The customer unique identifier of original payment." }, "customer_name": { "type": "string", "description": "The customer name of original payment." }, "due_at": { "type": "string", "format": "date-time", "description": "PaymentDispute due date." }, "id": { "type": "string", "description": "PaymentDispute unique identifier." }, "issuer_comment": { "type": "string", "description": "The issuer’s comment on PaymentDispute." }, "issuer_documents": { "type": "array", "description": "The issuer’s documents on PaymentDispute.", "items": { "type": "string" } }, "merchant_order_id": { "type": "string", "description": "The order unique identifier of original payment." }, "mode": { "type": "string", "description": "PaymentDispute mode. Possible values: `ALLOCATION`, `COLLABORATION`, applicable when the stage is `CHARGEBACK`, `PRE_ARBITRATION` and `ARBITRATION`." }, "payment_attempt_id": { "type": "string", "description": "PaymentAttempt unique identifier." }, "payment_intent_id": { "type": "string", "description": "PaymentIntent unique identifier." }, "payment_method_type": { "type": "string", "description": "The payment method type of original payment." }, "reason": { "$ref": "#/components/schemas/SimulationReasonDetails", "description": "PaymentDispute reason." }, "refunds": { "type": "array", "description": "The Refunds of original payment.", "items": { "$ref": "#/components/schemas/SimulationRefundDetails" } }, "stage": { "type": "string", "description": "PaymentDispute stage." }, "status": { "type": "string", "description": "PaymentDispute status. Possible values: \n\n- **REQUIRES_RESPONSE**: In this status, you can decide whether to accept or challenge the PaymentDispute.\n - Applicable when receive notification from card schemes that PaymentDispute has entered `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, or `PRE_ARBITRATION` stage.\n- **CHALLENGED**: In this status, we have informed the issuing bank that you would like to challenge the PaymentDispute.\n - Applicable when you challenge the PaymentDispute. At `PRE_CHARGEBACK` stage, the issuing bank will escalate to the chargeback stage in the following days. At `RFI`, `CHARGEBACK`, and `PRE_ARBITRATION` stage, the issuing bank will review your submitted evidence and decide whether to escalate the PaymentDispute or not.\n- **ACCEPTED**: In this status the PaymentDispute has been accepted and the payment will be refunded to the shopper.\n - Applicable when you accept the PaymentDispute at `RFI`, `PRE_CHARGEBACK`, `CHARGEBACK`, and `PRE_ARBITRATION` stage.\n- **REVERSED**: In this status, the PaymentDispute has been reversed by the issuing bank. No further action is required.\n - Applicable when receive notification from card schemes that PaymentDispute has been reversed at `PRE_CHARGEBACK`, `CHARGEBACK`, and `PRE_ARBITRATION` stage.\n- **WON**: In this status, the issuing bank has accepted the response provided, or card schemes have ruled the PaymentDispute decision in your favor. No further action is required.\n - Applicable at `CHARGEBACK`, `PRE_ARBITRATION` and `ARBITRATION` stage.\n- **LOST**: In this status, the issuing bank has not accepted the evidence provided by you, or card schemes have ruled the PaymentDispute decision in Issuer’s favor. No further action is required.\n - Applicable at `PRE_ARBITRATION` and `ARBITRATION` stage.\n- **PENDING_CLOSURE**: In this status, the issuing bank has escalated the PaymentDispute to `PRE_ARBITRATION` stage and Airwallex is reviewing the PaymentDispute. Airwallex will decide whether to accept the PaymentDispute or respond to it on your behalf and may reach out to you for more information.\n - Applicable at `PRE_ARBITRATION` stage.\n- **EXPIRED**: In this status, the `RFI` event has expired as you have not responded to the request within 15 days.\n - Applicable at `RFI` stage.\n- **PENDING_DECISION**: In this status, we have responded to the issuing bank with evidence provided by you. The issuing bank will review your submitted evidence and decide whether to accept the PaymentDispute or not.\n - Applicable at `PRE_ARBITRATION` and `ARBITRATION` stage." }, "transaction_type": { "type": "string", "description": "The transaction type of the original transaction. Possible values: `PAYMENT`, `REFUND`." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last time at which this PaymentDispute was updated or operated on." } } }, "SimulationRfiAddress": { "type": "object", "properties": { "address_line1": { "type": "string", "description": "The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable." }, "address_line2": { "type": "string", "description": "An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number." }, "country_code": { "type": "string", "description": "Country code. (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Postcode or zip code. Only applicable if relevant to selected country." }, "state": { "type": "string", "description": "Name of state. Only applicable if relevant to selected country." }, "suburb": { "type": "string", "description": "Name of city/suburb." } }, "description": "Response for `ADDRESS` type." }, "SimulationRfiFileId": { "type": "object", "properties": { "file_id": { "type": "string", "description": "File id provided in the response from the File Service API." } } }, "SimulationRfiIdentityDocument": { "type": "object", "properties": { "back_file_id": { "type": "string", "description": "File id of the photo of the back of the document." }, "front_file_id": { "type": "string", "description": "File id of the photo of the front of the document." }, "issuing_country": { "type": "string", "description": "Country issuing the document. (2-letter ISO 3166-2 country code)." }, "number": { "type": "string", "description": "Identity number." }, "type": { "type": "string", "description": "Type of identity document. One of `DRIVING_LICENSE`,`PASSPORT`,`IDENTITY_CARD`,`MEDICARE_CARD`,`SSN`,`ITIN`." } }, "description": "Response for `IDENTITY_DOCUMENT` type." }, "SimulationRfiRequestItemResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/SimulationRfiAddress", "description": "Response for `ADDRESS` type." }, "attachments": { "type": "array", "description": "Response for `ATTACHMENT` type.", "items": { "$ref": "#/components/schemas/SimulationRfiFileId" } }, "comment": { "type": "string", "description": "comment for this response." }, "confirmed": { "type": "boolean", "description": "Response for `CONFIRMATION` type." }, "identity_document": { "$ref": "#/components/schemas/SimulationRfiIdentityDocument", "description": "Response for `IDENTITY_DOCUMENT` type." }, "text": { "type": "string", "description": "Response for `TEXT` type." }, "type": { "type": "string", "description": "The type of response to the question.", "enum": [ "ADDRESS", "ATTACHMENT", "CONFIRMATION", "IDENTITY_DOCUMENT", "LIVENESS", "TEXT" ] } }, "description": "Response to the question." }, "SimulationRfiSupportingDoc": { "type": "object", "properties": { "file_id": { "type": "string", "description": "File id used in File Service API to get file download link." } } }, "SimulationRfiRequestItemContent": { "type": "object", "properties": { "en": { "type": "string", "description": "Content in English." }, "zh": { "type": "string", "description": "Content in Chinese." } }, "description": "The description of the question." }, "SimulationLiveness": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the liveness verification.", "enum": [ "FAILED", "NOT_STARTED", "STARTED", "SUBMITTED", "SUCCEEDED" ] }, "url": { "type": "string", "description": "This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera. \n \nPlease note: \n\n- If `LIVENESS` is the only question in the RFI, the `Respond to an RFI` API does not need a separate call. It will be auto-resolved after verification.\n- For RFIs with both `LIVENESS` and other questions, please complete liveness verification before responding to the rest." } }, "description": "Information for the `LIVENESS` type questions." }, "SimulationRfiRequestItemSourcePerson": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name of the person." }, "last_name": { "type": "string", "description": "Last name of the person." } }, "description": "Information for `PERSON` source." }, "SimulationRfiRequestItemSource": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the source." }, "person": { "$ref": "#/components/schemas/SimulationRfiRequestItemSourcePerson", "description": "Information for `PERSON` source." }, "type": { "type": "string", "description": "The type of the source. Type of values and their corresponding API: \n \n\n- `PERSON`: [Get account by ID](/docs/api/scale/accounts/retrieve)\n\n- `BUSINESS`: match `account_details.business_person_details.person_id` with the source id\n- `INDIVIDUAL`: match `account_details.individual_details.person_id` with the source id\n- If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.\n\n- `CARDHOLDER`: [Get cardholder details](/docs/api/issuing/cardholders/retrieve)\n- `PAYMENT_INTENT`: [Retrieve a PaymentIntent](/docs/api/payments/payment_intents/retrieve)\n\nFor `TRANSACTION` RFI: \n\n- `CHARGE`: [Get a charge by ID](/docs/api/scale/charges/retrieve)\n- `TRANSFER`: [Get a transfer by ID](/docs/api/payouts/transfers/retrieve)\n- `DIRECT_DEBIT`: [Get direct debit by ID](/docs/api/core_resources/direct_debits/retrieve)\n- `DEPOSIT`: [Get a deposit by ID](/docs/api/core_resources/deposits/retrieve)\n- `PAYMENT`: [Get payment by ID](/docs/api/payouts/transfers/retrieve)." } } }, "SimulationUploadedOrder": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Unique identifier of the uploaded order." } } }, "SimulationRfiRequestItem": { "type": "object", "properties": { "answer": { "$ref": "#/components/schemas/SimulationRfiRequestItemResponse", "description": "Response to the question." }, "attachments": { "type": "array", "description": "The supporting documents of the question.", "items": { "$ref": "#/components/schemas/SimulationRfiSupportingDoc" } }, "comment": { "type": "string", "description": "Additional description for this question." }, "description": { "$ref": "#/components/schemas/SimulationRfiRequestItemContent", "description": "The description of the question." }, "id": { "type": "string", "description": "Unique identifier for the question." }, "key": { "type": "string", "description": "The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements \n \nPossible values: \n\n- `PROOF_OF_ADDRESS`\n- `ID_COPY`." }, "liveness": { "$ref": "#/components/schemas/SimulationLiveness", "description": "Information for the `LIVENESS` type questions." }, "sources": { "type": "array", "description": "In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified.", "items": { "$ref": "#/components/schemas/SimulationRfiRequestItemSource" } }, "title": { "$ref": "#/components/schemas/SimulationRfiRequestItemContent", "description": "The title of the question." }, "uploaded_orders": { "type": "array", "description": "The uploaded orders which are related to the transaction, only applicable for `TRANSACTION` RFI.", "items": { "$ref": "#/components/schemas/SimulationUploadedOrder" } } } }, "SimulationRfiRequest": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Timestamp the RFI request was created." }, "expires_at": { "type": "string", "description": "Timestamp the RFI request will expire, and the RFI status will be transited to `CLOSED`." }, "questions": { "type": "array", "description": "List of questions.", "items": { "$ref": "#/components/schemas/SimulationRfiRequestItem" } }, "updated_at": { "type": "string", "description": "The latest timestamp the RFI request was updated." } }, "description": "The current RFI request you are required to respond to." }, "SimulationRfiSession": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Airwallex account unique identifier." }, "active_request": { "$ref": "#/components/schemas/SimulationRfiRequest", "description": "The current RFI request you are required to respond to." }, "answered_requests": { "type": "array", "description": "The list of RFI requests that have already been responded to.", "items": { "$ref": "#/components/schemas/SimulationRfiRequest" } }, "created_at": { "type": "string", "description": "Timestamp the RFI was created." }, "id": { "type": "string", "description": "Unique identifier for the RFI." }, "status": { "type": "string", "description": "The status of the RFI. Possible values: \n \n\n- `ACTION_REQUIRED`: Airwallex requires you to respond to the RFI request\n- `ANSWERED`: You have already responded to the RFI request and your response is being reviewed by Airwallex\n- `CLOSED`: The review is complete and no further information is required." }, "sub_type": { "type": "string", "description": "The sub type of RFI. \nFor `TRANSACTION` RFI: \n- `TRANSACTION_MONITORING`: Internal transaction monitoring\n- `TRANSACTION_SCREENING`: Internal transaction screening\n- `BANKING_PARTNER_INQUIRY`: External banking partner inquiry." }, "type": { "type": "string", "description": "The type of RFI. Currently supports `KYC`, `KYC_ONGOING`, `CARDHOLDER`, `TRANSACTION`, `PAYMENT_ENABLEMENT` and `MERCHANT_RISK` types." }, "updated_at": { "type": "string", "description": "The latest timestamp the RFI was updated." } } }, "SimulationPaymentIntentInfo": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the payment intent." }, "status": { "type": "string", "description": "The status of the payment intent." } }, "description": "The payment intent that has been confirmed." }, "SimulationConfirmPaymentIntent": { "type": "object", "required": [ "payment_intent", "terminal_id" ], "properties": { "payment_intent": { "$ref": "#/components/schemas/SimulationPaymentIntentInfo", "description": "The payment intent that has been confirmed." }, "terminal_id": { "type": "string", "description": "Terminal unique identifier." } } }, "SimulationGenerateActivationCode": { "type": "object", "required": [ "activation_code", "expires_at" ], "properties": { "activation_code": { "type": "string", "description": "The activation code read from the terminal." }, "expires_at": { "type": "integer", "format": "int64", "description": "Expiration time of the activation code." } } }, "SimulationPaymentScenario": { "type": "object", "required": [ "description", "name" ], "properties": { "description": { "type": "string", "description": "The description of the payment scenario." }, "name": { "type": "string", "description": "The name of the payment scenario." } } }, "SimulationAvailableScenarioNames": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "All available payment scenarios.", "items": { "$ref": "#/components/schemas/SimulationPaymentScenario" } } } }, "SimulationTerminalStatus": { "type": "object", "required": [ "connection_status", "terminal_id" ], "properties": { "connection_status": { "type": "string", "description": "Terminal device connection status.", "enum": [ "CONNECTED", "DISCONNECTED" ] }, "terminal_id": { "type": "string", "description": "Terminal unique identifier." } } }, "SimulationApplicationFeeOption": { "type": "object", "properties": { "amount": { "type": "string", "description": "A positive integer specifying the amount of the fee expressed in the smallest unit of the currency. e.g. cents for USD. This field is required only when type is FIXED." }, "currency": { "type": "string", "description": "Specify the currency of the application fee in ISO 4217 currency code format, e.g., USD, AUD. This field is required when the type is FIXED. \nWhen the type is PERCENTAGE and source_type is CONVERSION, the currency for the conversion if specified must be from the currency pair. If the currency is unspecified, the contra currency of the quote will be used." }, "metadata": { "type": "object", "description": "The metadata of the application fee. The value should be set in key:value format. (e.g., id:1).", "additionalProperties": { "type": "string" } }, "percentage": { "type": "string", "description": "Required if the type is PERCENTAGE, and the value to be provided depends on the transaction context. \nFX Conversions: The value acts as a markup on the FX rate, increasing the conversion cost by the specified percentage. \nOthers: The value represents a direct fee calculated as a percentage of the transaction amount." }, "source_type": { "type": "string", "description": "Specify type of the source transaction.", "enum": [ "CONVERSION", "TRANSFER" ] }, "type": { "type": "string", "description": "Define the type of fee calculation. If the `source_type` is `CONVERSION`, then the type must be `PERCENTAGE`.", "enum": [ "FIXED", "PERCENTAGE" ] } } }, "SimulationApplicationFee": { "type": "object", "properties": { "amount": { "type": "string", "description": "The application fee amount." }, "currency": { "type": "string", "description": "The currency of the application fee." }, "source_type": { "type": "string", "description": "Specify the type of source transaction for this application fee.", "enum": [ "CONVERSION", "TRANSFER" ] } } }, "SimulationBeneficiaryAdditionalInfo": { "type": "object", "properties": { "business_area": { "type": "string", "description": "Category of business activity." }, "business_phone_number": { "type": "string", "description": "Business phone number." }, "business_registration_number": { "type": "string", "description": "Business registration number." }, "external_identifier": { "type": "string", "description": "The identifier that you use to identify a beneficiary, usually a unique identifier. This field can be used to link transfers or beneficiaries to other records such as tax form details for filing purposes." }, "legal_rep_bank_account_number": { "type": "string", "description": "Legal representative's personal bank account number used for declaration purposes. No funds will be sent to this account number." }, "legal_rep_first_name_in_chinese": { "type": "string", "description": "Legal representative first name in chinese." }, "legal_rep_id_number": { "type": "string", "description": "Legal representative id number." }, "legal_rep_last_name_in_chinese": { "type": "string", "description": "Legal representative last name in chinese." }, "legal_rep_mobile_number": { "type": "string", "description": "Legal representative’s mobile number associated with their bank account." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_first_name_in_chinese": { "type": "string", "description": "Beneficiary's first name in Chinese." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." }, "personal_id_type": { "type": "string", "description": "Personal unique identifier type." }, "personal_last_name_in_chinese": { "type": "string", "description": "Beneficiary's last name in Chinese." }, "personal_mobile_number": { "type": "string", "description": "Personal mobile number." }, "recipient_account_id": { "type": "string", "description": "Account unique identifier of the recipient account used for payout processing. The account must be active and have `customer_agreements.terms_and_conditions.service_agreement_type` set to `RECIPIENT` (verify via [Retrieve account details API](/docs/api/scale/accounts/detail))." }, "security_question": { "type": "string", "description": "Security question. Required when the email address is not registered with Interac e-Transfer autodeposit." }, "security_question_answer": { "type": "string", "description": "Security question answer. Required when the email address is not registered with Interac e-Transfer autodeposit." } }, "description": "Additional information about the beneficiary." }, "SimulationBeneficiaryAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "Beneficiary's city." }, "country_code": { "type": "string", "description": "Beneficiary's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Beneficiary's post code." }, "state": { "type": "string", "description": "Beneficiary's state." }, "street_address": { "type": "string", "description": "Beneficiary's street address." } }, "description": "Beneficiary's address details." }, "SimulationBankDetails": { "type": "object", "required": [ "account_currency", "account_name", "bank_country_code" ], "properties": { "account_currency": { "type": "string", "description": "Account Currency." }, "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s bank account." }, "account_name_alias": { "type": "string", "description": "The beneficiary’s account name known in the payment system. This is only supported in some regions and transfer methods. See detailed definitions in the [Payouts Product Docs](/docs/payouts/beneficiaries/create-beneficiaries)." }, "account_number": { "type": "string", "description": "Account number, mostly for non-european countries, either account_number or iban should be filled." }, "account_routing_type1": { "type": "string", "description": "Routing code type." }, "account_routing_type2": { "type": "string", "description": "Routing code sub type." }, "account_routing_value1": { "type": "string", "description": "Routing code value." }, "account_routing_value2": { "type": "string", "description": "Routing code sub type value." }, "bank_account_category": { "type": "string", "description": "bank account type." }, "bank_branch": { "type": "string", "description": "Specific branch of bank account." }, "bank_country_code": { "type": "string", "description": "Bank country code (2-letter ISO 3166-2 country code)." }, "bank_name": { "type": "string", "description": "Bank name of the beneficiary's bank account." }, "bank_state": { "type": "string", "description": "Bank State." }, "bank_street_address": { "type": "string", "description": "Bank street address." }, "binding_mobile_number": { "type": "string", "description": "The mobile number tied to the Beneficiary's bank account." }, "fingerprint": { "type": "string", "description": "Fingerprint of current beneficiary's bank account." }, "iban": { "type": "string", "description": "International bank account number, mostly for european countries." }, "intermediary_bank_name": { "type": "string", "description": "Bank name of the beneficiary's intermediary bank." }, "intermediary_bank_swift_code": { "type": "string", "description": "Intermediary bank SWIFT code / BIC,Should contain alphanumeric characters only, Should be a valid and supported SWIFT code / BIC." }, "local_clearing_system": { "type": "string", "description": "Which clearing system should be used for this local bank transfer.\n\nPlease refer to our [payout guide](https://airwallex.com/guides/payout) for details about each option.\n\nWe suggest explicitly specifying this value, however if it's not provided we will select a default (using the specified account routing type and/or what's most often the best option)." }, "swift_code": { "type": "string", "description": "Bank swift code." } }, "description": "Beneficiary's bank account details where the payment will be credited." }, "SimulationDigitalWallet": { "type": "object", "required": [ "account_name", "id_type", "id_value", "provider" ], "properties": { "account_name": { "type": "string", "description": "Account holder name of the beneficiary’s digital wallet." }, "country_code": { "type": "string", "description": "Digital wallet country code (2-letter ISO 3166-2 country code)." }, "id_type": { "type": "string", "description": "Account identifier type of the beneficiary’s digital wallet." }, "id_value": { "type": "string", "description": "Account identifier value of the beneficiary’s digital wallet." }, "provider": { "type": "string", "description": "Service provider of the beneficiary's digital wallet." } }, "description": "Beneficiary's digital wallet details where the payment will be credited." }, "SimulationBeneficiary": { "type": "object", "properties": { "additional_info": { "$ref": "#/components/schemas/SimulationBeneficiaryAdditionalInfo", "description": "Additional information about the beneficiary." }, "address": { "$ref": "#/components/schemas/SimulationBeneficiaryAddress", "description": "Beneficiary's address details." }, "bank_details": { "$ref": "#/components/schemas/SimulationBankDetails", "description": "Beneficiary's bank account details where the payment will be credited." }, "company_name": { "type": "string", "description": "Company name of the beneficiary." }, "date_of_birth": { "type": "string", "description": "beneficiary date of birth." }, "digital_wallet": { "$ref": "#/components/schemas/SimulationDigitalWallet", "description": "Beneficiary's digital wallet details where the payment will be credited." }, "entity_type": { "type": "string", "description": "Entity type of the beneficiary." }, "first_name": { "type": "string", "description": "First name of the beneficiary." }, "last_name": { "type": "string", "description": "Last name of the beneficiary." }, "type": { "type": "string", "description": "Type of the beneficiary, indicating the type of account or method through which the beneficiary receives funds." } }, "description": "Details of the beneficiary." }, "SimulationUnderlyingConversion": { "type": "object", "required": [ "currency_pair", "rate" ], "properties": { "currency_pair": { "type": "string", "description": "The currency pair of the conversion." }, "rate": { "type": "number", "description": "The rate of the conversion." } }, "description": "Conversion details of a transfer with currency conversions." }, "SimulationDispatchInfo": { "type": "object", "properties": { "external_reference": { "type": "string", "description": "A reference unique identifier to track a transfer after it's dispatched from Airwallex." }, "external_reference_type": { "type": "string", "description": "The definition of the `external_reference` in the payment system." } }, "description": "Additional details populated after the transaction is sent to Airwallex's downstream for processing. Only available for some transfer methods - see [Product Docs](/docs/payouts/transfers/create-a-transfer) for details." }, "SimulationProviderFailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "The original error code received from the local clearing system." }, "local_clearing_system": { "type": "string", "description": "The local clearing system used for the direct debit deposit. Possible values are `AU_BECS`, `US_ACH`, `GB_BACS`, `EU_SEPA`." }, "message": { "type": "string", "description": "The original error message received from the local clearing system." } }, "description": "A set of original information received from the local clearing system." }, "SimulationFailureDetails": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "iso_code": { "type": "string", "description": "Error code [ISO 20022](https://www.iso20022.org/about-iso-20022) (details can be found [here](/docs/global-treasury/receive-funds/add-funds-via-direct-debits-from-linked-accounts/direct-debit-deposit-error-codes))." }, "provider_failure_details": { "$ref": "#/components/schemas/SimulationProviderFailureDetails", "description": "A set of original information received from the local clearing system." } }, "description": "Details about why the funding has failed. Only present when the funding is in a failure state." }, "SimulationFunding": { "type": "object", "required": [ "status" ], "properties": { "deposit_type": { "type": "string", "description": "Can be one of: `FASTER_DIRECT_DEBIT`, `DIRECT_DEBIT`." }, "failure_details": { "$ref": "#/components/schemas/SimulationFailureDetails", "description": "Details about why the funding has failed. Only present when the funding is in a failure state." }, "failure_reason": { "type": "string", "description": "Empty unless the funding is in an error state." }, "funding_source_id": { "type": "string", "description": "The id of the funding source, it can be null if using a wallet." }, "status": { "type": "string", "description": "The funding status of this payment. Please see details in [Funding Statuses](/docs/payouts/older-api-versions/transfers/transfer-statuses#funding-statuses)." } }, "description": "The funding information of this payment." }, "SimulationPayerAdditionalInfo": { "type": "object", "properties": { "business_registration_number": { "type": "string", "description": "Business registration number." }, "business_registration_type": { "type": "string", "description": "Type of business as registered with the local government authority." }, "external_id": { "type": "string", "description": "Unique identifier of the person in your company." }, "personal_email": { "type": "string", "description": "Personal email." }, "personal_id_number": { "type": "string", "description": "Personal unique identifier number." } }, "description": "Additional information about the payer." }, "SimulationPayerAddress": { "type": "object", "required": [ "country_code" ], "properties": { "city": { "type": "string", "description": "Payer's city." }, "country_code": { "type": "string", "description": "Payer's country code (2-letter ISO 3166-2 country code)." }, "postcode": { "type": "string", "description": "Payer's post code." }, "state": { "type": "string", "description": "Payer's state." }, "street_address": { "type": "string", "description": "Payer's street address." } }, "description": "Payer's address details." }, "SimulationPayer": { "type": "object", "required": [ "address", "entity_type" ], "properties": { "additional_info": { "$ref": "#/components/schemas/SimulationPayerAdditionalInfo", "description": "Additional information about the payer." }, "address": { "$ref": "#/components/schemas/SimulationPayerAddress", "description": "Payer's address details." }, "company_name": { "type": "string", "description": "Company name of the payer." }, "date_of_birth": { "type": "string", "description": "Payer's date of birth." }, "entity_type": { "type": "string", "description": "Entity type of the payer." }, "first_name": { "type": "string", "description": "First name of the payer." }, "last_name": { "type": "string", "description": "Last name of the payer." } }, "description": "Details of the payer." }, "SimulationPrepayment": { "type": "object", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "The prepayment amount to be paid." }, "currency": { "type": "string", "description": "The prepayment currency." } }, "description": "Prepayment details for a schedule transfer with currency conversions at a confirmed rate." }, "SimulationTransfer": { "type": "object", "required": [ "amount_beneficiary_receives", "amount_payer_pays", "beneficiary", "created_at", "fee_amount", "fee_currency", "fee_paid_by", "funding", "id", "payer", "reason", "reference", "request_id", "short_reference_id", "source_amount", "source_currency", "status", "transfer_amount", "transfer_currency", "transfer_date", "transfer_method", "updated_at" ], "properties": { "amount_beneficiary_receives": { "type": "number", "description": "The total amount (in transfer `transfer_currency`) the beneficiary receives for this transfer, and is governed by value specified in `fee_paid_by`, i.e. if `fee_paid_by` is `PAYER`, then the beneficiary receives the exact same `transfer_amount` since payer is responsible for the transfer fee. Otherwise, beneficiary receives `transfer_amount - fee` as the fee is implicitly passed onto the beneficiary." }, "amount_payer_pays": { "type": "number", "description": "The total amount (in `source_currency`) the payer has to pay for making this transfer. For example, if `fee_paid_by` is `PAYER` and FX conversion is not involved, then this is the sum of `transfer_amount + fee` as the payer is responsible for the fee. Otherwise this field is the same as `transfer_amount`." }, "application_fee_options": { "type": "array", "description": "The application fee options applied to this transfer.", "items": { "$ref": "#/components/schemas/SimulationApplicationFeeOption" } }, "application_fees": { "type": "array", "description": "Application fees in this transfer.", "items": { "$ref": "#/components/schemas/SimulationApplicationFee" } }, "batch_transfer_id": { "type": "string", "description": "Unique identifier of the batch containing the transfer." }, "beneficiary": { "$ref": "#/components/schemas/SimulationBeneficiary", "description": "Details of the beneficiary." }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "beneficiary_id of the beneficiary contact used to create this transfer." }, "conversion": { "$ref": "#/components/schemas/SimulationUnderlyingConversion", "description": "Conversion details of a transfer with currency conversions." }, "created_at": { "type": "string", "description": "The time this transfer request was created." }, "dispatch_date": { "type": "string", "description": "Actual payout dispatch date. Payouts are dispatched at this date in actual processing. This date could be later than the transfer date." }, "dispatch_info": { "$ref": "#/components/schemas/SimulationDispatchInfo", "description": "Additional details populated after the transaction is sent to Airwallex's downstream for processing. Only available for some transfer methods - see [Product Docs](/docs/payouts/transfers/create-a-transfer) for details." }, "failure_reason": { "type": "string", "description": "Empty unless the transfer is in an error state." }, "failure_type": { "type": "string", "description": "Empty unless the transfer is in an error state." }, "fee_amount": { "type": "number", "description": "The transfer fee (in `source_currency`) for sending this transfer." }, "fee_currency": { "type": "string", "description": "The transfer fee currency. This should always equal to the `source_currency`." }, "fee_paid_by": { "type": "string", "description": "Denotes whether `PAYER` / `BENEFICIARY` will be liable for the the transfer fee. Defaults to `PAYER` unless field is populated in the request." }, "funding": { "$ref": "#/components/schemas/SimulationFunding", "description": "The funding information of this transfer." }, "id": { "type": "string", "format": "uuid", "description": "Returned `id` that can be used to query the status of the transfer." }, "lock_rate_on_create": { "type": "boolean", "description": "Denotes whether to lock the conversion rate for a scheduled transfer with value `TRUE` or `FALSE`.This field should only be specified when a conversion is involved. If not specified, the default value is `TRUE`. " }, "metadata": { "type": "object", "description": "A set of key-value pairs for storing your own data together with the transfer.", "additionalProperties": { "type": "string" } }, "payer": { "$ref": "#/components/schemas/SimulationPayer", "description": "Details of the payer." }, "payer_id": { "type": "string", "format": "uuid", "description": "payer_id of the payer contact used to create this transfer." }, "prepayment": { "$ref": "#/components/schemas/SimulationPrepayment", "description": "Prepayment details for a schedule transfer with currency conversions at a confirmed rate." }, "reason": { "type": "string", "description": "Reason for the transfer instruction." }, "reference": { "type": "string", "description": "Bank transfer reference to be shown on beneficiary's bank transaction history." }, "remarks": { "type": "string", "description": "Additional information about this transfer, which will not be passed to the beneficiary." }, "request_id": { "type": "string", "description": "A unique request identifier specified in the transfer request." }, "short_reference_id": { "type": "string", "description": "Short transfer reference for support purposes." }, "source_amount": { "type": "number", "description": "Amount to be received." }, "source_currency": { "type": "string", "description": "Copied from the request if specified." }, "status": { "type": "string", "description": "The transfer status. Please see details in [Transfer Statuses](/docs/payouts/older-api-versions/transfers/transfer-statuses)." }, "swift_charge_option": { "type": "string", "description": "(For SWIFT transfers only), specify who should bear SWIFT charges, either `SHARED` (default) or `PAYER`." }, "transfer_amount": { "type": "number", "description": "Amount to be paid." }, "transfer_currency": { "type": "string", "description": "Currency the transfer should be made in (3-letter ISO-4217 code)." }, "transfer_date": { "type": "string", "description": "Date when transfer should be made (Copied from the request if specified)." }, "transfer_method": { "type": "string", "description": "Copied from the request if specified. Otherwise the system will populate this field automatically." }, "updated_at": { "type": "string", "description": "The time this transfer request was last updated." } } }, "Simulation_Sandbox_Only_PaymentSource": { "required": [ "billing_customer_id", "created_at", "external_id", "id", "linked_payment_account_id", "updated_at" ], "type": "object", "properties": { "billing_customer_id": { "type": "string", "description": "Unique identifier of the [Billing Customer](/docs/api/billing/billing_customers) that this Payment Source belongs to." }, "created_at": { "type": "string", "description": "Time when this Payment Source was created." }, "external_id": { "type": "string", "description": "Unique identifier of the [Payment Consent](/docs/api/payments/payment_consents) associated with the Payment Source." }, "id": { "type": "string", "description": "Unique identifier of the Payment Source object." }, "linked_payment_account_id": { "type": "string", "description": "Unique identifier of the linked payment account to collect payment. You can find this unique identifier in the Airwallex web app > Settings > Account details, within the Account Information section." }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "description": "A set of string key-value pairs that you can attach to this object for storing additional information." }, "updated_at": { "type": "string", "description": "Time when this Payment Source was last updated." } } }, "Simulation_Sandbox_Only_Offboarding": { "type": "object", "properties": { "comment": { "type": "string", "description": "Additional notes or comments regarding the offboarding." }, "created_at": { "type": "string", "format": "date-time", "description": "The time when the offboarding request was created." }, "id": { "type": "string", "format": "uuid", "description": "Unique ID for the offboarding." }, "reason_code": { "type": "string", "description": "Reasons for the account offboarding provided by the customer." }, "status": { "type": "string", "description": "Offboarding status.", "enum": [ "PENDING", "COMPLETED", "CANCELLED" ], "x-enumDescriptions": { "PENDING": "The offboarding request has been received and is currently being processed.", "COMPLETED": "The offboarding request is complete and the account has been closed.", "CANCELLED": "The offboarding request has been cancelled." } }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the offboarding request was last updated." } } }, "TransferDetails": { "type": "object", "required": [ "account_id", "multi_bill", "transfer_date", "transfer_id" ], "properties": { "transfer_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the transfer." }, "account_id": { "type": "string", "description": "Unique identifier of the Airwallex account associated with the wallet that funded the transfer." }, "multi_bill": { "type": "boolean", "description": "Whether this transfer payment pays multiple bills." }, "source_amount": { "type": "string", "description": "Transfer amount in the source currency before conversion." }, "source_currency": { "type": "string", "description": "Currency of the original transfer, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "transfer_date": { "type": "string", "description": "Date when the transfer was made, in ISO8601 format." } }, "description": "Details of the transfer used to pay the bill." }, "CardTransactionDetails": { "type": "object", "required": [ "account_id", "card_funding_type", "card_id", "card_transaction_id", "source_amount", "source_currency", "transacted_at" ], "properties": { "card_transaction_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card transaction." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card used for payment." }, "account_id": { "type": "string", "description": "Unique identifier of the Airwallex account associated with the wallet that funded the card payment." }, "card_funding_type": { "type": "string", "description": "Card funding type.", "enum": [ "CREDIT", "CASH" ] }, "source_amount": { "type": "string", "description": "Transaction amount in the source currency before conversion." }, "source_currency": { "type": "string", "description": "Currency of the original card transaction, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "transacted_at": { "type": "string", "description": "Timestamp of the card transaction in ISO8601 format." } }, "description": "Details of the card transaction used to pay the bill." }, "BillPayment": { "type": "object", "required": [ "amount", "created_at", "currency", "id", "type" ], "properties": { "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the payment." }, "type": { "type": "string", "description": "Payment method type.", "enum": [ "TRANSFER", "CARD_TRANSACTION", "EXTERNAL" ] }, "amount": { "type": "string", "description": "Amount of the payment." }, "currency": { "type": "string", "description": "Currency of the payment, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "transfer": { "$ref": "#/components/schemas/TransferDetails" }, "card_transaction": { "$ref": "#/components/schemas/CardTransactionDetails" } }, "description": "Payment applied to a bill. The `type` field determines which payment details are present: when `type` is `TRANSFER`, only `transfer` is populated; when `type` is `CARD_TRANSACTION`, only `card_transaction` is populated." }, "Attachment": { "type": "object", "required": [ "content_type", "created_at", "file_name", "file_url", "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the attachment." }, "content_type": { "type": "string", "description": "MIME type of the attached file. Common types include `image/jpeg`, `image/png`, and `application/pdf`." }, "file_name": { "type": "string", "description": "Original filename of the uploaded attachment, including the file extension." }, "file_url": { "type": "string", "description": "URL to access and download the attachment file." }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." } }, "description": "File attachment containing supporting documentation such as receipts, invoices, or other proof of expense. Used for compliance, audit trails, and approval workflows." }, "AccountingFieldSelection": { "type": "object", "required": [ "source_id", "type", "value" ], "properties": { "source_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the selected general ledger (GL) account, tax code, or accounting field value." }, "type": { "type": "string", "description": "Type of accounting field.", "enum": [ "GENERAL_LEDGER_ACCOUNT", "TAX_CODE", "OTHER" ], "x-enumDescriptions": { "GENERAL_LEDGER_ACCOUNT": "General ledger (GL) account assigned to the line item.", "TAX_CODE": "Tax code applied to the line item.", "OTHER": "Custom accounting field defined in your ERP. The field name is provided in `name`." } }, "name": { "type": "string", "description": "Name of the accounting field in the ERP software. This field is populated only when `type` is set to `OTHER`." }, "external_id": { "type": "string", "description": "External unique identifier of the accounting field value in the ERP." }, "value": { "type": "string", "description": "Name of the accounting field value in the ERP." }, "value_label": { "type": "string", "description": "Name of the accounting field value displayed in Airwallex." } } }, "BillLineItem": { "type": "object", "required": [ "accounting_field_selections", "id", "total_amount" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the line item." }, "unit_price": { "type": "string", "description": "Unit price of the line item." }, "quantity": { "type": "string", "description": "Quantity of the line item." }, "description": { "type": "string", "description": "Description of the line item." }, "total_amount": { "type": "string", "description": "Total amount for this line item." }, "tax_amount": { "type": "string", "description": "Tax amount for this line item." }, "accounting_field_selections": { "type": "array", "description": "List of accounting fields selected for the line item.", "items": { "$ref": "#/components/schemas/AccountingFieldSelection" } }, "purchase_order_line_item_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the purchase order line item associated with this bill line item." } }, "description": "Individual line item on a bill, representing a specific product or service with its own amount and accounting categorization." }, "Bill": { "type": "object", "required": [ "approvers", "attachments", "bill_payments", "billing_amount", "created_at", "id", "legal_entity_id", "line_items", "status", "sync_status", "tax_status", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the bill." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with the bill." }, "invoice_number": { "type": "string", "description": "Invoice number associated with the bill." }, "billing_amount": { "type": "string", "description": "Total amount of the bill." }, "billing_currency": { "type": "string", "description": "Currency of the bill, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "status": { "type": "string", "description": "Bill status.", "enum": [ "DRAFT", "AWAITING_APPROVAL", "AWAITING_PAYMENT", "PAYMENT_IN_PROGRESS", "PAID", "REJECTED", "SCHEDULED" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred." }, "tax_status": { "type": "string", "description": "Tax status indicating whether amounts include or exclude tax.", "enum": [ "TAX_EXCLUSIVE", "TAX_INCLUSIVE", "UNSPECIFIED" ] }, "description": { "type": "string", "description": "Description of the bill." }, "approvers": { "type": "array", "description": "List of user emails who can approve the bill.", "items": { "type": "string", "description": "List of user emails who can approve the bill." } }, "issued_date": { "type": "string", "description": "Date when the bill was issued, in ISO8601 format." }, "due_date": { "type": "string", "description": "Date when the bill is due, in ISO8601 format." }, "vendor_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the vendor associated with the bill." }, "purchase_order_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the purchase order associated with the bill." }, "bill_payments": { "type": "array", "description": "List of payments applied to the bill.", "items": { "$ref": "#/components/schemas/BillPayment" } }, "external_id": { "type": "string", "description": "External identifier for this bill in your system." }, "attachments": { "type": "array", "description": "List of file attachments associated with the bill.", "items": { "$ref": "#/components/schemas/Attachment" } }, "line_items": { "type": "array", "description": "List of line items on the bill.", "items": { "$ref": "#/components/schemas/BillLineItem" } }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." } }, "description": "Bill representing an accounts payable obligation, including payment details, line items, and accounting categorization." }, "BillPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of items returned.", "items": { "$ref": "#/components/schemas/Bill" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of bills." }, "CardTransaction": { "type": "object", "required": [ "amount", "currency", "status" ], "properties": { "card_transaction_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the card transaction associated with the expense." }, "status": { "type": "string", "description": "Transaction status.", "enum": [ "AUTHORIZED", "CLEARED", "REVERSED" ], "x-enumDescriptions": { "AUTHORIZED": "Transaction has been authorized by the card network but not yet settled.", "CLEARED": "Transaction has been settled and cleared.", "REVERSED": "Transaction has been reversed or refunded." } }, "amount": { "type": "string", "description": "Amount of the original card transaction in the transaction currency." }, "currency": { "type": "string", "description": "Currency of the original card transaction, as an ISO 4217 currency code." } }, "description": "Details of the original card transaction associated with an expense, including the authorization status, amount, and currency." }, "ExpenseLineItem": { "type": "object", "required": [ "accounting_field_selections", "id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the expense line item." }, "transaction_amount": { "type": "string", "description": "Amount of this line item in the transaction currency, including all taxes. Represents the actual expense amount for this specific component of the overall expense." }, "description": { "type": "string", "description": "Optional description providing details about this specific line item. Helps explain what this component of the expense represents for accounting and approval purposes." }, "accounting_field_selections": { "type": "array", "description": "Accounting and categorization fields assigned to this specific line item. Allows for different accounting treatment of individual components within a single expense.", "items": { "$ref": "#/components/schemas/AccountingFieldSelection" } } }, "description": "Individual line item within an expense representing a specific component or breakdown. Allows for detailed categorization and accounting treatment of different parts of a single expense." }, "Comment": { "type": "object", "required": [ "content", "created_at" ], "properties": { "content": { "type": "string", "description": "Text body of the comment." }, "created_by": { "type": "string", "description": "Email address of the user who created this comment. Used for attribution, notifications, and audit trail tracking." }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." } }, "description": "User comment or note providing additional context, clarification, or communication related to expenses, reimbursements, or approval workflows. Used for audit trails and collaboration." }, "Attendee": { "type": "object", "required": [ "external", "name" ], "properties": { "external": { "type": "boolean", "description": "Indicates whether the attendee is external to the organization." }, "name": { "type": "string", "description": "Name of the attendee." }, "email": { "type": "string", "description": "Email address of the attendee. Present only when `external` is `false`." } }, "description": "Attendee associated with an expense or reimbursement. Can be an internal employee or an external guest." }, "Expense": { "type": "object", "required": [ "account_id", "accounting_field_selections", "approvers", "attachments", "billing_amount", "billing_currency", "card_id", "card_type", "card_transaction", "comments", "created_at", "id", "legal_entity_id", "line_items", "status", "sync_status", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the expense." }, "account_id": { "type": "string", "description": "Unique identifier of the Airwallex account that owns this expense. This determines which account the expense amount is debited from." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with this expense. Used for accounting segregation and compliance reporting across different legal entities." }, "card_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the Airwallex card used to make this purchase. Links the expense to the specific card and cardholder for tracking and reporting." }, "card_type": { "type": "string", "description": "Identifies whether the expense was made using a company card or an employee card. Possible values are `COMPANY` and `EMPLOYEE`.", "enum": [ "COMPANY", "EMPLOYEE" ], "x-enumDescriptions": { "COMPANY": "Expense made using a company card.", "EMPLOYEE": "Expense made using an employee card." } }, "status": { "type": "string", "description": "Current approval status of the expense. Additional values may appear; implementations should handle unknown values gracefully.", "enum": [ "DRAFT", "AWAITING_APPROVAL", "REJECTED", "APPROVED", "ARCHIVED", "DELETED" ] }, "card_transaction": { "$ref": "#/components/schemas/CardTransaction" }, "sync_status": { "type": "string", "description": "Expense sync status.", "enum": [ "NOT_SYNCED", "READY_TO_SYNC", "SYNCED", "SYNC_FAILED" ] }, "billing_currency": { "type": "string", "description": "Currency in which the billing amount is charged to your account. This is your account's primary currency, regardless of the original transaction currency." }, "billing_amount": { "type": "string", "description": "Total amount charged to your account in billing currency, including any fees or currency conversion. This may differ from the original transaction amount." }, "description": { "type": "string", "description": "Optional description or memo providing additional context about the expense. Often includes the business purpose or additional details about the purchase." }, "merchant": { "type": "string", "description": "Name of the payee for this expense. Not linked to your accounting system." }, "invoice_number": { "type": "string", "description": "Invoice number associated with the expense." }, "approvers": { "type": "array", "description": "Email addresses of users authorized to approve this expense. An empty array indicates no approval is required or the expense has already been approved.", "items": { "type": "string", "description": "Email addresses of users authorized to approve this expense. An empty array indicates no approval is required or the expense has already been approved." } }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." }, "settled_at": { "type": "string", "description": "Timestamp when the transaction was settled, in ISO8601 format. Null if transaction is still pending settlement." }, "accounting_field_selections": { "type": "array", "description": "Merchant accounting field selection assigned to this expense for reporting and categorization in your accounting system.", "items": { "type": "object", "required": [ "source_id", "type", "value" ], "properties": { "source_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the merchant associated with this expense." }, "type": { "type": "string", "description": "Type of accounting field.", "enum": [ "MERCHANT" ], "x-enumDescriptions": { "MERCHANT": "Merchant accounting field selection." } }, "name": { "type": "string", "description": "Name of the accounting field in the ERP software. This field is not populated for merchant accounting field selections." }, "external_id": { "type": "string", "description": "External unique identifier of the accounting field value in the ERP." }, "value": { "type": "string", "description": "Name of the accounting field value in the ERP." }, "value_label": { "type": "string", "description": "Name of the accounting field value displayed in Airwallex." } } } }, "attachments": { "type": "array", "description": "Receipt images and supporting documents uploaded for this expense. Commonly used for compliance and approval workflows.", "items": { "$ref": "#/components/schemas/Attachment" } }, "line_items": { "type": "array", "description": "Breakdown of the expense into detailed line items with individual accounting categories. The sum of all line item amounts should equal the total expense amount.", "items": { "$ref": "#/components/schemas/ExpenseLineItem" } }, "comments": { "type": "array", "description": "Conversation thread and notes about this expense, typically used for approval workflows and clarifications between cardholders and approvers.", "items": { "$ref": "#/components/schemas/Comment" } }, "attendees": { "type": "array", "description": "Attendees associated with this expense, including internal employees and external guests.", "items": { "$ref": "#/components/schemas/Attendee" } } } }, "ExpensePagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of items returned.", "items": { "$ref": "#/components/schemas/Expense" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of expenses." }, "Recurrence": { "type": "object", "required": [ "frequency", "iterations" ], "properties": { "frequency": { "type": "string", "description": "Frequency for recurring purchase orders.", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ] }, "iterations": { "type": "integer", "format": "int32", "description": "Number of occurrences for recurring purchase orders." } }, "description": "Defines the schedule and duration for a recurring purchase order." }, "PurchaseOrderContactDetails": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Name of the contact person." }, "company_name": { "type": "string", "description": "Name of the company." }, "email": { "type": "string", "description": "Email address." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." }, "address": { "$ref": "#/components/schemas/Spend_Address" } }, "description": "Purchase Order Contact Details." }, "PurchaseOrderContacts": { "type": "object", "properties": { "vendor_contact": { "$ref": "#/components/schemas/PurchaseOrderContactDetails" }, "shipping_contact": { "$ref": "#/components/schemas/PurchaseOrderContactDetails" }, "billing_contact": { "$ref": "#/components/schemas/PurchaseOrderContactDetails" } }, "description": "Purchase Order Contact Information." }, "PurchaseOrderLineItem": { "type": "object", "required": [ "accounting_field_selections", "id", "quantity", "unit_price" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the line item." }, "description": { "type": "string", "description": "Description of the line item." }, "quantity": { "type": "string", "description": "Quantity of the line item." }, "unit_price": { "type": "string", "description": "Unit price of the line item (tax-exclusive). Tax is applied separately based on the selected tax rate." }, "accounting_field_selections": { "type": "array", "description": "List of accounting fields selected for the line item.", "items": { "$ref": "#/components/schemas/AccountingFieldSelection" } } }, "description": "Purchase order line item." }, "PurchaseOrderPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of items returned.", "items": { "$ref": "#/components/schemas/Spend_PurchaseOrder" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of purchase orders." }, "ReimbursementLineItem": { "type": "object", "required": [ "accounting_field_selections", "billing_amount", "id", "transaction_amount" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the reimbursement line item." }, "billing_amount": { "type": "string", "description": "Amount of this line item, including all taxes." }, "transaction_amount": { "type": "string", "description": "Amount of this line item in the transaction currency. " }, "tax_amount": { "type": "string", "description": "Tax amount included in the line item transaction amount. Null when tax information is not available." }, "accounting_field_selections": { "type": "array", "description": "Accounting and categorization fields assigned to this specific line item. Allows for different accounting treatment of individual lines within a single reimbursement.", "items": { "$ref": "#/components/schemas/AccountingFieldSelection" } } }, "description": "Individual line item within a reimbursement representing a specific reimbursement line. Allows for detailed itemized breakdown with separate accounting categorization and tax handling." }, "Reimbursement": { "type": "object", "required": [ "accounting_field_selections", "attachments", "billing_amount", "comments", "created_at", "id", "line_items", "transaction_amount", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the reimbursement." }, "description": { "type": "string", "description": "User-provided description or purpose of the amount being reimbursed. Typically includes business justification, trip purpose, or transaction details." }, "merchant_name": { "type": "string", "description": "Name of the merchant or service provider where the purchase was made." }, "transaction_amount": { "type": "string", "description": "Total amount of the original purchase in the transaction currency, including all taxes." }, "transaction_currency": { "type": "string", "description": "Currency of the original transaction, as an ISO 4217 currency code. May differ from your account's billing currency. Null when currency information is not available." }, "billing_amount": { "type": "string", "description": "Amount claimed for reimbursement, including all taxes. This is the amount charged to your card or paid out-of-pocket, and may differ from the transaction amount due to currency conversion or exchange rate differences." }, "transaction_date": { "type": "string", "description": "Date of the original purchase or service delivery in ISO8601 format. This is not the submission date." }, "line_items": { "type": "array", "description": "Breakdown of the reimbursement into individual line items, each with its own amount, tax details, and accounting categorization. The sum of all line item amounts equals the total transaction amount.", "items": { "$ref": "#/components/schemas/ReimbursementLineItem" } }, "attachments": { "type": "array", "description": "Supporting documents uploaded for this reimbursement, such as receipts, invoices, and boarding passes.", "items": { "$ref": "#/components/schemas/Attachment" } }, "comments": { "type": "array", "description": "Comments and notes related to this reimbursement, added during the review and approval process.", "items": { "$ref": "#/components/schemas/Comment" } }, "accounting_field_selections": { "type": "array", "description": "Accounting categories and custom fields assigned to this reimbursement for categorization and reporting.", "items": { "$ref": "#/components/schemas/AccountingFieldSelection" } }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." }, "attendees": { "type": "array", "description": "Attendees associated with this reimbursement, including internal employees and external guests.", "items": { "$ref": "#/components/schemas/Attendee" } } }, "description": "Represents an individual reimbursement request for out-of-pocket purchases. Contains transaction details, supporting documentation, and accounting categorization for reimbursement processing and approval workflows." }, "ReimbursementPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Reimbursement" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of reimbursements." }, "ReimbursementReportSummary": { "type": "object", "required": [ "approvers", "comments", "created_at", "id", "legal_entity_id", "reimbursement_report_transfer_ids", "status", "sync_status", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the reimbursement report." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with this reimbursement report. Used for accounting segregation and compliance reporting across different legal entities." }, "name": { "type": "string", "description": "User-defined name for the reimbursement report." }, "status": { "type": "string", "description": "Current status of the reimbursement report. Additional values may appear; implementations should handle unknown values gracefully.", "enum": [ "DRAFT", "AWAITING_APPROVAL", "AWAITING_PAYMENT", "PAYMENT_IN_PROGRESS", "PAID", "DELETED", "REJECTED", "MARKED_AS_PAID" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "billing_currency": { "type": "string", "description": "Currency in which the reimbursement is paid to the beneficiary, as an ISO 4217 currency code." }, "approvers": { "type": "array", "description": "Email addresses of users authorized to approve this reimbursement report. Defines the approval workflow and who can authorize payment processing.", "items": { "type": "string", "description": "Email addresses of users authorized to approve this reimbursement report. Defines the approval workflow and who can authorize payment processing." } }, "created_by": { "type": "string", "description": "Email address of the user who submitted this reimbursement report." }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the person who will receive the reimbursement payment." }, "comments": { "type": "array", "description": "List of comments on reimbursement report.", "items": { "$ref": "#/components/schemas/Comment" } }, "reimbursement_report_transfer_ids": { "type": "array", "description": "Set of unique identifiers of reimbursement report transfers associated with this report. Contains all transfers that have a valid bank transfer unique identifier and are associated with this report. Empty set when no qualifying transfers exist.", "items": { "type": "string", "format": "uuid", "description": "Set of unique identifiers of reimbursement report transfers associated with this report. Contains all transfers that have a valid bank transfer unique identifier and are associated with this report. Empty set when no qualifying transfers exist." } } }, "description": "Condensed view of a reimbursement report containing essential information without detailed line items. Used in list views, dashboards, and scenarios where detailed reimbursement data is not required." }, "ReimbursementReportSummaryPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReimbursementReportSummary" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of reimbursement report Summaries." }, "ReimbursementReportTransfer": { "type": "object", "required": [ "account_id", "beneficiary_id", "id", "sync_status", "transfer_id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the reimbursement report transfer." }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "account_id": { "type": "string", "description": "Unique identifier of the Airwallex account that funds this reimbursement report transfer. This determines which account the transfer amount is debited from." }, "beneficiary_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the person receiving funds from this reimbursement transfer." }, "transfer_id": { "type": "string", "description": "Unique identifier of the transfer used for this reimbursement report transfer." } }, "description": "Represents a financial transfer generated for reimbursement report's payment processing. Contains details about the payment method, funding source, and synchronization status with external systems." }, "VendorContact": { "type": "object", "properties": { "contact_name": { "type": "string", "description": "Full name of the vendor contact." }, "email": { "type": "string", "description": "Email address of the vendor contact." }, "phone_number": { "type": "string", "description": "Phone number in E.164 format." } }, "description": "Vendor Contact." }, "Vendor": { "type": "object", "required": [ "approvers", "attachments", "comments", "contacts", "created_at", "id", "legal_entity_ids", "name", "status", "sync_status", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the vendor." }, "legal_entity_ids": { "type": "array", "description": "Unique identifiers of the legal entities associated with this vendor.", "items": { "type": "string", "description": "Unique identifiers of the legal entities associated with this vendor." } }, "name": { "type": "string", "description": "Display name of the vendor." }, "business_name": { "type": "string", "description": "Business/legal name of the vendor." }, "country_code": { "type": "string", "description": "Country of the vendor, as an ISO 3166-1 alpha-2 country code.", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "address": { "$ref": "#/components/schemas/Spend_Address" }, "status": { "type": "string", "description": "Vendor status.", "enum": [ "DRAFT", "AWAITING_APPROVAL", "ACTIVE", "ARCHIVED" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred." }, "approvers": { "type": "array", "description": "List of user emails who can approve the vendor.", "items": { "type": "string", "description": "List of user emails who can approve the vendor." } }, "owner_email": { "type": "string", "description": "Email of the internal owner responsible for managing this vendor." }, "business_registration_number": { "type": "string", "description": "Business registration number of the vendor." }, "external_id": { "type": "string", "description": "External identifier for this vendor in your system." }, "contacts": { "type": "array", "description": "Contacts associated with this vendor.", "items": { "$ref": "#/components/schemas/VendorContact" } }, "attachments": { "type": "array", "description": "List of file attachments associated with the vendor.", "items": { "$ref": "#/components/schemas/Attachment" } }, "comments": { "type": "array", "description": "List of comments associated with the vendor.", "items": { "$ref": "#/components/schemas/Comment" } }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." } }, "description": "Vendor representing an external supplier or service provider, used for managing accounts payable relationships, purchase orders, and bill payments." }, "VendorPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "List of items returned.", "items": { "$ref": "#/components/schemas/Vendor" } }, "page_after": { "type": "string", "description": "A pointer to the end of the page list used in pagination to retrieve the next page of results." }, "page_before": { "type": "string", "description": "A pointer to the start of the page list use in pagination to retrieve the previous page of results." } }, "description": "Paginated list of vendors." }, "Spend_Address": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Street address line." }, "city": { "type": "string", "description": "City, district, suburb, or town." }, "state": { "type": "string", "description": "State, province, or region." }, "postcode": { "type": "string", "description": "Postal/ZIP code." }, "country_code": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2).", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] } }, "description": "Address." }, "Spend_PurchaseOrder": { "type": "object", "required": [ "approvers", "attachments", "billed_amount", "billing_currency", "comments", "created_at", "id", "legal_entity_id", "line_items", "purchase_order_number", "status", "sync_status", "total_amount", "updated_at", "vendor_id" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier of the purchase order." }, "legal_entity_id": { "type": "string", "description": "Unique identifier of the legal entity associated with the purchase order." }, "vendor_id": { "type": "string", "format": "uuid", "description": "Unique identifier of the vendor associated with the purchase order." }, "billing_currency": { "type": "string", "description": "Currency of the purchase order, as an ISO 4217 currency code.", "enum": [ "UNDEFINED", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "recurring_amount": { "type": "string", "description": "Tax-exclusive amount per occurrence for recurring purchase orders. This field is null for one-time purchase orders." }, "total_amount": { "type": "string", "description": "Total tax-exclusive amount of this purchase order. For recurring purchase orders, this is the cumulative amount across all occurrences." }, "billed_amount": { "type": "string", "description": "Total tax-exclusive amount already billed against this purchase order." }, "purchase_order_number": { "type": "string", "description": "Unique reference number for this purchase order." }, "external_id": { "type": "string", "description": "External identifier for this purchase order in your system." }, "status": { "type": "string", "description": "Purchase order status.", "enum": [ "OPEN", "COMPLETED", "ARCHIVED", "CLOSED" ] }, "sync_status": { "type": "string", "description": "Sync status for an accounting system.", "enum": [ "NOT_SYNCED", "SYNCED", "SYNC_FAILED" ] }, "sync_error_message": { "type": "string", "description": "Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred." }, "recurrence": { "$ref": "#/components/schemas/Recurrence" }, "description": { "type": "string", "description": "Description of the purchase order." }, "note": { "type": "string", "description": "Additional note or instruction for the vendor regarding this purchase order." }, "net_payment_terms_in_days": { "type": "integer", "format": "int32", "description": "Net payment terms in days." }, "promise_date": { "type": "string", "description": "Expected delivery date for the goods or services, in ISO8601 format." }, "approvers": { "type": "array", "description": "List of user emails who can approve the purchase order.", "items": { "type": "string", "description": "List of user emails who can approve the purchase order." } }, "owner_email": { "type": "string", "description": "Email of the internal owner responsible for managing this purchase order." }, "contacts": { "$ref": "#/components/schemas/PurchaseOrderContacts" }, "attachments": { "type": "array", "description": "List of file attachments associated with the purchase order.", "items": { "$ref": "#/components/schemas/Attachment" } }, "line_items": { "type": "array", "description": "List of line items on the purchase order.", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } }, "comments": { "type": "array", "description": "List of comments on the purchase order.", "items": { "$ref": "#/components/schemas/Comment" } }, "created_at": { "type": "string", "description": "Timestamp for when the resource was created in ISO8601 format." }, "updated_at": { "type": "string", "description": "Timestamp for when the resource was updated in ISO8601 format." } }, "description": "Purchase order representing a commitment to purchase goods or services from a vendor, including line items, billing details, contact information, and optional recurrence settings." }, "Store": { "type": "object", "properties": { "default_currency": { "type": "string", "description": "The default currency of the store is in three-letter ISO 4217 format." }, "id": { "type": "string", "description": "The unique identifier of the store." }, "name": { "type": "string", "description": "The unique identifier or brand name of the store on the commerce platform." }, "platform": { "type": "string", "description": "The commerce platform of the store. One of `AMAZON`, `EBAY`, `SHOPIFY`, `SHOPEE`, `FNAC`, `LAZADA`, `WOO_COMMERCE`, `SHOPLAZZA`, `MAGENTO`." }, "platform_seller_id": { "type": "string", "description": "The seller unique identifier on the commerce platform." }, "status": { "type": "string", "enum": [ "CONNECTED", "DISCONNECTED" ] }, "url": { "type": "string", "description": "The URL of the commerce store." } } }, "FileDownloadLink": { "type": "object", "properties": { "content_type": { "type": "string", "description": "Content type." }, "download_link_valid_until": { "type": "string", "description": "File download URL expiration date." }, "file_id": { "type": "string", "description": "File unique identifier." }, "filename": { "type": "string", "description": "File name, if provided during upload." }, "size": { "type": "integer", "format": "int64", "description": "File size in bytes." }, "url": { "type": "string", "description": "File download URL." } } }, "DownloadLinks": { "type": "object", "properties": { "absent_files": { "type": "array", "description": "File unique identifiers that could not be found.", "items": { "type": "string" } }, "files": { "type": "array", "description": "File download links.", "items": { "$ref": "#/components/schemas/FileDownloadLink" } } } }, "FileInformation": { "type": "object", "properties": { "created": { "type": "integer", "format": "int64", "description": "created time of file." }, "file_id": { "type": "string", "description": "Unique identifier of file, to be referenced in other endpoints." }, "filename": { "type": "string", "description": "Name of file." }, "notes": { "type": "string", "description": "notes of file." }, "object_type": { "type": "string", "description": "type of object. Can be file or list." }, "size": { "type": "integer", "format": "int64", "description": "Size in bytes." } } }, "IndustryCategoryV3Item": { "type": "object", "properties": { "answer": { "type": "string", "description": "The answer to the question. \nOnly for CODE items under QUESTION items.", "enum": [ "Yes", "No" ] }, "name": { "type": "string", "description": "Name of the industry category item. \nIt's null for CODE items under QUESTION items." }, "question": { "type": "string", "description": "The question to determine a industry category code. \nOnly for QUESTION items." }, "type": { "type": "string", "description": "Type of the industry category item.", "enum": [ "LIST", "CODE", "QUESTION" ] }, "value": { "type": "string", "description": "The code identifying this industry category. \nOnly for CODE items." }, "values": { "type": "array", "description": "Industry category items under the current item. \nOnly for LIST items and QUESTION items.", "items": { "$ref": "#/components/schemas/IndustryCategoryV3Item" } } } }, "InvalidConversionDate": { "type": "object", "required": [ "date", "reason" ], "properties": { "date": { "type": "string", "format": "date", "description": "The invalid conversion date." }, "reason": { "type": "string", "description": "Reason as to why the date is invalid." } } }, "InvalidConversionDates": { "type": "object", "required": [ "currency_pair", "invalid_conversion_dates" ], "properties": { "currency_pair": { "type": "string", "description": "Currency pair that the invalid conversion dates are applicable to." }, "invalid_conversion_dates": { "type": "array", "description": "List of invalid conversion dates.", "items": { "$ref": "#/components/schemas/InvalidConversionDate" } } } }, "ConvertableCurrencies": { "type": "object", "required": [ "buy_currencies", "sell_currencies" ], "properties": { "buy_currencies": { "type": "array", "description": "List of buyable currencies.", "items": { "type": "string" } }, "sell_currencies": { "type": "array", "description": "List of sellable currencies.", "items": { "type": "string" } } }, "description": "Supported currencies for conversion." }, "SupportedCurrencies": { "type": "object", "required": [ "conversion" ], "properties": { "conversion": { "$ref": "#/components/schemas/ConvertableCurrencies", "description": "Supported currencies for conversion." } } }, "ExpiringQuota": { "type": "object", "required": [ "currency", "expire_by", "expiring_order_amount" ], "properties": { "currency": { "type": "string", "description": "Currency of the account order amount." }, "expire_by": { "type": "string", "description": "Expired date for this these order amount." }, "expiring_order_amount": { "type": "number", "description": "Expiring available order amount of the account." } } }, "OrderQuota": { "type": "object", "required": [ "available_order_amount", "currency", "history_order_amount" ], "properties": { "available_order_amount": { "type": "number", "description": "Available order amount of the account." }, "currency": { "type": "string", "description": "Currency of the account order amount." }, "history_order_amount": { "type": "number", "description": "history order amount of the account." } } }, "FundingSource": { "type": "object", "required": [ "id" ], "properties": { "debit_type": { "type": "string", "description": "The type of deposit you would like to create. If not specified, it will default to DIRECT_DEBIT.", "enum": [ "DIRECT_DEBIT", "FASTER_DIRECT_DEBIT" ] }, "id": { "type": "string", "description": "The funding source unique identifier only supports Linked Accounts. Please provide the unique identifier of your Linked Account as returned in [Create a Linked Account](/docs/api/core_resources/linked_accounts/create). Note that if not specified, the funding source will default to your Wallet." } }, "description": "The funding information for this conversion." }, "RateDetail": { "type": "object", "properties": { "buy_amount": { "type": "number", "description": "The total amount being bought at the respective level." }, "level": { "type": "string", "enum": [ "CLIENT", "AWX", "PLATFORM_CLIENT" ] }, "rate": { "type": "number", "description": "The exchange rate from the respective level's perspective." }, "sell_amount": { "type": "number", "description": "The total amount being sold at the respective level." } } }, "Conversion": { "type": "object", "required": [ "awx_rate", "buy_amount", "buy_currency", "client_rate", "conversion_date", "conversion_id", "created_at", "currency_pair", "dealt_currency", "mid_rate", "request_id", "sell_amount", "sell_currency", "settlement_cutoff_at", "short_reference_id", "status", "updated_at" ], "properties": { "application_fee_options": { "type": "array", "description": "The application fee options applied to the transaction.", "items": { "$ref": "#/components/schemas/ApplicationFeeOption" } }, "application_fees": { "type": "array", "description": "Application fees in this transaction.", "items": { "$ref": "#/components/schemas/ApplicationFee" } }, "awx_rate": { "type": "number", "description": "For reference purposes only. This is a reference rate Airwallex compiles by analyzing prices across multiple banking providers and independent rate publishers." }, "buy_amount": { "type": "number", "description": "The amount in `buy_currency` that was bought by the client." }, "buy_currency": { "type": "string", "description": "Currency that the client bought (in 3-letter ISO-4217 format)." }, "client_rate": { "type": "number", "description": "The transaction execution rate of the conversion. This is the rate at which the client is charged." }, "conversion_date": { "type": "string", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified." }, "conversion_id": { "type": "string", "format": "uuid", "description": "Airwallex-generated unique identifier for the conversion record." }, "created_at": { "type": "string", "description": "The time at which the conversion was created. Follows the [same timestamp format](/docs/api/data_types) as the rest of Airwallex’s APIs." }, "currency_pair": { "type": "string", "description": "The currency pair associated with `awx_rate` and `client_rate`." }, "dealt_currency": { "type": "string", "description": "Dealt denotes the fixed side of the conversion request. If `buy_amount` was specified, then `buy_currency`; else, `sell_currency` (in 3-letter ISO-4217 format)." }, "funding": { "$ref": "#/components/schemas/Transactional_FX_Funding", "description": "The funding information for this conversion." }, "funding_source": { "$ref": "#/components/schemas/FundingSource", "description": "The funding information for this conversion." }, "mid_rate": { "type": "number", "description": "For reference purposes only. This rate represents the midpoint of the current bid and ask price." }, "quote_id": { "type": "string", "description": "The Quote used to execute the conversion. Echoes the request’s Quote unique identifier, if provided." }, "rate_details": { "type": "array", "description": "Breakdown of rates at different user levels.", "items": { "$ref": "#/components/schemas/RateDetail" } }, "request_id": { "type": "string", "description": "Echoes request’s client-supplied request unique identifier (idempotency key)." }, "sell_amount": { "type": "number", "description": "The amount in `sell_currency` that was sold by the client." }, "sell_currency": { "type": "string", "description": "Currency that the client sold (in 3-letter ISO-4217 format)." }, "settlement_cutoff_at": { "type": "string", "description": "This is latest time by which the `sell_amount` in `sell_currency` needs to be available in Airwallex account balance for the conversion to be successfully settled." }, "short_reference_id": { "type": "string", "description": "Shortened transaction unique identifier for ease of use within Web GUI and with Airwallex support." }, "status": { "type": "string", "description": "Status of the conversion. Can be one of `SCHEDULED`, `CANCELLED`, `OVERDUE`, `SETTLED`." }, "updated_at": { "type": "string", "description": "The time at which the conversion was last updated (including status changes). Follows the [same timestamp format](/docs/api/data_types) as the rest of Airwallex’s APIs." } } }, "AmendmentCharge": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of the financial adjustment (cancellation delta).\n Contact your account manager for settlement timing and configuration options." }, "awx_rate": { "type": "number", "description": "The rate at which Airwallex executed the amendment (with Airwallex's liquidity provider partners)." }, "client_rate": { "type": "number", "description": "The rate at which the client is being billed for the amendment (inherited from the client’s existing conversion rate configuration). " }, "currency": { "type": "string", "description": "The currency of the financial adjustment. This is always the non-fixed side of the original conversion." }, "currency_pair": { "type": "string", "description": "The currency pair associated with `awx_rate` and `client_rate`." }, "type": { "type": "string", "description": "Type of charge applied.", "enum": [ "FEE", "CREDIT" ] } } }, "ConversionAmendment": { "type": "object", "properties": { "amendment_id": { "type": "string", "description": "Airwallex-generated unique identifier of the amendment." }, "charges": { "type": "array", "description": "Represents the indicative financial adjustment resulting from the amendment.", "items": { "$ref": "#/components/schemas/AmendmentCharge" } }, "conversion_id": { "type": "string", "description": "Airwallex echoes the unique identifier of the conversion being amended." }, "created_at": { "type": "string", "description": "The time at which the amendment was created (follows the [same format](/docs/api/data_types) as the rest of Airwallex’s APIs)." }, "metadata": { "type": "object", "description": "Airwallex echoes any client-supplied metadata." }, "request_id": { "type": "string", "description": "Airwallex echoes the request’s idempotency key." }, "short_reference_id": { "type": "string", "description": "Shortened transaction unique identifier for ease of use within Web GUI and with Airwallex support." }, "type": { "type": "string", "description": "Defines the type of amendment to be created. Only `CANCEL` is supported.", "enum": [ "CANCEL" ], "x-enumDescriptions": { "CANCEL": "Full cancellation of the original conversion." } }, "updated_at": { "type": "string", "description": "The time at which the amendment was last updated (follows the [same format](/docs/api/data_types) as the rest of Airwallex’s APIs)." } } }, "ConversionAmendmentQuote": { "type": "object", "properties": { "charges": { "type": "array", "description": "Represents the indicative financial adjustment resulting from the amendment.", "items": { "$ref": "#/components/schemas/AmendmentCharge" } }, "conversion_id": { "type": "string", "description": "Airwallex echoes the unique identifier of the conversion being amended." }, "metadata": { "type": "object", "description": "Airwallex echoes any client-supplied metadata." }, "request_id": { "type": "string", "description": "Airwallex echoes the request’s idempotency key." }, "short_reference_id": { "type": "string", "description": "Shortened transaction unique identifier for ease of use within Web GUI and with Airwallex support." }, "type": { "type": "string", "description": "Defines the type of amendment to be created. Only `CANCEL` is supported.", "enum": [ "CANCEL" ], "x-enumDescriptions": { "CANCEL": "Full cancellation of the original conversion." } } } }, "FxQuote": { "type": "object", "required": [ "awx_rate", "buy_amount", "buy_currency", "client_rate", "conversion_date", "currency_pair", "dealt_currency", "mid_rate", "quote_id", "rate_details", "sell_amount", "sell_currency", "usage", "valid_from_at", "valid_to_at", "validity" ], "properties": { "application_fees": { "type": "array", "description": "Application fees in this transaction.", "items": { "$ref": "#/components/schemas/ApplicationFee" } }, "awx_rate": { "type": "number", "description": "For reference purposes only. This is a reference rate Airwallex compiles by analyzing prices across multiple banking providers and independent rate publishers." }, "buy_amount": { "type": "number", "description": "`buy_amount` copied from the Quote request (if specified). Otherwise, this is calculated by multiplying/dividing the `sell_amount` by the FX quote depending on the direction of the currency pair." }, "buy_currency": { "type": "string", "description": "Buy currency of the quote (3-letter ISO-4217 code)." }, "client_rate": { "type": "number", "description": "The returned quote." }, "conversion_date": { "type": "string", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified." }, "currency_pair": { "type": "string", "description": "The currency pair that the quote is for. The direction of the currency pair is per market convention where possible." }, "dealt_currency": { "type": "string", "description": "The currency where the client provided the exact amount for in the request." }, "mid_rate": { "type": "number", "description": "For reference purposes only. This rate represents the midpoint of the current bid and ask price." }, "quote_id": { "type": "string", "format": "uuid", "description": "The quote unique identifier." }, "rate_details": { "type": "array", "description": "Breakdown of rates at different user levels.", "items": { "$ref": "#/components/schemas/RateDetail" } }, "sell_amount": { "type": "number", "description": "`sell_amount` copied from the Quote request (if specified). Otherwise, this is calculated by multiplying/dividing the `buy_amount` by the FX quote depending on the direction of the currency pair." }, "sell_currency": { "type": "string", "description": "Sell currency of the quote (3-letter ISO-4217 code)." }, "usage": { "type": "string", "description": "Quote usage.", "enum": [ "SINGLE_USE", "MULTI_USE" ] }, "valid_from_at": { "type": "string", "description": "Quote valid from in ISO8601 format (inclusive)." }, "valid_to_at": { "type": "string", "description": "Quote valid to in ISO8601 format (inclusive)." }, "validity": { "type": "string", "description": "Quote validity period in the create request.", "enum": [ "MIN_1", "MIN_15", "MIN_30", "HR_1", "HR_4", "HR_8", "HR_24" ] } } }, "FxRates": { "type": "object", "required": [ "buy_currency", "conversion_date", "created_at", "currency_pair", "dealt_currency", "rate", "rate_details", "sell_currency" ], "properties": { "buy_currency": { "type": "string", "description": "Buy currency of the rate (3-letter ISO-4217 code)." }, "conversion_date": { "type": "string", "description": "Date on which the conversion will be settled. `conversion_date` defaults to current date, if funding is available, unless specified." }, "created_at": { "type": "string", "description": "The time at which the request was made. Follows the [same timestamp format](/docs/api/data_types) as the rest of Airwallex’s APIs." }, "currency_pair": { "type": "string", "description": "The currency pair that the rate is for. The direction of the currency pair is per market convention where possible." }, "dealt_currency": { "type": "string", "description": "The currency where the client provided the exact amount for in the request." }, "rate": { "type": "number", "description": "`sell_amount` copied from the Rate request (if specified). Otherwise, this is calculated by multiplying/dividing the `buy_amount` by the FX rate depending on the direction of the currency pair." }, "rate_details": { "type": "array", "description": "Breakdown of rates at different user levels.", "items": { "$ref": "#/components/schemas/RateDetail" } }, "sell_currency": { "type": "string", "description": "Sell currency of the rate (3-letter ISO-4217 code)." } } }, "Transactional_FX_Funding": { "type": "object", "properties": { "debit_type": { "type": "string", "enum": [ "DIRECT_DEBIT", "FASTER_DIRECT_DEBIT" ] }, "failure_reason": { "type": "string", "description": "Empty unless the funding is in an error state." }, "funding_source_id": { "type": "string", "description": "The id of the funding source, it can be null if using a wallet." }, "status": { "type": "string", "description": "The funding statuses of this conversion." } }, "description": "The funding information for this conversion." }, "ApiWebhook": { "type": "object", "required": [ "created_at", "events", "id", "request_id", "secret", "updated_at", "url", "version" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the Webhook object." }, "url": { "type": "string", "description": "The endpoint where events are sent to." }, "secret": { "type": "string", "description": "The secret to verify that events are sent from Airwallex. See [this guide](/docs/developer-tools/webhooks/listen-for-webhook-events#check-webhook-signatures) for details." }, "version": { "type": "string", "description": "The [API version](/docs/api/versioning) which controls the event payload structure. It should be in YYYY-MM-DD format, e.g. `2022-11-11`." }, "events": { "type": "array", "description": "A list of [events](/docs/developer-tools/webhooks/listen-for-webhook-events/event-types) subscribed by this webhook. Events cannot be modified after creation. Only events matching your [API key scopes](/docs/developer-tools/api/api-key-scopes) are allowed.", "items": { "type": "string", "description": "A list of [events](/docs/developer-tools/webhooks/listen-for-webhook-events/event-types) subscribed by this webhook. Events cannot be modified after creation. Only events matching your [API key scopes](/docs/developer-tools/api/api-key-scopes) are allowed." } }, "created_at": { "type": "string", "description": "The time when this webhook was created." }, "updated_at": { "type": "string", "description": "The time when this webhook was last updated." }, "request_id": { "type": "string", "description": "A unique request identifier specified by the client for idempotency. Up to 50 characters." } } }, "ApiWebhookDelete": { "type": "object", "required": [ "deleted", "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the Webhook object." }, "deleted": { "type": "boolean", "description": "Whether the webhook was successfully deleted." } }, "description": "Response confirming webhook deletion." }, "ApiWebhookPagination": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "Paged results.", "items": { "$ref": "#/components/schemas/ApiWebhook" } }, "page_before": { "type": "string", "description": "The page cursor used for searching before page." }, "page_after": { "type": "string", "description": "The page cursor used for searching after page." } } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Obtain a token via `POST /api/v1/authentication/login` with your API key and client unique identifier. Pass it as `Authorization: Bearer {{ACCESS_TOKEN}}`. Tokens expire after a configurable duration." } } }, "x-tagGroups": [ { "name": "Account Capability", "tags": [ "Account Capability > Account Capability" ] }, { "name": "Accounting", "tags": [ "Accounting > General Ledger Accounts", "Accounting > Tax Codes", "Accounting > Accounting Fields", "Accounting > Accounting Field Values" ] }, { "name": "Authentication", "tags": [ "Authentication > Embedded Components", "Authentication > Authentication" ] }, { "name": "Billing", "tags": [ "Billing > Credit Notes", "Billing > E-Invoicing Documents", "Billing > Billing Checkouts", "Billing > Billing Customers", "Billing > Billing Transactions", "Billing > Coupons", "Billing > Invoices", "Billing > Meters", "Billing > Payment Sources", "Billing > Prices", "Billing > Products", "Billing > Rate Cards", "Billing > Subscriptions", "Billing > Usage Events" ] }, { "name": "Checkout", "tags": [ "Checkout > Checkout Sessions" ] }, { "name": "Confirmation Letter", "tags": [ "Confirmation Letter > Confirmation Letter" ] }, { "name": "Core Resources", "tags": [ "Core Resources > Direct Debits", "Core Resources > Balances", "Core Resources > Deposits", "Core Resources > Global Accounts", "Core Resources > Linked Accounts" ] }, { "name": "Finance", "tags": [ "Finance > Financial Reports", "Finance > Financial Transactions", "Finance > Settlements" ] }, { "name": "Issuing", "tags": [ "Issuing > Cards", "Issuing > Authorizations", "Issuing > Card Transaction Events", "Issuing > Card Transactions", "Issuing > Cardholders", "Issuing > Config", "Issuing > Digital Wallet Tokens", "Issuing > Card Transaction Lifecycles", "Issuing > Merchant Brands", "Issuing > Transaction Disputes", "Issuing > Transactions", "Issuing > Card Profiles" ] }, { "name": "Payments", "tags": [ "Payment Acceptance > Reference Data", "Payment Acceptance > Payment Links", "Payment Acceptance > Config", "Payment Acceptance > Conversion Quotes", "Payment Acceptance > Customers", "Payment Acceptance > Customs Declarations", "Payment Acceptance > Funds Split Reversals", "Payment Acceptance > Funds Splits", "Payment Acceptance > Payment Attempts", "Payment Acceptance > Payment Consents", "Payment Acceptance > Payment Disputes", "Payment Acceptance > Payment Intents", "Payment Acceptance > Payment Methods", "Payment Acceptance > Terminals", "Payment Acceptance > Refunds", "Payment Acceptance > Settlement Records", "Payment Acceptance > Customer Balance Transactions" ] }, { "name": "Payouts", "tags": [ "Payouts > Batch Transfers", "Payouts > Beneficiaries", "Payouts > Payers", "Payouts > Transfers" ] }, { "name": "Risk", "tags": [ "Risk > Fraud Feedback (Issuing)", "Risk > Watchlist", "Risk > Request for Information (RFI)", "Risk > Sellers", "Risk > Risk Reports" ] }, { "name": "Embedded Finance", "tags": [ "Embedded Finance > Platform Reports", "Embedded Finance > Hosted Flows", "Embedded Finance > Charges", "Embedded Finance > Connected Account Transfers", "Embedded Finance > PSP Settlement Deposits", "Embedded Finance > PSP Settlement Intents", "Embedded Finance > PSP Settlement Splits", "Embedded Finance > Offboardings", "Embedded Finance > Platform Liquidity Programs", "Embedded Finance > Accounts", "Embedded Finance > Invitation Links" ] }, { "name": "Security", "tags": [ "Security > Activity Log" ] }, { "name": "Simulation", "tags": [ "Simulation (Sandbox Only) > Billing", "Simulation (Sandbox Only) > Accounts", "Simulation (Sandbox Only) > Deposits", "Simulation (Sandbox Only) > Issuing", "Simulation (Sandbox Only) > Linked Accounts", "Simulation (Sandbox Only) > Payment Acceptance", "Simulation (Sandbox Only) > Terminal Simulation", "Simulation (Sandbox Only) > Request for Information (RFI)", "Simulation (Sandbox Only) > Transfers", "Simulation (Sandbox Only) > Offboardings" ] }, { "name": "Spend", "tags": [ "Spend > Vendors", "Spend > Reimbursements", "Spend > Purchase Orders", "Spend > Expenses", "Spend > Bills" ] }, { "name": "Supporting Services", "tags": [ "Supporting Services > Connected Stores", "Supporting Services > File Service", "Supporting Services > Reference Data" ] }, { "name": "Transactional FX", "tags": [ "Transactional FX > Conversion Amendments", "Transactional FX > Conversion", "Transactional FX > Quotes", "Transactional FX > Rates" ] }, { "name": "Webhooks", "tags": [ "Webhooks > Webhooks" ] } ] }