Merchant Details File
Overview
Context: The merchant details should contain details of all active merchants within your platform.
File Type: CSV
File Name: <company_name>_merchants_YYYYMMDDHHmmSS
- Example = <company_name>_merchants_20221110233030
- company_name = your companies name
- When uploading test files, please append "_testing" at the end of the file name
- Example = <company_name>_merchants_20221110233030_testing
- Frequency: Daily files should only contain records for new merchants to be onboarded and/or existing merchants to be offboarded.
- If there are no merchants being added or removed, the daily file can contain a single line with the column headers, and no data records below
Merchant Details - Data Columns
Column Name | Mandatory | Format Details | Example |
|---|---|---|---|
Environment | Mandatory | Valid values are: "Production" or "Testing" | Production |
Action | Mandatory | Valid values are: "Onboard" or "Offboard" | Onboard |
Registered Country | Mandatory | 2 letter (alpha-2) ISO 3166 country code | SG |
Merchant Registration ID Type | Mandatory | Depends on registered country - see data dictionary | UEN |
Merchant Registration ID | Mandatory | Depends on registered country - see data dictionary | 12345678 |
Merchant Legal Name | Mandatory | | ABC Trading Ltd. |
Merchant Category Code | Mandatory | 4 digit numeric value based on ISO 18245 | 1234 |
Billing Descriptor | Mandatory | | Tim's Tiles |
URL | Mandatory | Merchant website URL | www.timstiles.com |
Company Registration Date | Mandatory | DD/MM/YYYY | 31/01/2001 |
Trading Currency | Mandatory* | 3 letter, ISO 4217 currency code | GBP |
Estimated Annual TPV | Mandatory* | Numeric value with no currency symbol. | 8,000,000 |
Merchant Trading Name | Recommended | | Tim's tiles |
Business Description | Recommended | | Tile & bathroom supplies wholesaler. |
Registered Address Line 1 | Recommended | | 100 High Street |
Registered Address Line 2 | Recommended | | |
Registered City | Recommended | | Berkhamsted |
Registered Postcode / ZIP | Recommended | Standard postcode/ZIP based on registered country | HP1 1AB |
Trading Address Line 1 | Recommended | | 1 London Bridge Road |
Trading Address Line 2 | Recommended | | |
Trading City | Recommended | | London |
Trading Postcode / ZIP | Recommended | Standard postcode/ZIP based on trading country | EC1A 1AB |
Trading Country | Recommended | 2 letter (alpha-2) ISO 3166 country code | UK |
Director 1 Title | Recommended | | Mr |
Director 1 First Name | Recommended | | John |
Director 1 Surname | Recommended | | Smith |
Director 1 Home Address Line 1 | Recommended | | 123 High Street |
Director 1 Home Address Line 2 | Recommended | | |
Director 1 Home City | Recommended | | Berkhamsted |
Director 1 Home Postcode / ZIP | Recommended | Standard postcode/ZIP based on country | HP1 1 AB |
Director 1 Home Country | Recommended | 2 letter (alpha-2) ISO 3166 country code | UK |
Director 1 Date of Birth | Recommended | DD/MM/YYYY | 01/01/1975 |
Director 1 Phone Number | Recommended | Phone number including international dialing code (no spaces) | 6580010001 |
Director 1 Email Address | Recommended | | |
UBO 1 Title | Recommended | | Mr |
UBO 1 First Name | Recommended | | John |
UBO 1 Surname | Recommended | | Smith |
UBO 1 Home Address Line 1 | Recommended | | 123 High Street |
UBO 1 Home Address Line 2 | Recommended | | |
UBO 1 Home City | Recommended | | Berkhamsted |
UBO 1 Home Postcode / ZIP | Recommended | Standard postcode/ZIP based on country | HP1 1 AB |
UBO 1 Home Country | Recommended | 2 letter (alpha-2) ISO 3166 country code | UK |
UBO 1 Date of birth | Recommended | DD/MM/YYYY | 01/01/1975 |
UBO 1 Phone number | Recommended | Phone number including international dialing code (no spaces) | 6580010001 |
UBO 1 Email Address | Recommended | | |
UBO 1 % Ownership | Recommended | % value | 100% |
- indicates a field is mandatory for Envisso Risk Protection Insurance integration only. For Envisso Score & Monitor it is a recommended field.
Notes:
- Please adhere by the format details of each column provided.
- If a merchant has multiple Merchant Category Codes, URLs and/or Billing Descriptors - please send multiple rows for that merchant with the relevant details.
- For Merchant Registration ID please refer to the Merchant Registration ID section of the Data Dictionary.
- UBO = Ultimate Beneficial Owner
- To send multiple director or UBO information, please add additional columns and increment the number in the column titles - example = UBO 2 First Name