New Limit Registration

To register a new limit, simply send an Account type object to the following endpoint:

POST https://api.caas.qitech.app/limits/account

Example

{
    "account_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
    "registration_date": "2019-12-20T15:23:12",
    "limit": {
        "pix": {
            "withdraw": [
                {
                    "start_time": "06:00:00-03:00",
                    "amount": 500000
                },
                {
                    "start_time": "20:00:00-03:00",
                    "amount": 300000
                }
            ],
            "change": [
                {
                    "start_time": "06:00:00-03:00",
                    "amount": 500000
                },
                {
                    "start_time": "20:00:00-03:00",
                    "amount": 300000
                }
            ],
            "transaction_natural_person": [
                {
                    "start_time": "06:00:00-03:00",
                    "amount": 500000
                },
                {
                    "start_time": "20:00:00-03:00",
                    "amount": 300000
                }
            ],
            "transaction_legal_person": [
                {
                    "start_time": "06:00:00-03:00",
                    "amount": 500000
                },
                {
                    "start_time": "20:00:00-03:00",
                    "amount": 300000
                }
            ]
        }
    }
}

All information exchanges for a registration use the following definition for this object. In some cases, to facilitate implementation and reduce data flow between parties, some information may be omitted.

name	type	description
account_id	string	Unique account identifier. It is essential that this number is unique for each request
registration_date	string (ISO 8601)	Registration date and time.
limit	limit	limit type object.

Limit Object

{
    "pix": {
        "withdraw": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ],
        "change": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ],
        "transaction": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ]
    }
}

This object represents the value limits applicable to different types of transactions at different times of the day, taking into account the division between daytime and nighttime periods.

The object is organized into three main categories (or limit types): "withdraw" (referring to PIX Withdrawal mode), "change" (referring to PIX Change mode), and "transaction" (referring to transactional PIX mode). Each category can contain a list of up to two dictionaries, each representing - respectively - the daytime and nighttime limit periods, describing the start time and the respective value limits to be applied for the mode.

Limit Window Structure:

name	type	description
start_time	string (ISO 8601)	Indicates the moment when the value limits for PIX transactions are applied. Pay attention to the correct configuration of the Limit Window start according to the time zone you intend to use.
amount	integer	Maximum limit value allowed for the mode in the period specified by "start_time" in cents of Brazilian reais.

Since, according to Central Bank guidelines, daytime PIX limit windows must start at 6AM, only the value "06:00:00-03:00" will currently be accepted for configuring the start_time of these windows.

Similarly, since nighttime PIX limit windows must start at 8PM or 10PM, only the values "20:00:00-03:00" and "22:00:00-03:00", respectively, will be accepted for configuring the start_time of these windows.

Usage Example: Let's assume the user is making a PIX transaction at 12:00:00-03:00. When consulting the object, we locate the "transaction" category (PIX Transaction). In this category, we find two dictionaries: the first starts at "06:00:00-03:00" and the second starts at "20:00:00-03:00". If the PIX transaction is made between these times, the maximum allowed value limit is 5,000.00 (five thousand) Brazilian reais, as specified in the first limit window.

However, if the transaction occurs after "20:00:00-03:00" and before the next start time (in this example, at 06:00 the next day), the maximum allowed value limit will be 3,000.00 (three thousand) Brazilian reais, as indicated in the second (nighttime) limit window.

Creating a Limit Modification Proposal

To request a limit modification, simply send a Limit type object to the following endpoint:

POST https://api.caas.qitech.app/limits/account/{account_id}/limit_update_request

Example

{
    "pix": {
        "withdraw": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ],
        "change": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ],
        "transaction_natural_person": [
            {
                "start_time": "06:00:00-03:00",
                "amount": 500000
            },
            {
                "start_time": "20:00:00-03:00",
                "amount": 300000
            }
        ]
    }
}

Which will return the following response:

{
    "limit_update_request_id": "5ce7fab5-8165-44a5-9b89-bb2d6d61e4f4",
    "analysis_status": "automatically_approved",
    "client_notification_status": "not_applicable",
    "limit_update_request_status": "applied",
    "event_date": "2019-10-01T10:37:25-03:00"
}

name	type	description
limit_update_request_id	string	Unique identifier for the Limit Modification Proposal
analysis_status	string	Enumerator for the proposal's analysis_status
client_notification_status	string	Enumerator for the proposal's client_notification_status
limit_update_request_status	string	Enumerator for the proposal's limit_update_request_status
event_date	string (ISO 8601)	Date and time of the Limit Modification Proposal creation