Merchant Allow Lists

This section provides instructions on how to retrieve a merchant allow list, as well as add and remove merchants from lists.

Merchant lists enable you to control which merchants or merchant codes are blocked or allowed to use your service. This API enables you to manage merchant allow lists, which can then be assigned to a single card or multiple cards. Only merchant IDs added to the allow list will be approved by GPS at authorisation stage.

Retrieve Merchant Allow List

The Retrieve Merchant Allow List endpoint allows you to retrieve the merchant allow list for your program. You can retrieve the merchant allow list by making a GET request to the allow merchant endpoint. For example:

{{base-url}}/groups/allowmerchant

A successful response will return a HTTP 200 response code. Below is an example response:

[
    {
        "listId": 83,
        "listName": "list36",
        "listType": "Allow",
        "isActive": true,
        "schemeId": null,
        "schemeName": "",
        "institutionId": 142,
        "institutionName": "GPS INSTITUTION TEST",
        "cardAcceptors": [
            ""
        ]
    }

👍

API Explorer

See the Get Allowed Merchants endpoint.

Add Merchant to Allow List

The Add Merchant to Allow List endpoint allows you to add merchants to the allow list. You can do this by adding the List ID to the end of the Allow Merchant endpoint. For example:

{{base-url}}/groups/allowmerchant/{{AllowListID}}

The POST body should include the merchant IDs that you want to associate with the nominated allow list. The below is an example of what the body should look like.

{
    "merchantIds": [
        "Merchant5"
    ]
}

A successful response will return a HTTP 200 response code. Below is an example response:

{
    "listId": 86,
    "listName": "list80",
    "listType": "Allow",
    "isActive": true,
    "schemeId": null,
    "schemeName": "",
    "institutionId": 142,
    "institutionName": "GPS INSTITUTION TEST",
    "cardAcceptors": [
        "Merchant15",
        "Merchant19",
        "Merchant3",
        "Merchant4",
        "Merchant5",
        "Merchant7",
        "Merchant9"
    ]
}

👍

API Explorer

See the Add Merchant to Allow List endpoint.

Remove Merchant from Allow List

The Remove Merchant from Allow List endpoint allows you to remove a merchant from an allow list. You can do this by using the DELETE method and adding the List ID and Merchant ID to the end of the Allow Merchant endpoint. For example:

{{base-url}}/groups/allowmerchant/{{AllowListID}}/{{MerchantID}}

No body is required in the request. A successful response will return a HTTP 204 response code and the merchant will be removed from the allow list.

👍

API Explorer

See the Remove Merchant from Allow List endpoint.