> ## Documentation Index
> Fetch the complete documentation index at: https://pricing.envisso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Merchant List

> CSV or Excel — one row per merchant legal entity.

<Info>
  * All active merchants on your platform
  * One row = one legal entity, not per PSP account
  * Send via email or SFTP
</Info>

<Panel>
  <Card title="Download CSV template" icon="download" href="https://prod-envisso.com/mintlify/envisso_protect_pricing_merchants_file_template.csv">
    Merchant list template with column headers and descriptions.
  </Card>

  <Card title="Download Excel template" icon="download" href="https://prod-envisso.com/mintlify/envisso_protect_pricing_data_spec_template.xlsx">
    Combined template with both Merchant List and Loss History sheets.
  </Card>
</Panel>

## Identity

<ParamField path="merchant_registration_id" type="string" required>
  The legal registration ID of the merchant. This ID is assigned by the relevant government authority in the merchant's registered country.

  Example: `"201912345H"` (SG) or `"5457657"` (US)
</ParamField>

<ParamField path="merchant_registration_id_type" type="string" required>
  The type of registration ID based on the country where the merchant is registered.

  Example: `"UEN"` (SG) or `"SOS"` (US)
</ParamField>

<ParamField path="merchant_registered_country" type="string" required>
  The country where the merchant is legally registered, as a two-letter code per [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) alpha-2.

  Example: `"SG"`
</ParamField>

<ParamField path="merchant_registered_state" type="string">
  The state where the merchant headquarters are legally registered, per [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US). **Mandatory for US merchants**, can be left blank for non-US merchants.

  Example: `"US-NY"`
</ParamField>

<ParamField path="merchant_legal_name" type="string" required>
  The merchant's legal name as registered with the relevant government authority.

  Example: `"ABC Trading Ltd."`
</ParamField>

<ParamField path="registered_address_line_1" type="string">
  The first line of the merchant's legally registered address.

  **Mandatory for US merchants**, can be left blank for non-US merchants.

  Example: `"100 High Street"`
</ParamField>

<ParamField path="registered_address_line_2" type="string">
  The second line of the merchant's legally registered address.

  **Mandatory for US merchants**, can be left blank for non-US merchants.

  Example: `"Suite 300"`
</ParamField>

<ParamField path="registered_city" type="string">
  The city in which the merchant is legally registered.

  **Mandatory for US merchants**, can be left blank for non-US merchants.

  Example: `"London"`
</ParamField>

<ParamField path="registered_postal_code" type="string">
  The postal code or ZIP code of the merchant's legally registered address.

  **Mandatory for US merchants**, can be left blank for non-US merchants.

  Example: `"238884"`
</ParamField>

## Business activity

<ParamField path="mccs" type="string" required>
  A comma-separated list of Merchant Category Codes (MCC).

  Example: `"5251, 5714"`
</ParamField>

<ParamField path="currency" type="string" required>
  The currency in which figures are reported, as a three-letter code per [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). If there are multiple currencies, either convert all figures to a primary currency or provide one row per currency.

  Example: `"SGD"`
</ParamField>

<ParamField path="onboarding_date" type="date" required>
  The onboarding date of the merchant in your PSP system, formatted as [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). **Either `onboarding_date` or `months_onboarded` is required.**

  Example: `"2024-01-30"`
</ParamField>

<ParamField path="months_onboarded" type="string" required>
  The number of months since the merchant was onboarded. Use `">12"` if onboarded more than 12 months ago. Leave blank if not yet onboarded. **Either `onboarding_date` or `months_onboarded` is required.**

  Example: `">12"` or `"6"`
</ParamField>

<ParamField path="last_12_months_tpv" type="integer" required>
  The last 12 months Total Payment Volume (TPV) processed by this merchant. If the merchant has not yet been onboarded, provide the expected annual TPV. Whole number, no decimals, no thousand delimiters.

  Example: `8000000`
</ParamField>

## Risk & exposure

<ParamField path="value_at_risk" type="integer" required>
  The maximum loss the PSP could suffer if the merchant defaults, assuming no collateral. Whole number, no decimals. **Either `value_at_risk` or `delivery_days` is required.**

  Example: `135000`
</ParamField>

<ParamField path="delivery_days" type="integer" required>
  The average number of calendar days between when the merchant receives payment and delivers goods/services. Use `0` for immediate delivery. **Either `value_at_risk` or `delivery_days` is required.**

  Example: `14`
</ParamField>

## Optional fields

We understand that collating information across multiple systems can be tedious. However, if the following fields are easily accessible, we highly recommend supplying them so we can provide a better-tailored output for you.

<ParamField path="last_12_mths_transaction_count" type="integer">
  The number of transactions this merchant processed in the last 12 months.

  Example: `10000`
</ParamField>

<ParamField path="collateral_held" type="integer">
  The total value of collateral held for risk prevention purposes. Whole number, no decimals.

  Example: `8000000`
</ParamField>

<ParamField path="desired_insurance_limit" type="integer">
  Your desired insurance limit, if you have one — leave blank and we'll propose one. Whole number, no decimals.

  Example: `8000000`
</ParamField>

<ParamField path="website_url" type="string">
  The merchant's website URL. The protocol (`http://` or `https://`) can be omitted.

  Example: `"www.timstiles.com"`
</ParamField>

<ParamField path="company_registration_date" type="date">
  The official registration date of the merchant's company, formatted as [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).

  Example: `"2024-01-30"`
</ParamField>