Store Detail Requirement
Level 1 | Level 2 | Level 3 | Type | Required | Description |
---|---|---|---|---|---|
store_details | Required | Relevant information associated with the store you are applying payment solutions for. | |||
operating_models | array | Required | The 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_name | string | Required | The trading name your store is operating as. This name will also appear on the receipts to your customers. Max length is 64 characters. | ||
store_websites | array | Required if operating models include ONLINE_CHECKOUT; otherwise optional | 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. | ||
url | string | Required if operating models include ONLINE_CHECKOUT; otherwise optional | Url of the store websites, including online store, marketplace stores, app-store links or other relevant websites. | ||
store_description | string | Required | Free text description of your store's goods or services offerings. Max length is 500 characters. | ||
industry_code | string | Required | 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. | ||
store_address | object | Required if operating models include IN_PERSON; otherwise optional | Physical address of the store. | ||
address_line1 | string | Required if operating models include IN_PERSON; otherwise optional | 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 | string | Optional | 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 | string | Required if operating models include IN_PERSON; otherwise optional | Country code. (2-letter ISO 3166-2 country code) | ||
postcode | string | Conditional | Postcode or zip code. Only applicable if relevant to selected country. | ||
state | string | Conditional | Name of state. Only applicable if relevant to selected country. | ||
suburb | string | Required if operating models include IN_PERSON; otherwise optional | Name of city/suburb. | ||
estimated_transaction_volume | object | Required | Your store's anticipated volume of transactions in the next 12 months with Airwallex. | ||
currency | string | Required | Currency of the transaction volume. (3-letter ISO 4217 currency code) | ||
average_amount_per_transaction | string | Required | The average transaction size of your store. > 0 and <= max_amount_per_transaction | ||
max_amount_per_transaction | string | Required | The maximum transaction size of your store; >0 and <= monthly_transaction_amount | ||
monthly_transaction_amount | string | Required | The average monthly volume of your store; >0 and >= max_amount_per_transaction | ||
cross_border_transaction_percent | string | Required | Percentage of products or services provided to international customers residing outside of where your business's registered. | ||
fulfillment_days | int | Conditional | Number of days your customers will typically need to wait to receive their goods or services after paying for their orders; 1 - 3650 | ||
payment_distribution | array | Required if the store has existing payment operations; otherwise optional | Anticipated transaction volume split by payment methods. Sum of distributiions must be exactly 100 | ||
payment_type | string | Required if the store has existing payment operations; otherwise optional | Type of payment methods; one of CARDS, BANK_DIRECT_DEBIT, OTHER. | ||
percentage | string | Required if the store has existing payment operations; otherwise optional | % of anticipated transaction volume. 0 - 100 | ||
dispute_percent | string | Required if the store has existing payment operations; otherwise optional | 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. 0 -100 | ||
refund_percent | string | Required if the store has existing payment operations; otherwise optional | Average refund rate (percentage of total successful payments that are refunded to your customers) of your store in the past three months. 0 - 100 | ||
mcc | string | Optional | Current or desired MCC for your store. | ||
financial_statements | array | Optional | Additional documents about your store's financials. | ||
file_id | string | Optional | ID of file as provided in the response from the File Service API. | ||
store_photos | array | Optional | Store photos of shop front clearly displaying the company name or photo of building entrance as well as directory with company name listed | ||
file_id | string | Required | All relevant store photos, if more than 1 physical store, provide one photo of each. | ||
employee_size | int | Optional | Total number of staff in all stores. | ||
additional_store_addresses | array | Optional | Additional physical addresses of the store. Only applicable if store_address exists. | ||
address_line1 | string | Optional | 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 | string | Optional | 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 | string | Optional | Country code. (2-letter ISO 3166-2 country code) | ||
postcode | string | Conditional | Postcode or zip code. Only applicable if relevant to selected country. | ||
state | string | Conditional | Name of state. Only applicable if relevant to selected country. | ||
suburb | string | Optional | Name of city/suburb. | ||
sme_program_eligible | boolean | Optional | Whether 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.
- 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
)
- Address line 1 should mandatorily have a house number (
- Primary contact details
- Contact email is mandatory (
primary_contact.email
) - Contact mobile number is mandatory (
primary_contact.mobile
)