curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/CancelarCobrancas \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>"
  },
  "dtoCancelarCobrancas": {
    "codigosLiquidacoes": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "parametros": [
    {
      "nome": "<string>",
      "valor": "<string>"
    }
  ]
}

Este endpoint oferece a possibilidade de cancelar cobranças que foram previamente registradas, seja de PIX Cobrança ou Boletos (comum ou híbrido).

Ele garante que as cobranças associadas as parcelas possam ser canceladas e reemitidas, permitindo um controle mais preciso sobre o fluxo de pagamentos.

O processo de cancelamento é assíncrono, ou seja, a operação é realizada em segundo plano, e um callback é disparado para o parceiro assim que o cancelamento do registro da cobrança é concluído, informando que o cancelamento foi realizado com sucesso. Esse processo abrange:

  • Cancelamento de Boleto;
  • Cancelamento de Boleto Híbrido;
  • Cancelamento de PIX Cobrança.

Esse endpoint oferece flexibilidade no gerenciamento de cobranças, permitindo que o parceiro cancele registros de forma simples e mantenha um controle adequado de suas operações financeiras.

Utilize o valor gerado pelo campo codigoLiquidacao, retornado na resposta dos endpoints 4 - Gerar uma Cobrança de Parcela e 5 - Gerar Múltiplas Cobranças de Parcela, para cancelar uma negociação de cobrança.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

Response

200
text/plain

OK

The response is of type object.