通过键查询抗议
通过键查询抗议，可返回有关该抗议的详细信息。
Request
ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/protest/BANK_SLIP_KEYMÉTODO
GETPath parameters
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key | uuidv4 | 账户唯一标识键，uuid v4 格式 | 36 |
requester_profile_key | uuidv4 | 钱包唯一标识键，uuid v4 格式 | 36 |
bank_slip_key | uuidv4 | 票据唯一标识键，uuid v4 格式 | 36 |
Response
STATUS
200Response 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_code": 12345,
"notary_office": {
"city": "VITORIA",
"uf": "ES"
}
}
Response Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
protest_key * | uuidv4 | 抗议唯一标识键，uuid v4 格式 | 36 |
request_control_key * | uuidv4 | 客户使用的请求唯一标识键，uuid v4 格式 | 36 |
protest_status * | string | 抗议状态 | Enumeradores protest_status |
bank_slip_key * | uuidv4 | 票据唯一标识键，uuid v4 格式 | 36 |
requester_profile_code * | string | 钱包唯一识别码 | 10 |
protest_type * | string | 抗议类型 | Enumeradores protest_type |
protocol_number | string | 协议号码 | 10 |
protocol_date | string | 协议日期（格式"YYYY-MM-DD"） | 10 |
notary_office_code | integer | 公证处识别代码 | - |
notary_office | object | 公证处数据 | Objeto notary_office |
Enumeradores protest_status
| 枚举值 | 描述 |
|---|---|
| accepted | 已接受，但尚未发送至公证处 |
| submitted | 已发送至公证处 |
| cancellation_requested | 已申请中止抗议 |
| cancelled | 发送已取消，或抗议已中止 |
| rejected | 抗议申请被拒绝 |
| at_notary_office | 在公证处，处于三日期间 |
| paid_at_notary_office | 票据已在公证处支付 |
| protested | 票据已被抗议并核销 |
| removal_requested | 票据已被抗议，已申请取消 |
| removed | 抗议已取消 |
Enumeradores protest_type
| 枚举值 | 描述 |
|---|---|
| protest | 普通抗议 |
| bankruptcy_protest | 破产抗议 |
Objeto notary_office
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
city * | string | 公证处所在城市 | - |
uf * | string | 公证处所在州（UF） | 2 |
Error Response
STATUS
4xxResponse 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}). |
| 404 | BKS000106 | Not Found | No protest found for the given bank slip. | Nenhum protesto foi encontrado para o boleto fornecido. |