Criando uma lista de beneficiários

Conforme regulamentação de limites PIX do Banco Central, é possível realizar a criação de uma lista de beneficiários que utilizarão o mesmo limite diferenciado.

Para solicitar a criação de uma lista de beneficiários para uma conta, basta enviar um objeto do tipo Limite ao seguinte 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
                }
            ]
        }
    }
}

Que apresentará o seguinte retorno:

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

nome	tipo	descrição
event_date	string (ISO 8601)	Data e hora da criação da Lista de Beneficiários

Adicionando um novo Beneficiário a lista de Beneficiários

Para adicionar um novo beneficiário a uma lista de beneficiários previamente criada, é necessário apenas realizar a seguinte requisição:

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

{
    "document_number": "123.456.789-10"
}

Que apresentará o seguinte retorno:

{
    "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"
}

nome	tipo	descrição
recipient_id	string	Identificador único do Beneficiário desta Proposta de Modificação de Limite
analysis_status	string	Enumerador do analysis_status da proposta
client_notification_status	string	Enumerador do client_notification_status da proposta
recipient_status	string	Enumerador do recipient_status da proposta
event_date	string (ISO 8601)	Data e hora da criação da Proposta de Modificação de Limite

Para um melhor entendimento dos status de retorno acesse dinâmica de status .

Removendo um Beneficiário

Para remover um beneficiário específico para uma conta, basta enviar uma requisição do tipo DELETE para o seguinte endereço:

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

Editando os Limites de uma lista de Beneficiários

Para solicitar a alteração dos limites de beneficiário de uma dada conta, basta realizar o envio da seguinte requisição:

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
            }
        ]
    }
}

Que apresentará o seguinte retorno:

{
    "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"
}

nome	tipo	descrição
recipient_id	string	Identificador único do Beneficiário desta Proposta de Modificação de Limite
analysis_status	string	Enumerador do analysis_status da proposta
client_notification_status	string	Enumerador do client_notification_status da proposta
recipient_status	string	Enumerador do recipient_status da proposta
event_date	string (ISO 8601)	Data e hora da criação da Proposta de Modificação de Limite