Managing Card Usage Groups

Card usage groups are set up in the GPS system, based on the information you provided in your Product Setup Form (PSF). At the time of card creation, default groups for your card program are applied to the card. After card creation, you can update these with your own groups.

This section provides instructions on how to:

📘

Note

You cannot change card usage group settings via the REST API. If you want to change the settings of your usage groups, contact your Implementation Manager.

Listing Card Groups in a Card Program

This API returns a list of all the card groups in your program. You can retrieve the card groups list by making a GET request to the endpoint. For example:

{{base-url}}/groups

A successful response will return a HTTP 200 response code, together with a list of card usage groups in the payload. For example:

[
    {
        "groupType": "AuthFeeGroup",
        "groups": [
            {
                "id": 786,
                "code": "GPS-TEST",
                "description": "GPS-TEST"
            },
            {
                "id": 1063,
                "code": "GPS-TEST-1",
                "description": "GPS TEST"
            },
            {
                "id": 1137,
                "code": "GPS-TEST-2",
                "description": "GPS Tran Test"
            },
            {
                "id": 1202,
                "code": "NEW-TEST-1",
                "description": "MENA TEST 1"
            },
            {
                "id": 1221,
                "code": "GPSTEST008",
                "description": "GPS Test 08"
            }
        ]
    }
]

👍

API Explorer

See the List card control groups endpoint for more information.

Changing the Card Groups Linked to a Card

This API enables you to change the card groups linked to a specified card. You can update the card groups linked to a card by making a PUT request to the endpoint. For example:

{{base-url}}/cards/{{publicToken}}/groups

The PUT body should include the group IDs that you want to update. These IDs must be valid IDs for your program - you can use the List Card Control Groups API to retrieve the full list of valid IDs available. The below is an example of what the body could look like.

{
    "ControlGroups": {
        "AuthFeeGroup": 1221     
    }
}

A successful response will return a HTTP 200 response code and the following payload:

{
    "limitsGroup": 1051,
    "usageGroup": 374,
    "recurringFeeGroup": 0,
    "webServiceFeeGroup": 0,
    "authFeeGroup": 1221,
    "mccGroup": 0,
    "cardLinkageGroup": 0,
    "calendarGroup": 0,
    "fxGroup": 0,
    "paymentTokenUsageGroup": 0
}

👍

API Explorer

See the Update Card Control Groups endpoint for more information.


Did this page help you?