Protesto
Solicita o cancelamento de um protesto
Changed onEsta rota realiza a solicitação de cancelamento de um protesto a partir do identificador do título ou do protesto e do tipo do cancelamento
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| TituloId | Número | ID do título no Protesto24h. Se 0, indica que não existe título e deve buscar pelo ProtestoId | Não(1) |
| ProtestoId | GUID | Identificador único do protesto. Usado quando TituloId = 0 para buscar o protesto sem título | Não(2) |
| TipoCancelamento | Número | Tipo de cancelamento - "AUTORIZACAO" = 0, "CANCELAMENTO_ENVIO" = 1, ""PEDIDO_CANCELAMENTO" = 2 | Sim |
| WebhookUrl | Texto | URL do webhook do cliente para notificações de cancelamento. Se informada, substitui a URL do cliente | Não |
(1) - Obrigatório caso ProtestoId não seja informado (2) - Obrigatório caso TituloId seja 0 (zero)
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Retorno da chamada, podendo ser os valores "CREATED", "OK", "ERROR" ou "DELETED" |
| DetalhesErro | Lista de Texto | Detalhes do erro gerado, caso o retorno seja ERROR. Pode ser null |
| TituloId | Número | Identificador do título registrado. Pode ser 0 quando o título ainda não foi criado (apenas o protesto existe) |
| ProtestoId | GUID | Identificador único do protesto no sistema |
delete/api/CancelaProtesto
Request
- Base URLhttps://pagamentos.meuk8.com.br/PagamentosAPI
- URLhttps://pagamentos.meuk8.com.br/PagamentosAPI/api/CancelaProtesto
- AuthOAuth 2PasswordToken URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI
Headers
Aeskeystring required
Request body
Example request
{
"TituloId": 12345,
"TipoCancelamento": 0,
"WebhookUrl": "https://webhooktest.net/webhook/019b8f7c-58b0-778e-80db-94c611d6ff97"
}Response
Solicitação de cancelamento do protesto concluída com sucesso.
Example response
{
"ProtestoId": "00000000-0000-0000-0000-000000000000"
}Changes
- info
endpoint added
- info