Creating a Recipient List

According to the Central Bank's PIX limits regulation, it is possible to create a recipient list that will use the same differentiated limit.

To request the creation of a recipient list for an account, simply send a Limit type object to the following endpoint:

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

{
    "limit": {
        "pix": {
            "transaction": [
                {
                    "start_time": "06:00:00-03:00",
                    "amount": 60000
                },
                {
                    "start_time": "20:00:00-03:00",
                    "amount": 60000
                }
            ]
        }
    }
}

Which will return the following response:

{
    "event_date": "2019-10-01T10:37:25-03:00"
}

name	type	description
event_date	string (ISO 8601)	Date and time of the Recipient List creation

Adding a New Recipient to the Recipient List

To add a new recipient to a previously created recipient list, simply make the following request:

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

{
    "document_number": "123.456.789-10"
}

Which will return the following response:

{
    "recipient_id": "c7a79970-b558-4425-998a-5cd6747c1c90",
    "analysis_status": "automatically_approved",
    "client_notification_status": "awaiting_notification_period",
    "recipient_status": "created",
    "event_date": "2019-10-01T10:37:25-03:00"
}

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

For a better understanding of the return statuses, access status dynamics.

Removing a Recipient

To remove a specific recipient from an account, simply send a DELETE request to the following address:

DELETE https://api.caas.qitech.app/limits/account/{account_id}/recipient_list/recipient/{recipient_id}

Editing the Limits of a Recipient List

To request the modification of the recipient limits for a given account, simply send the following request:

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

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

Which will return the following response:

{
    "limit_update_request_id": "c7a79970-b558-4425-998a-5cd6747c1c90",
    "analysis_status": "automatically_approved",
    "client_notification_status": "awaiting_notification_period",
    "recipient_status": "created",
    "event_date": "2019-10-01T10:37:25-03:00"
}

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