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>"
    }
  ]
}

This endpoint offers the possibility of canceling charges that were previously registered, either from PIX Cobrança or Boletos (common or hybrid).

It ensures that the charges associated with installments can be canceled and reissued, allowing for more precise control over the flow of payments.

The cancellation process is asynchronous, that is, the operation is performed in the background, and a callback is triggered to the partner as soon as the cancellation of the billing registration is complete, informing them that the ancellation was successful.

This process includes:

  • Cancellation of Boleto;
  • Cancellation of Hybrid Boleto;
  • Cancellation of PIX Collection.

This endpoint provides flexibility in managing collections, allowing the partner to simply cancel registrations and maintain proper control of their financial operations.

Use the value generated by the Settlement ID field, returned in the response from endpoints 4 - Generate a Charge and 5 - Generate Multiple Installment Charges, to cancel a collection negotiation.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

Response

200
text/plain

OK

The response is of type object.