Consulta de protesto por chave

A consulta de um protesto, utilizando sua chave, retorna informações detalhadas a respeito do mesmo.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/protest/BANK_SLIP_KEY

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
`bank_slip_key`	uuidv4	Chave única de identificação do boleto, no formato uuid v4	36

Response

STATUS

200

Response Body

{
  "protest_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
  "request_control_key": "59515878-50e9-466b-b40d-1aac3939c3fd",
  "protest_status": "protested",
  "bank_slip_key": "7d3d262b-9b55-44cd-8355-2f00d5b1d142",
  "requester_profile_code": "329-09-0001-1467576",
  "protest_type": "protest",
  "protocol_number": "0000672016",
  "protocol_date": "2012-12-16",
  "notary_office": {
    "city": "VITORIA",
    "uf": "ES"
  }
}

Response Body Params

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

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

Enumeradores protest_type

Enumerador	Descrição
protest	Protesto comum
bankruptcy_protest	Protesto falimentar

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 (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}`).
404	BKS000106	Not Found	No protest found for the given bank slip.	Nenhum protesto foi encontrado para o boleto fornecido.

Consulta de protesto por chave

Request​

Path parameters​

Response​

Response Body Params​

Enumeradores protest_status​

Enumeradores protest_type​

Objeto notary_office​

Error Response​