The GetLimits endpoint enables you to retrieve the velocity limits associated with a specific card.

You can retrieve a card's limits by making a GET request to the endpoint. For example:

{{base-url}}/cardlimits/api/v1/get_limit

Request Fields

The table below outlines the fields that can be included in the request body when calling the 'get limit' endpoint.

Field	Description	Minimum Length	Maximum Length	Type	Required
token	The card’s public token.	9/16	9/16	Number	Yes
product_id	Unique ID of the product.	1	10	Number	Yes

Example Request

Below is an example of a get card limit request.

{
    "product_id": 1209,
    "token": 223568671
}

Response Fields

If successful, a 200 response is returned with the limits set on the card and additional information. A successful response will return the following details:

Field	Description	Min Length	Max Length	Type	Status
public_token	The card’s public token.	9	9	Number	Mandatory
category	Categories are: • POS • Cash • Pay-In •Pay-Out			String	Mandatory
subcategory	Subcategories are: Contactless (Applicable only for POS category)			String	Optional
maximumpertransaction	The maximum allowable spend or load for each transaction.	1	(14,4)	Number	Mandatory
minimumpertransaction	The minimum allowable spend or load for each transaction.	1	(14,4)	Number	Mandatory
dailylimit	The maximum amount that can be spent or loaded within a single calendar day.	1	(14,4)	Number	Mandatory
dailyfrequency	The maximum number of transactions or loads permitted within a single calendar day.	1	10	Integer	Mandatory
accumlimit1	The first accumulated limit allowed over the accumulated period defined in accumperiod1. For example, if the accumulated limit for a POS is set at 15,000 and the accumulation period is defined as 30 days, the cardholder will be permitted to spend a maximum of 15,000 within that 30-day timeframe.	1	(14,4)	Decimal	Mandatory
accumfrequency1	The maximum number of transactions or loads permitted within the first accumulation period. The number of days in the accumulation period is determined by the value of accumperiod1. For example, if the accumulated frequency for POS transactions is set to 100 and the accumperiod1 is established at 30 days, the cardholder will be limited to a maximum of 100 POS transactions within that 30-day timeframe.	1	10	Integer	Mandatory
accumperiod1	The first date range over which the accumulated limit applies. For example, if the accumulated period is configured to 30 days, the limits defined in accumfrequency1 and accumlimit1 will be applicable for a 30-day duration.	1	4	Integer	Mandatory
accumlimit2	The second accumulated limit allowed over the accumulated period defined in accumperiod2.	1	(14,4)	Decimal	Mandatory
accumfrequency2	The maximum number of transactions or loads permitted within the accumulation period. The number of days in the accumulation period is determined by the value of accumperiod2.	1	10	Integer	Mandatory
accumperiod2	The second date range over which the accumulated limit applies. For example, if the second accumulated period is configured to 365 days, the limits defined in accumfrequency2 and accumlimit2 will be applicable for that entire 365-day duration.	1	4	Integer	Mandatory

Example Response

Below is an example of a successful 200 response.

{
    "public_token": "223344559",
    "limits_with_counter": [
        {
            "category": "Cash",
            "limits": {
                "maximumpertransaction": "70.0",
                "minimumpertransaction": "0.0",
                "dailylimit": "100.0",
                "dailyfrequency": 10,
                "accumlimit1": "100.0",
                "accumfrequency1": 100,
                "accumperiod1": 30,
                "accumlimit2": "1000.0",
                "accumfrequency2": 1000,
                "accumperiod2": 36
            },
            "counters": {
                "daily_count": 0,
                "daily_amount": 0.0,
                "accumlimit1_count": 0,
                "accumlimit1_amount": 0.0,
                "accumlimit2_count": 0,
                "accumlimit2_amount": 0.0
            },
            "subcategories": []
        },
        {
            "category": "Pos",
            "limits": {
                "maximumpertransaction": "0.2",
                "minimumpertransaction": "0.0",
                "dailylimit": "0.234",
                "dailyfrequency": 10,
                "accumlimit1": "1000.0",
                "accumfrequency1": 100,
                "accumperiod1": 30,
                "accumlimit2": "2000.0",
                "accumfrequency2": 12789,
                "accumperiod2": 365
            },
            "counters": {
                "daily_count": 0,
                "daily_amount": 0.0,
                "accumlimit1_count": 0,
                "accumlimit1_amount": 0.0,
                "accumlimit2_count": 0,
                "accumlimit2_amount": 0.0
            },
            "subcategories": [
                {
                    "subcategory": "Contactless",
                    "limits": {
                        "maximumpertransaction": "0.1",
                        "minimumpertransaction": "0.0",
                        "dailylimit": "0.1",
                        "dailyfrequency": 10,
                        "accumlimit1": "10.0",
                        "accumfrequency1": 10,
                        "accumperiod1": 10,
                        "accumlimit2": "10.0",
                        "accumfrequency2": 1000,
                        "accumperiod2": 100
                    },
                    "counters": {
                        "daily_count": 0,
                        "daily_amount": 0.0,
                        "accumlimit1_count": 0,
                        "accumlimit1_amount": 0.0,
                        "accumlimit2_count": 0,
                        "accumlimit2_amount": 0.0
                    }
                }
            ]
        },
        {
            "category": "Pay_in",
            "limits": {
                "maximumpertransaction": "10.0",
                "minimumpertransaction": "0.0",
                "dailylimit": "100.0",
                "dailyfrequency": 10,
                "accumlimit1": "1000.0",
                "accumfrequency1": 100,
                "accumperiod1": 30,
                "accumlimit2": "1000.0",
                "accumfrequency2": 1000,
                "accumperiod2": 367
            },
            "counters": {
                "daily_count": 0,
                "daily_amount": 0.0,
                "accumlimit1_count": 0,
                "accumlimit1_amount": 0.0,
                "accumlimit2_count": 0,
                "accumlimit2_amount": 0.0
            },
            "subcategories": []
        },
        {
            "category": "Pay_out",
            "limits": {
                "maximumpertransaction": "10.0",
                "minimumpertransaction": "0.0",
                "dailylimit": "100.0",
                "dailyfrequency": 10,
                "accumlimit1": "1000.0",
                "accumfrequency1": 100,
                "accumperiod1": 30,
                "accumlimit2": "1234567890.0",
                "accumfrequency2": 1000,
                "accumperiod2": 367
            },
            "counters": {
                "daily_count": 0,
                "daily_amount": 0.0,
                "accumlimit1_count": 0,
                "accumlimit1_amount": 0.0,
                "accumlimit2_count": 0,
                "accumlimit2_amount": 0.0
            },
            "subcategories": []
        }
    ]
}

📘
API Explorer
To view the endpoint in the API Explorer, see Get Limit.