Create upper usage group

Usage groups control the services for which a card can be used. For example, in ATMs, for e-commerce, and for contactless purchases. An upper usage group is a group with the maximum allowed authorisation types. You can also create other usage groups that can be used as default groups for card products.

Use case

Here we will create an upper usage group which allows all the authorisation types.

Use case data	API parameters with values
Usage group name	"usageGroupName": "UPPER_USAGE_01"
Service codes (Allowed authorisation types)	"serviceCodes": [ "00", //Purchase "0C", //Contactless "0A", //E-commerce "09", //Cashback "01", //Cash "30", //Balance "39", //Statement "20", //Refund "21", //Deposit "28" //Money receive ]

Sample API call

To create the upper usage group, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/usage-group

See more about the create upper usage group endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "usageGroupName": "UPPER_USAGE_01",
  "upperUsageGroup": true,
  "tenantCode": "MB",
  "serviceCodes": [
        "00",
        "0C",
        "0A",
        "09",
        "01",
        "30",
        "39",
        "20",
        "21",
        "28"
  ]
}

cURL

curl -X 'POST' \
  'https://card-api.sandbox.tuumplatform.com/api/v1/usage-group' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMjFUMTM6NDU6MzEiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODczNTUxMzF9.xCetkNcdOQfW06ZG8AmKWimdjPULY5usMRM8NCBxdxw' \
  -H 'Content-Type: application/json' \
  -d '{
  "usageGroupName": "UPPER_USAGE_01",
  "upperUsageGroup": true,
  "tenantCode": "MB",
  "serviceCodes": [
        "00",
        "0C",
        "0A",
        "09",
        "01",
        "30",
        "39",
        "20",
        "21",
        "28"
  ]
}'

If you are not creating an upper usage group, then you must link to an upper usage group as shown below:

{
  "limitGroupName": "USAGE_GROUP",
  "upperLimitGroup": false,
  "upperLimitGroupName": "UPPER_USAGE_01",
  ...
}

Sample response

Below you will find the response to the sample request:

Reponse

{
  "errors": null,
  "validationErrors": null,
  "data": null
}

Result

We have now created an upper usage group called UPPER_USAGE_01 which we can assign to card products. Similarly, you can create non-upper usage groups.