Para cancelar uma cobrança avulsa, será necessário realizar uma chamada na api Cancelar Cobrança Avulsa utilizando o método DELETE, onde precisa ser preenchido algumas informações relacionadas a cobrança realizada. Todas as informações necessárias para cancelar uma cobrança estão no quadro "Parâmetros do Body"

Modelo de requisição:

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/charges/{chargeId}/{typeId}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \

Parâmetros do Body:

CampoDescriçãoTipo
chargeIdIdentificador da cobrança
typeIdTipo do identificador. Valores possíveis para informar no campo:
  • 1. galaxPayId *- Identificador da Celcoin.
  • 2. myId -* Identificador único da empresa..

Modelo de retorno:


{
    "type": true
}

Tabela descritiva dos campos retornados

CampoDescriçãoTipo
typeTipo do identificador. Valores possíveis para informar no campo:
  • 1. true *- Quando a cobrança for cancelada com sucesso
  • 2. false-* Quando ocorrer erro ao solicitar o cancelamento da cobrança
Bool