查询抗议工具文件

抗议工具文件是公证处在抗议执行过程中发出的官方文件，用于证明催收程序已执行。该文件在抗议完成后发出，前提是债务人在被通知后未支付债务。

注意！

只有在票据被实际抗议（protest_status 值为 protested）之后，才能查询抗议工具文件。

Request

ENDPOINT

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

MÉTODO

GET

Path parameters

字段	类型	描述	字符数
account_key	uuidv4	账户唯一标识键，uuid v4 格式	36
requester_profile_key	uuidv4	钱包唯一标识键，uuid v4 格式	36
bank_slip_key	uuidv4	票据唯一标识键，uuid v4 格式	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

字段	类型	描述	字符数
bank_slip_key *	uuidv4	票据唯一标识键，uuid v4 格式	36
file_url *	string	包含抗议工具文件（PDF）的文件 URL	-

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
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.