### Get All Conversions Source: https://www.airwallex.com/docs/api Retrieves a list of all currency conversions. ```bash GET /api/v1/fx/conversions ``` -------------------------------- ### Retrieve All Charges Source: https://www.airwallex.com/docs/api Use this endpoint to get a list of all charges. No specific setup is required beyond API authentication. ```bash GET /api/v1/charges ``` -------------------------------- ### Get Supported Currencies Source: https://www.airwallex.com/docs/api Retrieves a list of currencies supported by the Airwallex platform. ```bash GET /api/v1/reference/supported_currencies ``` -------------------------------- ### Get All Conversion Amendments Source: https://www.airwallex.com/docs/api Retrieves a list of all conversion amendments. ```bash GET /api/v1/fx/conversion_amendments ``` -------------------------------- ### Get Product by ID Source: https://www.airwallex.com/docs/api Retrieves a specific product by its unique identifier. ```APIDOC ## GET /api/v1/billing/products/{id} ### Description Retrieves a specific product by its ID. ### Method GET ### Endpoint /api/v1/billing/products/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the product. ``` -------------------------------- ### Get Platform Liquidity Program API Source: https://www.airwallex.com/docs/api Retrieve details for a specific platform liquidity program. ```bash GET /api/v1/platform_liquidity_programs/{id} ``` -------------------------------- ### Get Issuing Configuration Source: https://www.airwallex.com/docs/api Retrieves the current configuration settings for card issuing. ```bash GET /api/v1/issuing/config ``` -------------------------------- ### Create a Hosted Flow Source: https://www.airwallex.com/docs/api Use this endpoint to create a new hosted flow instance. This is typically used to initiate user onboarding or other Airwallex-hosted processes. ```bash POST /api/v1/hosted_flows/create ``` -------------------------------- ### GET /api/v1/connected_account_transfers Source: https://www.airwallex.com/docs/api Retrieves a list of connected account transfers. This endpoint was previously GET /api/v1/transfers. ```APIDOC ## GET /api/v1/connected_account_transfers ### Description Retrieves a list of connected account transfers. This endpoint was previously GET /api/v1/transfers. ### Method GET ### Endpoint /api/v1/connected_account_transfers ### Response #### Success Response (200) - **connected_account_transfers** (array) - A list of connected account transfers. - **id** (string) - The unique identifier of the connected account transfer. - **transfer_amount** (object) - The amount and currency of the transfer. - **amount** (string) - The amount of the transfer. - **currency** (string) - The currency of the transfer (e.g., "USD"). - **transfer_date** (string) - The date the transfer is to be made (YYYY-MM-DD). - **transfer_method** (object) - Details of the transfer method. - **conversion_id** (string) - The ID of the underlying conversion. - **updated_at** (string) - The timestamp when the transfer was last updated. #### Response Example ```json { "connected_account_transfers": [ { "id": "cat_123", "transfer_amount": { "amount": "100.00", "currency": "USD" }, "transfer_date": "2024-09-27", "transfer_method": {}, "conversion_id": "conv_abc", "updated_at": "2024-09-27T10:00:00Z" } ] } ``` ``` -------------------------------- ### Simulate Payout Lifecycle Transitions Source: https://www.airwallex.com/docs/api Use this endpoint to simulate transitions within the payout lifecycle in the sandbox environment. ```bash POST /api/v1/simulation/payments/{payment_id}/transition ``` -------------------------------- ### GET /api/v1/transfers/{id} Source: https://www.airwallex.com/docs/api Retrieves details of a specific transfer. This endpoint was previously GET /api/v1/payments/{id}. ```APIDOC ## GET /api/v1/transfers/{id} ### Description Retrieves details of a specific transfer. This endpoint was previously GET /api/v1/payments/{id}. ### Method GET ### Endpoint /api/v1/transfers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the transfer to retrieve. ### Response #### Success Response (200) - **id** (string) - The unique identifier of the transfer. - **transfer_amount** (object) - The amount and currency of the transfer. - **amount** (string) - The amount of the transfer. - **currency** (string) - The currency of the transfer (e.g., "USD"). - **transfer_date** (string) - The date the transfer is to be made (YYYY-MM-DD). - **transfer_method** (object) - Details of the transfer method. - **conversion_id** (string) - The ID of the underlying conversion. - **updated_at** (string) - The timestamp when the transfer was last updated. #### Response Example ```json { "id": "transfer_123", "transfer_amount": { "amount": "100.00", "currency": "USD" }, "transfer_date": "2024-09-27", "transfer_method": {}, "conversion_id": "conv_abc", "updated_at": "2024-09-27T10:00:00Z" } ``` ``` -------------------------------- ### Create Billing Checkout Source: https://www.airwallex.com/docs/api Initiates the setup for an Airwallex-hosted customer checkout experience. Resources like Customer, Payment Source, and Subscription are automatically created upon successful completion. ```APIDOC ## POST /api/v1/billing/billing_checkouts/create ### Description Creates a new billing checkout. ### Method POST ### Endpoint /api/v1/billing/billing_checkouts/create ``` -------------------------------- ### Create Platform Report API Source: https://www.airwallex.com/docs/api Initiate the creation of a platform report. Use the returned ID to retrieve the report later. Reports are limited to 100MB. ```bash POST /api/v1/platform_reports/create ``` -------------------------------- ### GET /api/v1/connected_account_transfers/{id} Source: https://www.airwallex.com/docs/api Retrieves details of a specific connected account transfer. This endpoint was previously GET /api/v1/transfers/{id}. ```APIDOC ## GET /api/v1/connected_account_transfers/{id} ### Description Retrieves details of a specific connected account transfer. This endpoint was previously GET /api/v1/transfers/{id}. ### Method GET ### Endpoint /api/v1/connected_account_transfers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the connected account transfer to retrieve. ### Response #### Success Response (200) - **id** (string) - The unique identifier of the connected account transfer. - **transfer_amount** (object) - The amount and currency of the transfer. - **amount** (string) - The amount of the transfer. - **currency** (string) - The currency of the transfer (e.g., "USD"). - **transfer_date** (string) - The date the transfer is to be made (YYYY-MM-DD). - **transfer_method** (object) - Details of the transfer method. - **conversion_id** (string) - The ID of the underlying conversion. - **updated_at** (string) - The timestamp when the transfer was last updated. #### Response Example ```json { "id": "cat_123", "transfer_amount": { "amount": "100.00", "currency": "USD" }, "transfer_date": "2024-09-27", "transfer_method": {}, "conversion_id": "conv_abc", "updated_at": "2024-09-27T10:00:00Z" } ``` ``` -------------------------------- ### Get Vendor by ID Source: https://www.airwallex.com/docs/api Retrieves a specific vendor record by its unique identifier. Use this to get detailed information about a single vendor. ```APIDOC ## GET /api/v1/spend/vendors/{id} ### Description Retrieves a specific vendor record by its unique identifier. ### Method GET ### Endpoint /api/v1/spend/vendors/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the vendor. ``` -------------------------------- ### POST /api/v1/products/create Source: https://www.airwallex.com/docs/api Creates a new product. The response now includes creation and last updated timestamps. ```APIDOC ## POST /api/v1/products/create ### Description Creates a new product. The response now includes creation and last updated timestamps. ### Method POST ### Endpoint /api/v1/products/create ### Response #### Success Response (200) - **id** (string) - The unique identifier for the created product. - **created_at** (string) - Timestamp of when the product was created. - **updated_at** (string) - Timestamp of when the product was last updated. #### Response Example { "example": "{\"id\": \"prod_xyz\", \"created_at\": \"2023-01-05T14:00:00Z\", \"updated_at\": \"2023-01-05T14:00:00Z\"}" } ``` -------------------------------- ### Create Deposit Simulation Source: https://www.airwallex.com/docs/api Simulates the creation of a deposit into an Airwallex Wallet. ```APIDOC ## POST /api/v1/simulation/deposit/create ### Description Simulates the creation of a deposit into an Airwallex Wallet. ### Method POST ### Endpoint /api/v1/simulation/deposit/create ``` -------------------------------- ### Get Reimbursement Report by ID Source: https://www.airwallex.com/docs/api Retrieves a specific reimbursement report by its unique identifier. Use this to get detailed information about a single report. ```APIDOC ## GET /api/v1/spend/reimbursement_reports/{id} ### Description Retrieves a specific reimbursement report by its unique identifier. ### Method GET ### Endpoint /api/v1/spend/reimbursement_reports/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the reimbursement report. ``` -------------------------------- ### GET /api/v1/transfers Source: https://www.airwallex.com/docs/api Retrieves a list of transfers. This endpoint was previously GET /api/v1/payments. Pagination has been updated to use `page` and `page_before`/`page_after` parameters. ```APIDOC ## GET /api/v1/transfers ### Description Retrieves a list of transfers. This endpoint was previously GET /api/v1/payments. Pagination has been updated to use `page` and `page_before`/`page_after` parameters. ### Method GET ### Endpoint /api/v1/transfers ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve. - **page_before** (string) - Optional - Token for the previous page. - **page_after** (string) - Optional - Token for the next page. ### Response #### Success Response (200) - **transfers** (array) - A list of transfers. - **id** (string) - The unique identifier of the transfer. - **transfer_amount** (object) - The amount and currency of the transfer. - **amount** (string) - The amount of the transfer. - **currency** (string) - The currency of the transfer (e.g., "USD"). - **transfer_date** (string) - The date the transfer is to be made (YYYY-MM-DD). - **transfer_method** (object) - Details of the transfer method. - **conversion_id** (string) - The ID of the underlying conversion. - **updated_at** (string) - The timestamp when the transfer was last updated. - **page_before** (string) - Token for the previous page. - **page_after** (string) - Token for the next page. #### Response Example ```json { "transfers": [ { "id": "transfer_123", "transfer_amount": { "amount": "100.00", "currency": "USD" }, "transfer_date": "2024-09-27", "transfer_method": {}, "conversion_id": "conv_abc", "updated_at": "2024-09-27T10:00:00Z" } ], "page_before": "token_prev", "page_after": "token_next" } ``` ``` -------------------------------- ### Create Coupon API Endpoint Source: https://www.airwallex.com/docs/api Use this endpoint to create new coupon templates. Ensure the request body contains all necessary coupon details. ```bash POST /api/v1/billing/coupons/create ``` -------------------------------- ### Get Connected Store by ID Source: https://www.airwallex.com/docs/api Retrieves details of a specific Connected Store by its unique identifier. Use this to get information about an e-commerce store connected to Airwallex. ```APIDOC ## GET /api/v1/ecosystem/connected_stores/{id} ### Description Retrieves details of a specific Connected Store by its unique identifier. ### Method GET ### Endpoint /api/v1/ecosystem/connected_stores/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the connected store. ``` -------------------------------- ### GET /api/v1/transfers/{id} and GET /api/v1/transfers Source: https://www.airwallex.com/docs/api The `dispatch_info` object is now available under the Transfers resource for specific transfer methods after creation. This object includes `external_reference` and `external_reference_type` for tracking dispatched transfers. ```APIDOC ## GET /api/v1/transfers/{id} ### Description Retrieves details of a specific transfer, now including `dispatch_info` when available. ### Method GET ### Endpoint /api/v1/transfers/{id} ### Response #### Success Response (200) - **dispatch_info** (object) - Information about the transfer dispatch. - **external_reference** (string) - A reference ID to track a transfer after it's dispatched from Airwallex. - **external_reference_type** (string) - The definition of the `external_reference` in the payment system. ## GET /api/v1/transfers ### Description Retrieves a list of transfers, with `dispatch_info` now included in the response when available. ### Method GET ### Endpoint /api/v1/transfers ### Response #### Success Response (200) - **dispatch_info** (object) - Information about the transfer dispatch. - **external_reference** (string) - A reference ID to track a transfer after it's dispatched from Airwallex. - **external_reference_type** (string) - The definition of the `external_reference` in the payment system. ``` -------------------------------- ### List all Payment Consents Source: https://www.airwallex.com/docs/api Use this endpoint to list all PaymentConsent resources. This provides an overview of all established payment agreements. ```bash GET /api/v1/pa/payment_consents ``` -------------------------------- ### Create Program Spending Account API Source: https://www.airwallex.com/docs/api Create a new spending account for a platform liquidity program. ```bash POST /api/v1/platform_liquidity_programs/{id}/program_spending_accounts/create ``` -------------------------------- ### GET /api/v1/pa/refunds, POST /api/v1/pa/refunds/create, GET /api/v1/pa/refunds/{id} Source: https://www.airwallex.com/docs/api The status `SUCCEEDED` has been renamed to `SETTLED` for the Refund resource. This change affects requests and responses for listing refunds, and responses for creating and retrieving individual refunds. ```APIDOC ## GET /api/v1/pa/refunds ### Description Retrieves a list of refunds. The status `SUCCEEDED` has been renamed to `SETTLED`. ### Method GET ### Endpoint /api/v1/pa/refunds ### Response #### Success Response (200) - **status** (string) - The status of the refund. Possible values include `SETTLED` (formerly `SUCCEEDED`). ## POST /api/v1/pa/refunds/create ### Description Creates a refund. The response will reflect the renamed status `SETTLED`. ### Method POST ### Endpoint /api/v1/pa/refunds/create ### Response #### Success Response (200) - **status** (string) - The status of the refund. Possible values include `SETTLED` (formerly `SUCCEEDED`). ## GET /api/v1/pa/refunds/{id} ### Description Retrieves details of a specific refund. The status `SUCCEEDED` has been renamed to `SETTLED`. ### Method GET ### Endpoint /api/v1/pa/refunds/{id} ### Response #### Success Response (200) - **status** (string) - The status of the refund. Possible values include `SETTLED` (formerly `SUCCEEDED`). ``` -------------------------------- ### Create Product API Endpoint Source: https://www.airwallex.com/docs/api Use this endpoint to create a new product in the Airwallex billing system. Products represent goods or services offered to customers. ```bash POST /api/v1/billing/products/create ``` -------------------------------- ### Get Quote Source: https://www.airwallex.com/docs/api Retrieves a specific quote by its ID. ```APIDOC ## GET /api/v1/fx/quotes/{quote_id} ### Description Retrieves a specific quote by its ID. ### Method GET ### Endpoint /api/v1/fx/quotes/{quote_id} ### Parameters #### Path Parameters - **quote_id** (string) - Required - The unique identifier of the quote. ``` -------------------------------- ### Deposit Funds API Source: https://www.airwallex.com/docs/api Initiate a fund deposit into a platform liquidity program. ```bash POST /api/v1/platform_liquidity_programs/{id}/deposit ``` -------------------------------- ### Get Webhook Source: https://www.airwallex.com/docs/api Retrieves a specific webhook subscription by its ID. ```APIDOC ## GET /api/v1/webhooks/{id} ### Description Retrieves a specific webhook subscription by its ID. ### Method GET ### Endpoint /api/v1/webhooks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the webhook. ``` -------------------------------- ### Simulate Shopper Actions on Disputes Source: https://www.airwallex.com/docs/api Simulate various shopper actions related to disputes in the sandbox environment. ```bash POST /api/v1/simulation/pa/shopper_actions/{action} ``` -------------------------------- ### Create Currency Conversion Source: https://www.airwallex.com/docs/api Initiates a transaction to convert funds from one currency to another. This will result in a debit and credit to wallet balances. ```bash POST /api/v1/fx/conversions/create ``` -------------------------------- ### Get Card Limits Source: https://www.airwallex.com/docs/api Retrieves the limits for a specific card. ```APIDOC ## GET /api/v1/issuing/cards/{id}/limits ### Description Retrieves the limits for a card. ### Method GET ### Endpoint /api/v1/issuing/cards/{id}/limits ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the card. ``` -------------------------------- ### Simulate Transfer Lifecycle Source: https://www.airwallex.com/docs/api Use this endpoint to simulate the transfer lifecycle in the sandbox environment. ```bash POST /api/v1/simulation/transfers/{id}/transition ``` -------------------------------- ### Get Meter Summaries Source: https://www.airwallex.com/docs/api Retrieves summaries for a specific meter. ```APIDOC ## GET /api/v1/billing/meters/{id}/summaries ### Description Retrieves summaries for a specific meter. ### Method GET ### Endpoint /api/v1/billing/meters/{id}/summaries #### Path Parameters - **id** (string) - Required - The unique identifier of the meter. ``` -------------------------------- ### Simulate Terminal Payment Scenarios Source: https://www.airwallex.com/docs/api Retrieve available payment scenarios for POS terminals or confirm a payment intent in the sandbox. ```bash GET /api/v1/simulation/pa/pos/terminals/payment_scenarios ``` ```bash POST /api/v1/simulation/pa/pos/terminals/confirm_payment_intent ``` -------------------------------- ### Get Expense by ID Source: https://www.airwallex.com/docs/api Retrieves a specific expense by its unique identifier. ```APIDOC ## GET /api/v1/spend/expenses/{id} ### Description Retrieves a specific expense by its ID. ### Method GET ### Endpoint /api/v1/spend/expenses/{id} ``` -------------------------------- ### Create Price API Endpoint Source: https://www.airwallex.com/docs/api Use this endpoint to define a new price for a product, including amount, currency, and billing frequency. ```bash POST /api/v1/billing/prices/create ``` -------------------------------- ### Get Bill by ID Source: https://www.airwallex.com/docs/api Retrieves a specific bill by its unique identifier. ```APIDOC ## GET /api/v1/spend/bills/{id} ### Description Retrieves a specific bill by its ID. ### Method GET ### Endpoint /api/v1/spend/bills/{id} ``` -------------------------------- ### Simulate Terminal Activation and Status Source: https://www.airwallex.com/docs/api Endpoints for generating activation codes and controlling the power state of virtual POS terminals in the sandbox. ```bash POST /api/v1/simulation/pa/pos/terminals/generate_activation_code ``` ```bash POST /api/v1/simulation/pa/pos/terminals/turn_on ``` ```bash POST /api/v1/simulation/pa/pos/terminals/turn_off ``` -------------------------------- ### Get Customs Declaration Source: https://www.airwallex.com/docs/api Retrieves a specific customs declaration by its ID. ```APIDOC ## GET /api/v1/pa/customs_declarations/{id} ### Description Retrieves the details of a specific customs declaration using its unique identifier. ### Method GET ### Endpoint /api/v1/pa/customs_declarations/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the customs declaration. ``` -------------------------------- ### Get Customer Source: https://www.airwallex.com/docs/api Retrieves a specific customer's information by their ID. ```APIDOC ## GET /api/v1/pa/customers/{id} ### Description Retrieves the details of a specific customer using their unique identifier. ### Method GET ### Endpoint /api/v1/pa/customers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the customer. ``` -------------------------------- ### POST /api/v1/accounts/create Source: https://www.airwallex.com/docs/api Creates a new account. Supports onboarding for individual legal entities with new backing fields and updated validation rules. ```APIDOC ## POST /api/v1/accounts/create ### Description Creates a new account. Supports onboarding for individual legal entities with new backing fields and updated validation rules. ### Method POST ### Endpoint /api/v1/accounts/create ### Request Body - **legal_entity_type** (string) - Required - The type of legal entity, e.g., 'INDIVIDUAL'. - **account_details** (object) - Required - Contains details for the account. - **individual_details** (object) - Details specific to an individual. - **occupation** (string) - Optional - The individual's occupation. - **other_names** (array) - Optional - Other names used by the individual. - **employer** (string) - Optional - The individual's employer. - **estimated_monthly_income** (object) - Optional - Estimated monthly income. - **currency** (string) - Required - The currency of the income. - **amount** (number) - Required - The amount of income. - **account_usage** (object) - Required - Information regarding the usage of the account. - **card_usage** (string) - Optional - Details on card usage. - **collection_from** (string) - Optional - Information on where collections are from. - **payout_to** (string) - Optional - Information on where payouts are directed. - **product_reference** (string) - Optional - Reference to the product. - **identifications** (object) - Optional - Identification documents. - **primary** (object) - Optional - Primary identification. - **type** (string) - Required - The type of identification (e.g., 'TAX_ID', 'drivers_license', 'passport', 'personal_id'). - **number** (string) - Required - The identification number. - **secondary** (object) - Optional - Secondary identification. - **type** (string) - Required - The type of identification. - **number** (string) - Required - The identification number. - **residential_address** (object) - Optional - The residential address. - **residential_address_english** (object) - Optional - The residential address in English. - **live_selfie_file_id** (string) - Optional - The file ID for the live selfie. - **middle_name_english** (string) - Optional - The middle name in English. - **attachments** (object) - Optional - Attachment details. - **individual_documents** (object) - Optional - Documents for individuals. - **tag** (string) - Optional - Tag for the document. - **agreed_to_biometrics_consent** (boolean) - Optional - Consent for biometrics data collection. - **identifier** (string) - Optional - Replaces `user_id_on_platform`. ### Response #### Success Response (200) - **account_id** (string) - The ID of the created account. ``` -------------------------------- ### Create a Charge Source: https://www.airwallex.com/docs/api Use this endpoint to create a new charge. The source connected account must be active and have passed KYC. ```bash POST /api/v1/charges/create ``` -------------------------------- ### Get Conversion Quote Source: https://www.airwallex.com/docs/api Retrieves a specific conversion quote by its ID. ```APIDOC ## GET /api/v1/pa/conversion_quotes/{id} ### Description Retrieves a specific conversion quote using its unique identifier. ### Method GET ### Endpoint /api/v1/pa/conversion_quotes/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the conversion quote. ``` -------------------------------- ### List Products Source: https://www.airwallex.com/docs/api Retrieves a list of all available products. ```APIDOC ## GET /api/v1/billing/products ### Description Retrieves a list of all products. ### Method GET ### Endpoint /api/v1/billing/products ``` -------------------------------- ### Get Card by ID Source: https://www.airwallex.com/docs/api Retrieves a specific card using its ID. ```APIDOC ## GET /api/v1/issuing/cards/{id} ### Description Retrieves a specific card. ### Method GET ### Endpoint /api/v1/issuing/cards/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the card. ``` -------------------------------- ### Simulate RFI Creation and Closure Source: https://www.airwallex.com/docs/api Use these endpoints to simulate the creation, follow-up, and closure of a Request for Information (RFI) in the sandbox. ```bash POST /api/v1/simulation/rfis/create ``` ```bash POST /api/v1/simulation/rfis/{id}/follow_up ``` ```bash POST /api/v1/simulation/rfis/{id}/close ``` -------------------------------- ### Get Subscription by ID Source: https://www.airwallex.com/docs/api Retrieves a specific subscription by its unique identifier. ```APIDOC ## GET /api/v1/billing/subscriptions/{id} ### Description Retrieves a specific subscription by its ID. ### Method GET ### Endpoint /api/v1/billing/subscriptions/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ``` -------------------------------- ### Create Product Source: https://www.airwallex.com/docs/api Creates a new product that represents a good or service offered to customers. ```APIDOC ## POST /api/v1/billing/products/create ### Description Creates a new product. ### Method POST ### Endpoint /api/v1/billing/products/create ``` -------------------------------- ### List Products API Endpoint Source: https://www.airwallex.com/docs/api Use this endpoint to retrieve a list of all products. Products represent the goods or services offered to customers. ```bash GET /api/v1/billing/products ``` -------------------------------- ### Get Price by ID Source: https://www.airwallex.com/docs/api Retrieves a specific price by its unique identifier. ```APIDOC ## GET /api/v1/billing/prices/{id} ### Description Retrieves a specific price using its ID. ### Method GET ### Endpoint /api/v1/billing/prices/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the price. ``` -------------------------------- ### Get Meter by ID Source: https://www.airwallex.com/docs/api Retrieves a specific meter by its unique identifier. ```APIDOC ## GET /api/v1/billing/meters/{id} ### Description Retrieves a specific meter using its ID. ### Method GET ### Endpoint /api/v1/billing/meters/{id} #### Path Parameters - **id** (string) - Required - The unique identifier of the meter. ``` -------------------------------- ### Get Funding Limits Source: https://www.airwallex.com/docs/api Retrieves the funding limits associated with the account. ```APIDOC ## GET /api/v1/account_capabilities/funding_limits ### Description Retrieves the funding limits for the account. ### Method GET ### Endpoint /api/v1/account_capabilities/funding_limits ``` -------------------------------- ### Get Funding Limits Capability Source: https://www.airwallex.com/docs/api Retrieves the funding limits for the account. ```http GET /api/v1/account_capabilities/funding_limits ``` -------------------------------- ### POST /api/v1/accounts/create Source: https://www.airwallex.com/docs/api Creates a new account. Includes new fields for `account_details.trustee_details` and `account_details.business_details.description_of_goods_and_services`, `account_details.business_details.description_of_industry`, `account_details.business_details.industry_category_level3`. ```APIDOC ## POST /api/v1/accounts/create ### Description Creates a new account. Includes new fields for `account_details.trustee_details` and `account_details.business_details.description_of_goods_and_services`, `account_details.business_details.description_of_industry`, `account_details.business_details.industry_category_level3`. ### Method POST ### Endpoint /api/v1/accounts/create ### Request Body - **account_details** (object) - Required - Account details, including trustee and business information. ### Response #### Success Response (200) - **id** (string) - The ID of the created account. ``` -------------------------------- ### GET /api/v1/reference/industry_categories Source: https://www.airwallex.com/docs/api Retrieves a tree of options for `industry_category`, `industry_sub_category`, and `industry_category_level3`. ```APIDOC ## GET /api/v1/reference/industry_categories ### Description Retrieves a tree of options for `industry_category`, `industry_sub_category`, and `industry_category_level3`. ### Method GET ### Endpoint /api/v1/reference/industry_categories ### Response #### Success Response (200) - **industry_categories** (array) - A tree of industry categories. ``` -------------------------------- ### Create Global Account Source: https://www.airwallex.com/docs/api Use this endpoint to create a new Global Account. This allows you to set up a new foreign currency account for collections. ```bash POST /api/v1/global_accounts/create ``` -------------------------------- ### Initiate Port for Global Account Alias Source: https://www.airwallex.com/docs/api Initiates the porting process for a Global Account alias. ```APIDOC ## POST /api/v1/global_accounts/{global_account_id}/aliases/{id}/initiate_port ### Description Initiates the porting process for a Global Account alias. ### Method POST ### Endpoint /api/v1/global_accounts/{global_account_id}/aliases/{id}/initiate_port ### Parameters #### Path Parameters - **global_account_id** (string) - Required - The unique identifier of the Global Account. - **id** (string) - Required - The unique identifier of the alias. ``` -------------------------------- ### GET /api/v1/accounts/invitation_links/{id} Source: https://www.airwallex.com/docs/api Retrieves an Account Link by its link ID. ```APIDOC ## GET /api/v1/accounts/invitation_links/{id} ### Description Retrieves an Account Link by its link ID. ### Method GET ### Endpoint /api/v1/accounts/invitation_links/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the Account Link. ### Response #### Success Response (200) - **id** (string) - The ID of the Account Link. - **status** (string) - The status of the Account Link. ``` -------------------------------- ### GET /api/v1/beneficiaries Source: https://www.airwallex.com/docs/api Retrieves a list of beneficiaries. Field names have been updated. ```APIDOC ## GET /api/v1/beneficiaries ### Description Retrieves a list of beneficiaries. Field names have been updated. ### Method GET ### Endpoint /api/v1/beneficiaries ### Response #### Success Response (200) - **beneficiaries** (array) - A list of beneficiaries. - **id** (string) - The unique identifier of the beneficiary. - **transfer_methods** (array) - A list of transfer methods for the beneficiary. - **transfer_reason** (string) - The reason for the transfer. #### Response Example ```json { "beneficiaries": [ { "id": "beneficiary_xyz", "transfer_methods": [{}], "transfer_reason": "Payment for services" } ] } ``` ``` -------------------------------- ### Create a Payment Intent Source: https://www.airwallex.com/docs/api Use this endpoint to create a new payment intent. Specify amount, currency, customer ID, and payment method. ```bash POST /api/v1/pa/payment_intents/create ``` -------------------------------- ### Linked Account Simulation Source: https://www.airwallex.com/docs/api Simulate the Linked Account lifecycle scenarios in the sandbox environment. ```APIDOC ## POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/accept ### Description Accepts a mandate for a linked account. ### Method POST ### Endpoint /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/accept ``` ```APIDOC ## POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/reject ### Description Rejects a mandate for a linked account. ### Method POST ### Endpoint /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/reject ``` ```APIDOC ## POST /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/cancel ### Description Cancels a mandate for a linked account. ### Method POST ### Endpoint /api/v1/simulation/linked_accounts/{linked_account_id}/mandate/cancel ``` ```APIDOC ## POST /api/v1/simulation/linked_accounts/{linked_account_id}/fail_microdeposits ### Description Simulates a failure in microdeposit verification for a linked account. ### Method POST ### Endpoint /api/v1/simulation/linked_accounts/{linked_account_id}/fail_microdeposits ``` -------------------------------- ### GET /api/v1/transfers Source: https://www.airwallex.com/docs/api Retrieves a list of transfers, including details about the beneficiaries. ```APIDOC ## GET /api/v1/transfers ### Description Retrieves a list of transfers, including details about the beneficiaries. ### Method GET ### Endpoint /api/v1/transfers ### Response #### Success Response (200) - **id** (string) - The unique identifier for the transfer. - **beneficiary** (object) - Details of the transfer beneficiary. - **type** (string) - The type of the beneficiary (`BANK_ACCOUNT` or `DIGITAL_WALLET`). - **digital_wallet** (object) - Details of the digital wallet beneficiary if applicable. - **account_name** (string) - Account holder name of the beneficiary’s digital wallet. - **id_type** (string) - Account identifier type of the beneficiary’s digital wallet. - **id_value** (string) - Account identifier value of the beneficiary’s digital wallet. - **provider** (string) - Service provider of the beneficiary's digital wallet. #### Response Example { "example": "{\"transfers\": [{\"id\": \"transfer_333\", \"beneficiary\": {\"type\": \"DIGITAL_WALLET\", \"digital_wallet\": {\"account_name\": \"Alice Brown\", \"id_type\": \"EMAIL\", \"id_value\": \"alice.b@example.com\", \"provider\": \"WalletCo\"}}}]}" } ``` -------------------------------- ### Initiate Port for Global Account Alias Source: https://www.airwallex.com/docs/api Initiate the porting process for a Global Account alias. This is typically used when transferring an alias from one service to Airwallex. ```bash POST /api/v1/global_accounts/{global_account_id}/aliases/{id}/initiate_port ``` -------------------------------- ### Get Order Item Quota Source: https://www.airwallex.com/docs/api Retrieves the current quota for order items. ```bash GET /api/v1/reference/order_items/quota ``` -------------------------------- ### POST /api/v1/accounts/invitation_links/create Source: https://www.airwallex.com/docs/api Creates an Account Link object that includes an Airwallex hosted URL for the end user to accept a scale connect invitation sent by the platform account. ```APIDOC ## POST /api/v1/accounts/invitation_links/create ### Description Creates an Account Link object that includes an Airwallex hosted URL for the end user to accept a scale connect invitation sent by the platform account. ### Method POST ### Endpoint /api/v1/accounts/invitation_links/create ### Response #### Success Response (200) - **id** (string) - The ID of the created Account Link. - **url** (string) - The Airwallex hosted URL for the end user to accept the invitation. ``` -------------------------------- ### Get Hosted Flow by ID Source: https://www.airwallex.com/docs/api Retrieves a specific hosted flow by its ID. ```APIDOC ## GET /api/v1/hosted_flows/{id} ### Description Retrieves a specific hosted flow by its ID. ### Method GET ### Endpoint /api/v1/hosted_flows/{id} ``` -------------------------------- ### Simulate Payment Dispute Actions Source: https://www.airwallex.com/docs/api Use these endpoints to simulate the creation, resolution, or escalation of payment disputes in the sandbox. ```bash POST /api/v1/simulation/pa/payment_disputes/create ``` ```bash POST /api/v1/simulation/pa/payment_disputes/{id}/resolve ``` ```bash POST /api/v1/simulation/pa/payment_disputes/{id}/escalate ``` -------------------------------- ### Create Partner Webhook Source: https://www.airwallex.com/docs/api Use this endpoint to create a new webhook for your OAuth application. Ensure you have set up HTTP Basic authorization with your client credentials. ```bash POST /partner-api/v1/webhooks/create ``` -------------------------------- ### GET /api/v1/products Source: https://www.airwallex.com/docs/api Retrieves a list of products. The response includes creation and last updated timestamps for each product. ```APIDOC ## GET /api/v1/products ### Description Retrieves a list of products. The response includes creation and last updated timestamps for each product. ### Method GET ### Endpoint /api/v1/products ### Response #### Success Response (200) - **id** (string) - The unique identifier for the product. - **created_at** (string) - Timestamp of when the product was created. - **updated_at** (string) - Timestamp of when the product was last updated. #### Response Example { "example": "{\"products\": [{\"id\": \"prod_ghi\", \"created_at\": \"2023-01-08T17:00:00Z\", \"updated_at\": \"2023-01-08T17:00:00Z\"}]}" } ``` -------------------------------- ### Get Card Details Source: https://www.airwallex.com/docs/api Retrieves the details of a specific card using its ID. ```APIDOC ## GET /api/v1/issuing/cards/{id}/details ### Description Retrieves the details of a specific card. ### Method GET ### Endpoint /api/v1/issuing/cards/{id}/details ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the card. ``` -------------------------------- ### Payout Simulation Source: https://www.airwallex.com/docs/api Simulate the payout lifecycle scenarios in the sandbox environment. ```APIDOC ## POST /api/v1/simulation/payments/{payment_id}/transition ### Description Transitions a payout through its lifecycle stages. ### Method POST ### Endpoint /api/v1/simulation/payments/{payment_id}/transition ``` -------------------------------- ### Get Cardholder by ID Source: https://www.airwallex.com/docs/api Retrieves details of a specific cardholder using their ID. ```APIDOC ## GET /api/v1/issuing/cardholders/{id} ### Description Retrieves details for a specific cardholder. ### Method GET ### Endpoint /api/v1/issuing/cardholders/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the cardholder. ``` -------------------------------- ### List Payment Intents Source: https://www.airwallex.com/docs/api Use this endpoint to retrieve a list of all payment intents. ```bash GET /api/v1/pa/payment_intents ``` -------------------------------- ### Get Deposit by ID Source: https://www.airwallex.com/docs/api Retrieves details of a specific deposit using its ID. ```APIDOC ## GET /api/v1/deposits/{id} ### Description Retrieves a specific deposit by its ID. ### Method GET ### Endpoint /api/v1/deposits/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the deposit. ``` -------------------------------- ### Get Balance History Source: https://www.airwallex.com/docs/api Retrieves the historical balance information for your Airwallex account. ```APIDOC ## GET /api/v1/balances/history ### Description Retrieves the history of balance changes. ### Method GET ### Endpoint /api/v1/balances/history ``` -------------------------------- ### Global Accounts - Create Source: https://www.airwallex.com/docs/api Creates a global account. The response now includes an interim status for in-progress creations. ```APIDOC ## POST /api/v1/global_accounts/create ### Description Creates a global account. The response includes an interim status for in-progress creations. ### Method POST ### Endpoint /api/v1/global_accounts/create ### Response #### Success Response (200) - **status** (string) - The current status of the global account. May include `PROCESSING` for in-progress creations. ``` -------------------------------- ### Request for Information (RFI) Simulation Source: https://www.airwallex.com/docs/api Simulate the creation and closure of RFI in the sandbox environment. ```APIDOC ## POST /api/v1/simulation/rfis/create ### Description Creates a simulated Request for Information (RFI). ### Method POST ### Endpoint /api/v1/simulation/rfis/create ``` ```APIDOC ## POST /api/v1/simulation/rfis/{id}/follow_up ### Description Adds a follow-up to a simulated RFI. ### Method POST ### Endpoint /api/v1/simulation/rfis/{id}/follow_up ``` ```APIDOC ## POST /api/v1/simulation/rfis/{id}/close ### Description Closes a simulated RFI. ### Method POST ### Endpoint /api/v1/simulation/rfis/{id}/close ``` -------------------------------- ### Get Account Capability Source: https://www.airwallex.com/docs/api Retrieves the details of a specific account capability by its ID. ```APIDOC ## GET /api/v1/account_capabilities/{id} ### Description Retrieves the details of a specific account capability. ### Method GET ### Endpoint /api/v1/account_capabilities/{id} ``` -------------------------------- ### POST /api/v1/simulation/transfers/{id}/transition Source: https://www.airwallex.com/docs/api Simulates a transition for a transfer. ```APIDOC ## POST /api/v1/simulation/transfers/{id}/transition ### Description Simulates a transition for a transfer. ### Method POST ### Endpoint /api/v1/simulation/transfers/{id}/transition ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the transfer. #### Request Body - **status** (string) - Required - The target status for the simulation. ### Request Example ```json { "status": "completed" } ``` ### Response #### Success Response (200) - **message** (string) - A confirmation message of the simulated transition. #### Response Example ```json { "message": "Transfer status simulated to completed." } ``` ``` -------------------------------- ### GET /api/v1/pa/customers/{id} Source: https://www.airwallex.com/docs/api Retrieves a customer. The `billing` field is now nested under `card`. ```APIDOC ## GET /api/v1/pa/customers/{id} ### Description Retrieves a customer. The `billing` field is now nested under `card`. ### Method GET ### Endpoint /api/v1/pa/customers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the customer. ### Response #### Success Response (200) - **id** (string) - The ID of the customer. - **card** (object) - Card details, including billing information. ``` -------------------------------- ### GET /api/v1/pa/payment_intents/{id} Source: https://www.airwallex.com/docs/api Retrieves a PaymentIntent. The `billing` field is now nested under `card`. ```APIDOC ## GET /api/v1/pa/payment_intents/{id} ### Description Retrieves a PaymentIntent. The `billing` field is now nested under `card`. ### Method GET ### Endpoint /api/v1/pa/payment_intents/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the PaymentIntent. ### Response #### Success Response (200) - **id** (string) - The ID of the PaymentIntent. - **card** (object) - Card details, including billing information. ``` -------------------------------- ### Create Deposit Source: https://www.airwallex.com/docs/api Use this endpoint to manually create a deposit record. This might be used for reconciliation or specific fund management scenarios. ```bash POST /api/v1/deposits/create ``` -------------------------------- ### GET /api/v1/refunds Source: https://www.airwallex.com/docs/api Retrieves a list of refunds. The status `PROCESSING` has been renamed to `ACCEPTED`. ```APIDOC ## GET /api/v1/refunds ### Description Retrieves a list of refunds. The status `PROCESSING` has been renamed to `ACCEPTED`. ### Method GET ### Endpoint /api/v1/refunds ### Response #### Success Response (200) - **data** (array) - List of refunds. - **status** (string) - The status of the refund (e.g., `ACCEPTED`, `DECLINED`). ``` -------------------------------- ### Create Download Link for File Source: https://www.airwallex.com/docs/api Generates a secure download link for a previously uploaded file. The file ID is required to create the link. ```bash POST /api/v1/files/download_links ``` -------------------------------- ### Create Purchase Order Source: https://www.airwallex.com/docs/api Create a new purchase order. This is part of the Purchase Orders Beta API. ```bash POST /api/v1/spend/purchase_orders/create ```