Listar protestos

A listagem de protestos retornará todos os protestos em cartório de boletos da carteira que se enquadrarem nos query parameters enviados na request.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/protests

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36

Query parameters

Campo	Tipo	Descrição	Caracteres
protest_key	uuidv4	Chave única de identificação do protesto, no formato uuid v4	36
request_control_key	uuidv4	Chave única de identificação da request, no formato uuid v4	36
protest_status	string	Status do protesto	Enumeradores protest_status
bank_slip_key	uuidv4	Chave única de identificação do boleto, no formato uuid v4	36
protocol_number	string	Número do protocolo	36
protocol_date	string	Data do protocolo (formato "AAAA-MM-DD")	10
page_size	integer	Tamanho da página	-
from_date	string	Data inicial (formato "AAAA-MM-DD")	10
to_date	string	Data final (formato "AAAA-MM-DD")	10

Enumeradores protest_status

Enumerador	Descrição
accepted	Aceito, mas ainda não enviado para os cartórios de protesto de títulos
submitted	Enviado para o cartório
cancellation_requested	Sustação de protesto solicitada
cancelled	Envio cancelado, ou protesto sustado
rejected	Pedido de protesto rejeitado
at_notary_office	No cartório de protesto, em período de tríduo
paid_at_notary_office	Título pago em cartório
protested	Título protestado e baixado
removal_requested	Título já protestado, com cancelamento solicitado
removed	Protesto cancelado

Response

STATUS

200

Response Body

{
    "data": [
        {
            "protest_key": "ad44278d-7cf1-4ac7-9545-410649a47dde",
            "request_control_key": "7e40ebab-f00c-4dbf-88be-ff34434ab358",
            "protest_status": "protested",
            "bank_slip_key": "7bf086ac-f520-4498-abd4-5a7d2173fd1c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000004",
            "protocol_date": "2024-11-27",
            "notary_office": {
                "city": "SAO PAULO",
                "uf": "SP"
            }
        },
        {
            "protest_key": "0087f425-5e54-4b4c-ab17-a57bc80f223a",
            "request_control_key": "c413cedc-78ac-4deb-ace8-d94d4e98197c",
            "protest_status": "at_notary_office",
            "bank_slip_key": "e345c0b3-012b-4a4b-9d6b-6981f40b1a7c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000016",
            "protocol_date": "2024-12-10",
            "notary_office": {
                "city": "RIO DE JANEIRO",
                "uf": "RJ"
            }
        },
        {
            "protest_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
            "request_control_key": "59515878-50e9-466b-b40d-1aac3939c3fd",
            "protest_status": "accepted",
            "bank_slip_key": "7d3d262b-9b55-44cd-8355-2f00d5b1d142",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
data *	object array	Protestos	Objeto protest
pagination *	object	Informações de paginação	Objeto pagination

Objeto protest

Campo	Tipo	Descrição	Caracteres
protest_key *	uuidv4	Chave única de identificação do protesto no formato uuid v4	36
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
protest_status *	string	Status do protesto	Enumeradores protest_status
bank_slip_key *	uuidv4	Chave única de identificação do boleto no formato uuid v4	36
requester_profile_code *	string	Código único de identificação da carteira	10
protest_type *	string	Tipo de protesto	Enumeradores protest_type
protocol_number	string	Número do protocolo	10
protocol_date	string	Data do protocolo (formato "AAAA-MM-DD")	10
notary_office	object	Dados do cartório de protesto	Objeto notary_office

Objeto pagination

Campo	Tipo	Descrição	Caracteres
current_page *	integer	Página atual	-
rows_per_page *	integer	Itens por página	-

Enumeradores protest_type

Enumerador	Descrição
protest	Protesto comum
bankruptcy_protest	Protesto falimentar

Enumeradores protest_status

Enumerador	Descrição
accepted	Aceito, mas ainda não enviado para os cartórios de protesto de títulos
submitted	Enviado para o cartório
cancellation_requested	Sustação de protesto solicitada
cancelled	Envio cancelado, ou protesto sustado
rejected	Pedido de protesto rejeitado
at_notary_office	No cartório de protesto, em período de tríduo
paid_at_notary_office	Título pago em cartório
protested	Título protestado e baixado
removal_requested	Título já protestado, com cancelamento solicitado
removed	Protesto cancelado

Objeto notary_office

Campo	Tipo	Descrição	Caracteres
city *	string	Cidade do cartório de protesto	-
uf *	string	Estado (UF) do cartório de protesto	2

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It was not possible to consult the source account at this time. Please try again in a few minutes.	Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BKS000012	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada