Pular para o conteúdo principal
cURL
curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/FGTS/CancelarCobrancas \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "Dto": {
    "CodigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CodigoLiquidacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{}
Este endpoint oferece a possibilidade de cancelar cobranças que foram previamente registradas. 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 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 do endpoint Gerar uma Cobrança de Parcela, para cancelar uma negociação de cobrança.

Autorizações

Authorization
string
header
obrigatório

Informe o token

Cabeçalhos

IdempotencyKey
string
obrigatório

Corpo

Dto
object

Resposta

OK

The response is of type object.