Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Merchants

Add Merchant to Allow List

post/api/v1/groups/allow-merchant/{listId}

Path parameters

listIdinteger required

The ID for the allow list you want to add a merchant to

Request body

merchantIdsstring[] nullable

The ids for the merchants being added to the list.

Response

Success

listIdinteger

ID of the Card Acceptor list.

listNamestring nullable

Name of the Card Acceptor list.

listTypestring nullable

Type of the List (Allow or Disallow).

isActiveboolean

boolean value - true if the list is active.

schemeIdinteger nullable

ID of the Scheme that the list is associated with.

schemeNamestring nullable

Name of the associated scheme.

institutionIdinteger

ID of the associated Institution.

institutionNamestring nullable

Name of the associated Institution.

cardAcceptorsstring[] nullable

List of Card Acceptors in the List.

Example response

{
  "listName": "Approved Merchants",
  "listType": "Disallow",
  "isActive": true,
  "schemeId": 1050,
  "schemeName": "Example Scheme",
  "institutionId": 21,
  "institutionName": "Example Institution"
}