Add Merchant to Allow List - Field Descriptions
The following page details each of the fields received in the response when using the Add Merchant to Allow List endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when adding a merchant to an Allow list.
| Field | Description | Minimum Length | Maximum Length | Mandatory |
|---|---|---|---|---|
| merchantIds | The unique merchant identifier to be added to the Allow list. | 1 | 50 | Yes |
Response Fields
A successful response for the Add Merchant to Allow List endpoint will return a 200 response.
| Field | Description |
|---|---|
| listId | The unique identifier for the merchant list. |
| listName | The name of the merchant list. |
| listType | The type of merchant list. This will either be Allow or Disallow. |
| isActive | Whether the list is active. |
| schemeId | The unique identifier of the scheme the merchant list is associated with. |
| schemeName | The name of the scheme the merchant list is associated with. |
| institutionId | The unique identifier of the institution the merchant list is associated with. |
| institutionName | The name of the institution. |
| cardAcceptors | The Card Acceptor ID (Also known as Merchant ID) of the merchants associated with the merchant list. |
Updated 16 days ago