Managing Card Usage Groups

Card usage groups are set up in the Thredd 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.

📘

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.

List Card Control Groups

The List Card Control Groups 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": "TEST",
                "description": "TEST"
            },
            {
                "id": 1063,
                "code": "TEST-1",
                "description": "TEST 1"
            },
            {
                "id": 1137,
                "code": "TEST-2",
                "description": "Tran Test"
            },
            {
                "id": 1202,
                "code": "NEW-TEST-1",
                "description": "MENA TEST 1"
            },
            {
                "id": 1221,
                "code": "TEST008",
                "description": "Test 08"
            }
        ]
    }
]

👍

API Explorer

See the List card control groups endpoint for more information.