Documentação da API

POST /cancel_charge

Resumo

Este endpoint cancela uma cobrança previamente gerada para um ou mais pedidos de venda, de acordo com o provedor integrado (Asaas, Cora, C6 Bank, etc.).

---

Descrição

Utilize este endpoint para cancelar cobranças de pedidos que ainda não foram liquidadas. O core é responsável por sincronizar o cancelamento com o provedor de pagamento e atualizar o status local.

---

Requisição

Body da Requisição

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	b31643fc-a45f-448c-99ee-736a547f6989
unit_token	string	Sim	Token da unidade.	e6988e9e-b0c1-410c-ae08-aed7c64ac71f
cod_pv	string | array	Sim	Código(s) do(s) pedido(s) de venda cujas cobranças serão canceladas.	"PV-2024-0001" ou ["PV-2024-0001"]

---

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/cancel_charge' -H 'Content-Type: application/json' -d '{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "cod_pv": "PV-2024-0001"
}'

---

Resposta

{
  "ok": true,
  "success": true,
  "results": [
    {
      "cod_pv": "PV-2024-0001",
      "provider": "asaas",
      "status_before": "OPEN",
      "status_after": "CANCELED"
    }
  ]
}

Erros Comuns

Status	Mensagem	Descrição
400	"Informe o código do pedido de venda para cancelar a cobrança."	cod_pv não informado.
403	"Invalid data"	Autenticação inválida.
500	"Erro ao cancelar cobrança"	Erro interno ao cancelar a cobrança.