List protests

The protest listing will return all protests in notary offices for bank slips from the wallet that match the query parameters sent in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/protests

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36

Query parameters

Field	Type	Description	Characters
protest_key	uuidv4	Unique protest identification key, in uuid v4 format	36
request_control_key	uuidv4	Unique request identification key, in uuid v4 format	36
protest_status	string	Protest status	protest_status enumerators
bank_slip_key	uuidv4	Unique bank slip identification key, in uuid v4 format	36
protocol_number	string	Protocol number	36
protocol_date	string	Protocol date (format "YYYY-MM-DD")	10
page_size	integer	Page size	-
from_date	string	Start date (format "YYYY-MM-DD")	10
to_date	string	End date (format "YYYY-MM-DD")	10

protest_status enumerators

Enumerator	Description
accepted	Accepted, but not yet sent to the protest notary offices
submitted	Sent to notary office
cancellation_requested	Protest suspension requested
cancelled	Sending cancelled, or protest suspended
rejected	Protest request rejected
at_notary_office	At protest notary office, in triduum period
paid_at_notary_office	Title paid at notary office
protested	Title protested and settled
removal_requested	Title already protested, with cancellation requested
removed	Protest cancelled

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

Field	Type	Description	Characters
data *	object array	Protests	protest object
pagination *	object	Pagination information	pagination object

protest object

Field	Type	Description	Characters
protest_key *	uuidv4	Unique protest identification key in uuid v4 format	36
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format	36
protest_status *	string	Protest status	protest_status enumerators
bank_slip_key *	uuidv4	Unique bank slip identification key in uuid v4 format	36
requester_profile_code *	string	Unique wallet identification code	10
protest_type *	string	Protest type	protest_type enumerators
protocol_number	string	Protocol number	10
protocol_date	string	Protocol date (format "YYYY-MM-DD")	10
notary_office	object	Protest notary office data	notary_office object

pagination object

Field	Type	Description	Characters
current_page *	integer	Current page	-
rows_per_page *	integer	Items per page	-

protest_type enumerators

Enumerator	Description
protest	Common protest
bankruptcy_protest	Bankruptcy protest

protest_status enumerators

Enumerator	Description
accepted	Accepted, but not yet sent to the protest notary offices
submitted	Sent to notary office
cancellation_requested	Protest suspension requested
cancelled	Sending cancelled, or protest suspended
rejected	Protest request rejected
at_notary_office	At protest notary office, in triduum period
paid_at_notary_office	Title paid at notary office
protested	Title protested and settled
removal_requested	Title already protested, with cancellation requested
removed	Protest cancelled

notary_office object

Field	Type	Description	Characters
city *	string	Protest notary office city	-
uf *	string	Protest notary office state (UF)	2

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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