Card limits¶

Card limits related functionalities allow the DAPI user to do the following:

• to get general information about the available card limits,
• to get information about effective group limits and individual limits for a specific card,
• to get information about how much of a specific card limit has been used (either as an amount or a count),
• to change individual limits as amount, count or switch for the specific limit.

There are two basic limit categories: group limits and individual limits. Group limits are initially set at the time of a card product's setup in the Card Management System by DECTA in accordance with the card issuer requirements. Accordingly, for the DAPI user, group limits are just informative with no possibility to change them via API. DAPI users can only change individual card limits for a specific card up to the group limit's value or above it where applicable depending on the access rights assigned by DECTA. If the individual card limit's values have been set up for a specific card, then they will always work instead of group limit values.

Set of available card limits to manage:

• ATM/POS cash withdrawal limits (amount and count);
• Card present (POS) transaction limits (amount and count);
• Card-not-present transaction limits (amount and count);
• Card spending limits (in any device) (amount and count)
• Single/ Daily / Monthly limits;
• Contactless limit amount;
• Card spending restrictions by the merchant’s country (in any device).

Any of the card limit endpoints require one of the following access rights:

• with no restrictions - means that the user can set an individual limit's value up to or above group limit value (not applied for switch (true/false) limits);
• with restrictions - means that the user isn’t allowed to set an individual limit's value above the group limit value (not applied for switch (true/false) limits).

To start using the endpoints, please contact your Account manager or Project manager.

Get limits data by card ¶

If you want to receive information about all card limits which are effective for the particular card, you should use GET/v1/api/limits/{ppan} This endpoint returns group limit values and individual limit values. If the individual limit value is not set, then the endpoint returns only group limit values. For the rules limits with switch option (true/false) individual limit is set within the rules object.

Examples¶

SL_LIMIT0CD0000000000000000001 - Daily spending count total¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
            "id": "SL_LIMIT0CD0000000000000000001",
            "key": "123456ABCDEF1234",
            "group": {
                "value": "5"
            }
        }
    ]
}

This response indicates that no individual limit is set for this specific card; it relies solely on the group limit value of 5. As a result, if a cardholder attempts to use their card more than 5 times in a day, this group limit will be triggered, and any subsequent authorization requests will be declined.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
            "id": "SL_LIMIT0CD0000000000000000001",
            "key": "123456ABCDEF1234",
            "individual": {
                "value": "10"
            },
            "group": {
                "value": "5"
            }
        }
    ]
}

This response indicates that an individual limit of 10 is set for this specific card, meaning that group limit will be ignored by the card authorization filtering module. As a result, if a cardholder attempts to use their card more than 10 times in a day, this individual limit will be triggered, and any subsequent authorization requests will be declined.

SL_LIMIT0S00000100000000000001 - Single spending geo switch¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0S00000100000000000001",
          "key": "123456ABCDEF1234",
          "group": {
              "value": "0"
          }
        }
    ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0S00000100000000000001",
          "key": "123456ABCDEF1234",
          "group": {
              "value": "0"
          },
          "rules": [{
                    "values": ["LV", "US"],
                    "individual": {
                        "value": "1"
                    }
                }
            ]
        }
    ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0S00000100000000000001",
          "key": "123456ABCDEF1234",
          "group": {
              "value": "1"
          },
          "rules": [{
                    "values": ["LT", "MT"],
                    "individual": {
                        "value": "0"
                    }
                }
            ]
        }
    ]
}

Card limit change ¶

If you want to set or change individual limits for the selected card, then you should use PATCH/v1/api/limits/{ppan}. PATCH replaces the full state you submit for each limit.id. Anything you omit from rules[] is deleted. To clear the individual limit, send it as an empty object rather than omitting it.

The individual limit can be deleted using empty individual object as follows:

• rules: [] OR missing → deletes all rules
• individual: {} OR missing → deletes the individual limit value
• removing one entry from rules[].values → deletes just that value

Examples of removing individual limits¶

1
2
3
4
5
6
7
8
9

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0CD0000000000000000001",
          "key": "123456ABCDEF1234",
          "individual":{},
        }
    ]
}

1
2
3
4
5
6
7
8
9

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0S00000100000000000001",
          "key": "123456ABCDEF1234",
          "rules": []
        }
    ]
}

Example of the request when rules individual values array can be updated by deleting the previous individual limit values¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
    "ppan": "123456ABCDEF1234",
    "limits": [{
          "id": "SL_LIMIT0S00000100000000000001",
          "key": "123456ABCDEF1234",
          "rules": [
                {
                    "individual": {
                        "value": "1"
                    },
                    "values": [
                        "US"
                    ]
                }
            ]
        }
    ]
}

As a result of this request, restrictions will be enforced for merchants located in the United States (US), provided the group limit value is set to 0 (meaning no general geo-restrictions are applied).

Get limits reference data ¶

If you want to receive information about all card limits which are effective for the particular card, you should use GET /v1/api/limits/{ppan}. This endpoint returns group limit values and individual limit values. If the individual limit value is not set, then the endpoint returns only group limit values. For the rules limits with switch option (true/false) individual limit is set within the rules object.

Card limit Usage ¶

If you want to retrieve information about how much of a specific card limit has been used (either as an amount or a count), use the endpoint GET /v1/api/limits/{ppan}/used. The endpoint returns accumulated usage values for the corresponding limit.

To determine the remaining value of a card limit, you need to combine data from two endpoints: the configured limit value (group or individual) from GET /v1/api/limits/{ppan} minus the accumulated usage value from GET /v1/api/limits/{ppan}/used.

Important:¶

• Group limits and individual limits are set in the card account currency.
• A DAPI user can set only those individual limits that are defined within the group limits.
• Card limits set via API replace CMS calendar limits disabling their further use.
• A single request can include changes to several individual limits.
• The limit value should be sent according to the corresponding limit type. If the limitation is for the authorization count, the value should be in minor units. If the limitation is for the authorization amount, the value should be expressed with a dot (.) as the decimal separator, according to the card currency.
• Limits are calculated using the original authorization amount converted into the card account currency.
• To delete an individual limit value, the object should be left empty.
• If the authorization amount of a contactless transaction exceeds the single contactless transaction limit, the cardholder must enter a PIN to complete the authorization.
• For new cards and replaced cards it is possible to set individual limits after ~ 10 min the card has been created (after the card order is completed). For renewed cards (with a new PPAN), individual limits can be set only after the embossing file process. The group limits are working strictly after card was created.
• Individual limits are not inherited to renewed cards with a new PPAN or replaced cards, except for the renewed cards with the same PPAN.
• The meaning of group limit values for Single spending geo switch limit:
  • 0 – All countries are on the allowlist (geo-restrictions are disabled), meaning the card can be used globally.
  • 1 – All countries are on the blacklist (geo-restrictions are enabled), meaning card transactions are blocked globally.
• To include several countries in rules object to individual limits, the requested countries should be included in one array.