58 - Cancelar Registro

Scopes:

api.ext api.boleto.cancelar

Cancela o registro de um boleto bancário previamente registrado.

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/CancelarRegistro \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "listaCodigos": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "listaCodigosBarras": [
    "<string>"
  ]
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "listaCodigosCancelamento": [
    {
      "codigoRegistroBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "codigoCancelamento": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sucesso": true,
      "mensagem": "<string>",
      "ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Por meio desse endpoint, o parceiro pode cancelar o registro de um boleto desde que ainda não tenha sido pago.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Boleto/CancelarRegistro	Parâmetro inválido
/api/Boleto/CancelarRegistro	Somente um parâmetro deve ser informado
/api/Boleto/CancelarRegistro	Boleto não localizado para cancelamento
/api/Boleto/CancelarRegistro	Conta
/api/Boleto/CancelarRegistro	Operador não encontrado
/api/Boleto/CancelarRegistro	Parceiro não autorizado para esta conta
/api/Boleto/CancelarRegistro	Não é possível excluir ou alterar um boleto cedido

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey · string · obrigatório

IgnoraHandshake · boolean · padrão: true · obrigatório

(somente em homologação)

Corpo

application/jsontext/jsonapplication/*+json

listaCodigos · string<uuid>[] | null

Lista de códigos UUID identificadores dos boletos.

Observação:

• Quando a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) for informada, a 'lista de códigos de barras dos boletos' (listaCodigosBarras) não deve ser preenchida.

listaCodigosBarras · string[] | null

Lista de códigos de barras dos boletos.

Observação:

• Quando a 'lista de códigos de barras dos boletos' (listaCodigosBarras) for informada, a 'lista de códigos UUID de identificadores dos boletos' (listaCodigos) não deve ser preenchida.

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

listaCodigosCancelamento · object[] | null

Show child attributes