Create upper limit group

Limit groups are groups that define the limits for cash, e-commerce, and purchase services. An upper limit group should contain the maximum allowed limits that will be assigned to card products. You can also create other limit groups that can be used as the default groups for card products.

Limit groups must exist before you can create card products.

Use case

In this scenario, we will create an upper limit group with default and maximum limits for the cash and e-commerce services.

Use case data	API parameters with values
Limit group name	"limitGroupName": "UPPER_LIMIT_01"
Limits for the cash service	{ "limitCode": "CASH", "transactionDefaultAmount": 1000, "transactionMaxAmount": 1000, "dailyDefaultAmount": 1000, "dailyMaxAmount": 1000, "monthlyDefaultAmount": 1000, "monthlyMaxAmount": 1000, "currencyCode": "EUR" }
Limits for the e-commerce service	{ "limitCode": "ECOMMERCE", "transactionDefaultAmount": 1500, "transactionMaxAmount": 3000, "dailyDefaultAmount": 3000, "dailyMaxAmount": 5000, "monthlyDefaultAmount": 7000, "monthlyMaxAmount": 10000, "currencyCode": "EUR" }

Sample API call

To create the limit group, use the following endpoint:

https://card-api.sandbox.tuumplatform.com/api/v1/limit-groups

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

Sample request

The sample request body is as follows:

JSON

{
    "limitGroupName": "UPPER_LIMIT_01",
    "upperLimitGroup": true, // This group is an upper limit group
    "tenantCode": "MB",
    "limits": [
        {
            "limitCode": "CASH", // Allowed values are "CASH", "PURCHASE", "ECOMMERCE"
            "transactionDefaultAmount": 1000,
            "transactionMaxAmount": 1000,
            "dailyDefaultAmount": 1000,
            "dailyMaxAmount": 1000,
            "monthlyDefaultAmount": 1000,
            "monthlyMaxAmount": 1000,
            "currencyCode": "EUR"
        },
        {
            "limitCode": "ECOMMERCE",
            "transactionDefaultAmount": 1500,
            "transactionMaxAmount": 3000,
            "dailyDefaultAmount": 3000,
            "dailyMaxAmount": 5000,
            "monthlyDefaultAmount": 7000,
            "monthlyMaxAmount": 10000,
            "currencyCode": "EUR"
        }
    ]
}

cURL

curl -X 'POST' \
  'https://card-api.sandbox.tuumplatform.com/api/v1/limit-groups' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMjBUMTQ6MjQ6MDciLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODcyNzEwNDd9.xkIxfzGA0dK7XPD9w92Ws5vOZGE3RqLxTfDeMgMcX9I' \
  -H 'Content-Type: application/json' \
  -d '{
  "limitGroupName": "UPPER_LIMIT_001",
  "upperLimitGroup": true,
  "tenantCode": "MB",
  "limits": [
    {
      "limitCode": "CASH",
      "transactionDefaultAmount": 1000,
      "transactionMaxAmount": 1000,
      "dailyDefaultAmount": 1000,
      "dailyMaxAmount": 1000,
      "monthlyDefaultAmount": 1000,
      "monthlyMaxAmount": 1000,
      "currencyCode": "EUR"
    },
    {
      "limitCode": "ECOMMERCE",
      "transactionDefaultAmount": 1500,
      "transactionMaxAmount": 3000,
      "dailyDefaultAmount": 3000,
      "dailyMaxAmount": 5000,
      "monthlyDefaultAmount": 7000,
      "monthlyMaxAmount": 10000,
      "currencyCode": "EUR"
    }
  ]
}'

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

{
  "limitGroupName": "LIMIT_GROUP",
  "upperLimitGroup": false,
  "upperLimitGroupName": "UPPER_LIMIT_01",
  ...
}

Sample response

Below you will find the response to the sample request:

Response

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

Result

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