撤销抗议
如果付款人和出票人担保人之间的纠纷在票据已被抗议后得以解决,可以发送 protest_remove_request 类型的指令,该指令将删除公开的拖欠记录以及与该票据相关的任何损害付款人信誉的记录。
注意!
如果该事件被确认(公证处接受),抗议将被撤销,并且不会为该票据创建更多指令,因为该票据已在 CIP/Nuclea 注销。
Request
ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slip/BANK_SLIP_KEY/protest_remove_requestMÉTODO
POSTPath 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"
}
Request Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
request_control_key * | uuidv4 | 客户使用的请求唯一标识键,格式为 uuid v4 | 36 |
Response
STATUS
202Response 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
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP 代码status | QI 代码code | 标题title | 描述 (eng)description | 描述 (pt-br)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 | 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'. |
| 400 | BKS000076 | Bad Request | Bank slip must have an ongoing protest request. | O boleto deve ter um pedido de protesto em vigência. |
| 400 | BKS000078 | Bad Request | Bank slip's protest_status must be 'protested' to send a protest remove request. | Status de protesto (protest_status) do boleto deve ser 'protested' para enviar um pedido de remoção de protesto. |