--- title: "List Merchants" method: GET path: "/payments/merchants" tags: ["Payments", "Merchants"] --- # List Merchants `GET /payments/merchants` ## Request - Base URL: `https://api.evervault.com` - URL: `https://api.evervault.com/payments/merchants` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all Merchants that have been created. ## Query parameters - `page` integer - `pageSize` integer - `q` string ## Response `200` Returns a list of Merchant objects. - object - `data` Merchant[], required - `id` string, required: A unique identifier assigned to each Merchant. - `name` string, required: **Must be globally unique. We recommend adding a suffix, for example `Acme 123456`.** The official name of the Merchant as recognized in transactions and communications. This name is used for display purposes and may be the company's trade name or a derived nickname. - `shortName` string: A shorter version of the Merchant's name. When creating a 3D Secure session that references this Merchant by ID, `shortName` is used in place of `name` if `name` exceeds the 40-character limit imposed by the 3D Secure specification. - `website` string, required: The official website URL of the Merchant. The domain must use a valid IANA top-level domain. See https://data.iana.org/TLD/tlds-alpha-by-domain.txt - `business` object, required: The business details of the Merchant. - `legalName` string, required: The legal name under which the Merchant's business is registered. - `address` Address, required - `line1` string, required: The first line of the address. - `line2` string: The second line of the address. - `city` string, required: The city where the address is located. - `state` string, iso-3166-2-subdivision: The state or province code. Required when `country` is `us`, `ca`, or `au`. - `postalCode` string, required: The postal code of the address. - `country` string, iso-3166-1-alpha-2, required: The country where the address is located. - `categoryCode` string, required: The 4-digit Merchant Category Code (MCC). - `networkTokens` MerchantNetworkTokenStatus, required - `enrolment` object[], required: An array detailing the Merchant's enrollment status for network token issuance across different card brands. - `cardBrand` 'visa' | 'mastercard' | 'american-express' | 'discover' | 'diners-club' | 'jcb' | 'unionpay', required: The card brand associated with the payment card. - `tokenRequestorIdentifier` string, nullable: The unique Token Requestor Identifier (TRID) associated with the Merchant for the specific card brand. This identifier is used when creating Network Tokens for the Merchant. - `status` 'active' | 'inactive', required: The current stage of the Merchant's enrolment process for network token issuance with the specified card brand. - `applePay` MerchantApplePay, required - `domains` object[], required: The domains the Merchant has enrolled with Apple Pay and the status of the enrollment. - `merchantUuid` string, required: The ID of the Merchant the domain is enrolled for. - `domain` string, required: The top-level domain name of the Merchant's website. - `status` 'active' | 'pending' | 'failed', required: The current status of the Merchant's Apple Pay enrollment for the specified domain. `active` means the Merchant is fully enrolled and can accept Apple Pay payments on the domain. - `preChargebackAlerts` MerchantPreChargebackAlerts: The Merchant's pre-chargeback alert enrolments, returned on Merchant responses when pre-chargeback alerts have been configured. - `enrolments` object[], required: The merchant's enrolments with Ethoca and/or Verifi RDR. - `type` 'ETHOCA_ALERT' | 'VERIFI_RDR', required: The enrolment network. - `status` 'PENDING' | 'ACTIVE' | 'ACTION_REQUIRED' | 'CANCELLED', required: The enrolment status. It can take 2–10 days to move from `PENDING` to `ACTIVE`. - `ethocaAlert` object: Ethoca alert enrolment details. Present when `type` is `ETHOCA_ALERT`. - `descriptors` object[]: The billing descriptors enrolled for Ethoca alerts. - `descriptor` string, required: The billing descriptor matched against transactions. - `matchType` 'STARTS_WITH' | 'EXACT_MATCH', required: How the descriptor is matched against transactions. - `status` string: The descriptor enrolment status. - `verifiRdr` object: Verifi RDR enrolment details. Present when `type` is `VERIFI_RDR`. - `bin` string: The Bank Identification Number (BIN) associated with the Merchant. Must be exactly 6 digits. - `caid` string: The Card Acceptor ID (CAID) associated with the Merchant. Must be exactly 15 alphanumeric characters. - `arns` string[]: The Acquirer Reference Numbers (ARNs) enrolled. - `contact` MerchantContact: The business contact details of the Merchant. Visa needs `phoneNumber` and `name` to enroll the Merchant for Network Retry Signals. - `phoneNumber` string: The business phone number of the Merchant. Up to 20 characters, with at least seven digits. It can contain a leading `+`, spaces, dots, dashes, and parentheses. - `email` string, email: The email address of the business contact. - `name` object: The name of the business contact. Both `firstName` and `lastName` are required when `name` is sent. - `firstName` string, required: The first name of the business contact. - `lastName` string, required: The last name of the business contact. - `createdAt` integer, required: The exact time, in epoch milliseconds, when this Merchant was created. - `updatedAt` integer: The exact time, in epoch milliseconds, when this Merchant was last updated. - `pageSize` integer, required: The number of Merchants retrieved per page. - `nextPage` integer, nullable, required: The next page number to retrieve. If there are no additional Merchants, this will be `null`. - `total` integer, required: The total count of all Merchants, after any filters. ## Changes - **2026-11-06** `8d0ca833fa04`: 22 info - added the optional property `data/items/contact` to the response with the `200` status - added the optional property `data/items/preChargebackAlerts` to the response with the `200` status - added the optional property `data/items/shortName` to the response with the `200` status - the response property `data/items/applePay` became required for the status `200` - …18 more - **2026-04-17** `5e1eb58d42d5`: 1 warning, 6 info - removed the optional property `merchants` from the response with the `200` status - added the new optional `query` request parameter `pageSize` - added the new optional `query` request parameter `q` - added the required property `data` to the response with the `200` status - …3 more - **2025-11-18** `30ea25af4354`: 4 warning, 7 info - removed the optional property `merchants/items/networkTokens/enrolment/items/tokenRequestorId` from the response with the `200` status - added the new `active` enum value to the `merchants/items/applePay/domains/items/status` response property for the response status `200` - added the new `failed` enum value to the `merchants/items/applePay/domains/items/status` response property for the response status `200` - added the new `pending` enum value to the `merchants/items/applePay/domains/items/status` response property for the response status `200` - …7 more - **2025-06-23** `c3d154b940fb`: 1 info - endpoint added [Operation history](https://skmtc.dev/evervault/apis/evervault-api/changes/payments/merchants/get.md) --- [API](https://skmtc.dev/evervault/apis/evervault-api.md) - [All operations](https://skmtc.dev/evervault/apis/evervault-api/llms.txt) - [OpenAPI document](https://skmtc.dev/evervault/apis/evervault-api/revisions/8d0ca833fa04?raw)