抗议申请

公证处抗议申请可在票据到期日之后提出，用于要求付款人在公证处偿还票款。若付款人未履行，将在其名下进行公开的违约登记，并将其姓名列入 Serasa 等信用保护机构。

注意！

发送抗议申请时，票据中必须包含付款人的地址。若地址不存在，可发送票据编辑指令进行补充。此外，若票据已处于抗议流程中，则不允许发送新的抗议申请。

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_request

MÉTODO

POST

Path parameters

字段	类型	描述	字符数
`account_key`	uuidv4	账户唯一标识键，uuid v4 格式	36
`requester_profile_key`	uuidv4	钱包唯一标识键，uuid v4 格式	36
`bank_slip_key`	uuidv4	票据唯一标识键，uuid v4 格式	36

Request Body

{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
  "protest_type": "protest"
}

Request Body Params

字段	类型	描述	字符数
`request_control_key` *	uuidv4	客户使用的请求唯一标识键，uuid v4 格式	36
`protest_type` *	string	抗议类型（普通或破产）	Enumeradores protest_type

Enumeradores protest_type

枚举值	描述
protest	普通抗议
bankruptcy_protest	破产抗议

Response

STATUS

202

Response Body

{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}

Response Body Params

字段	类型	描述	字符数
`occurrence_key` *	uuidv4	记录（指令）唯一标识键，uuid v4 格式	36
`bank_slip_key` *	uuidv4	票据唯一标识键，uuid v4 格式	36

Error Response

STATUS

4xx

Response Body: Error

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

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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
409	BKS000014	Conflict	Request control key already sent or duplicated sent: `<request_control_key>`	Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>`
400	BKS000019	Bad Request	Payer address is required for protest.	Endereço do pagador é obrigatório para protesto.
400	BKS000022	Bad Request	Requester profile is not opened.	Carteira não está aberta.
404	BKS000028	Not Found	Notary office attended region not found for postal code: `<postal_code>`	Região de cartório não encontrada para o CEP: `<postal_code>`
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	BKS000032	Bad Request	Bank slip must be in 'registered' status.	O boleto deve possuir o status 'registered'.
409	BKS000075	Conflict	An open protest request already exists for the given 'bank_slip_key'.	Já existe um pedido de protesto em aberto para a 'bank_slip_key' fornecida.
400	BKS000080	Bad Request	A protest request can only be sent after bank slip's business expiration date.	Um pedido de protesto só pode ser enviado após o dia útil de expiração do boleto.

Request​

Path parameters​

Request Body Params​

Enumeradores protest_type​

Response​

Response Body Params​

Error Response​