Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewUnderstanding Payments for PlatformsChoose your Payments for Platforms solution
Use cases
Hold & convert funds
Connected accounts
Connected accounts overviewOnboard connected accounts
KYC and onboarding
Handle KYC RFI
KYB and onboarding
Embedded KYB componentHosted Onboarding Native API
Store Detail Requirement
Payment Method List
Payment Method Onboarding Requirement
Handle Payment Enablement RFI
Onboard multiple connected accountsMove funds between accounts
Error codes

Store Detail Requirement

Level 1Level 2Level 3TypeRequiredDescription
store_detailsRequiredRelevant information associated with the store you are applying payment solutions for.
operating_modelsarrayRequiredThe model of which our customers pay for their orders. One or more of ONLINE_CHECKOUT, INVOICES_OR_CUSTOM_ORDER_LINKS, IN_PERSON. Refer to here for details
store_namestringRequiredThe trading name your store is operating as. This name will also appear on the receipts to your customers. Max length is 64 characters.
store_websitesarrayRequired if operating models include ONLINE_CHECKOUT; otherwise optionalAll 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.
urlstringRequired if operating models include ONLINE_CHECKOUT; otherwise optionalUrl of the store websites, including online store, marketplace stores, app-store links or other relevant websites.
store_descriptionstringRequiredFree text description of your store's goods or services offerings. Max length is 500 characters.
industry_codestringRequiredThe 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.
store_addressobjectRequired if operating models include IN_PERSON; otherwise optionalPhysical address of the store.
address_line1stringRequired if operating models include IN_PERSON; otherwise optionalThe 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
stringOptionalAn optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.

country_code
stringRequired if operating models include IN_PERSON; otherwise optionalCountry code. (2-letter ISO 3166-2 country code)
postcodestringConditionalPostcode or zip code. Only applicable if relevant to selected country.

state
stringConditionalName of state. Only applicable if relevant to selected country.
suburbstringRequired if operating models include IN_PERSON; otherwise optionalName of city/suburb.
estimated_transaction_volumeobjectRequiredYour store's anticipated volume of transactions in the next 12 months with Airwallex.
currencystringRequiredCurrency of the transaction volume. (3-letter ISO 4217 currency code)
average_amount_per_transactionstringRequiredThe average transaction size of your store. > 0 and <= max_amount_per_transaction
max_amount_per_transactionstringRequiredThe maximum transaction size of your store; >0 and <= monthly_transaction_amount
monthly_transaction_amountstringRequiredThe average monthly volume of your store; >0 and >= max_amount_per_transaction
cross_border_transaction_percentstringRequiredPercentage of products or services provided to international customers residing outside of where your business's registered.
fulfillment_daysintConditionalNumber of days your customers will typically need to wait to receive their goods or services after paying for their orders; 1 - 3650
payment_distributionarrayRequired if the store has existing payment operations; otherwise optionalAnticipated transaction volume split by payment methods. Sum of distributiions must be exactly 100
payment_typestringRequired if the store has existing payment operations; otherwise optionalType of payment methods; one of CARDS, BANK_DIRECT_DEBIT, OTHER.
percentagestringRequired if the store has existing payment operations; otherwise optional% of anticipated transaction volume. 0 - 100
dispute_percentstringRequired if the store has existing payment operations; otherwise optionalAverage dispute rate (percentage of total successful payments that are claimed as disputed charges by card schemes) of your store in the past three months. 0 -100
refund_percentstringRequired if the store has existing payment operations; otherwise optionalAverage refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months. 0 - 100
mccstringOptionalCurrent or desired MCC for your store.
financial_statementsarrayOptionalAdditional documents about your store's financials.
file_idstringOptionalID of file as provided in the response from the File Service API.
store_photosarrayOptionalStore photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed
file_idstringRequiredAll relevant store photos, if more than 1 physical store, provide one photo of each.
employee_sizeintOptionalTotal number of staff in all stores.
additional_store_addressesarrayOptionalAdditional physical addresses of the store. Only applicable if store_address exists.
address_line1stringOptionalThe 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
stringOptionalAn optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.

country_code
stringOptionalCountry code. (2-letter ISO 3166-2 country code)
postcodestringConditionalPostcode or zip code. Only applicable if relevant to selected country.

state
stringConditionalName of state. Only applicable if relevant to selected country.
suburbstringOptionalName of city/suburb.
sme_program_eligiblebooleanOptionalWhether the merchant can be enrolled to SME special interchange fee programs.

Sample Payload

JSON

Additional Requirement for US Merchants

If your merchant is registered in the US, you'll need to submit the following additional requirements in account details to use payments.

  1. US person information (account_details.business_person_details)
  • At least one US person with SSN or ITIN is required (account_details.business_person_details.identifications.primary.tax_id.type)
  • The US person can be one of the following role: AUTHORISED_PERSON, BENEFICIAL_OWNER, CONTROLLING_PERSON (account_details.business_person_details.roles)
  • Date of Birth is mandatory (account_details.business_person_details.date_of_birth)
  • Full address of the US person should be provided, including:
    • Address line 1 should mandatorily have a house number (account_details.business_person_details.residential_address.address_line1)
    • Postal code is mandatory (account_details.business_person_details.residential_address.postcode)
    • Two-letter state code is mandatory if it's a US state e.g. CA for California (account_details.business_person_details.residential_address.state)
  1. Primary contact details
  • Contact email is mandatory (primary_contact.email)
  • Contact mobile number is mandatory (primary_contact.mobile)