Protest instrument query

The protest instrument is an official document issued by the protest registry office, which proves the execution of the collection process. It is issued after the protest is registered, if the debtor has not paid the debt after being notified.

Attention!

It is only possible to query the protest instrument of the title after it has been effectively protested (protest_status has the value protested).

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_instrument

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
bank_slip_key	uuidv4	Unique bank slip identification key, in uuid v4 format	36

Response

STATUS

200

Response Body

{
  "bank_slip_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
  "file_url": "https://storage.googleapis.com/live-bank-slip-api/protest_instrument/bc34e9b1-42e4-4f17-bfc0-c88f29d5230e.pdf"
}

Response Body Params

Field	Type	Description	Characters
bank_slip_key *	uuidv4	Unique bank slip identification key in uuid v4 format	36
file_url *	string	File URL, in PDF format, containing the protest instrument document	-

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 (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Schema Inválido
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.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada
404	BKS000029	Not Found	Bank slip not found for the given key ({bank_slip_key}).	Boleto não encontrado para a chave fornecida ({bank_slip_key}).
400	BKS000081	Bad Request	The protest instrument will be available only after bank slip's protest confirmation.	O instrumento de protesto só estará disponível após a confirmação do protesto do título.
500	BKS000105	Internal Server Error	Could not fetch protest instrument for the given 'bank_slip_key' at this moment. Please, try again later.	Não foi possível recuperar o instrumento de protesto para a chave ('bank_slip_key') fornecida. Por favor, tente novamente mais tarde.
404	BKS000106	Not Found	No protest found for the given bank slip.	Nenhum protesto foi encontrado para o boleto fornecido.