Pular para o conteúdo principal

Documentação da API

POST /generate_charge

Resumo

Este endpoint gera cobrança(s) para um ou mais pedidos de venda, utilizando os provedores de pagamento configurados (Asaas, Cora, C6 Bank, etc.).


Descrição

Use este endpoint para disparar a criação de cobranças a partir de pedidos de venda. O comportamento exato (provedor, tipo de cobrança, parcelamento) é definido pelos campos configurados no próprio pedido (generate_with_asaas, generate_cora, generate_c6, etc.).


Requisição

Body da Requisição

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringSimToken da unidade.e6988e9e-b0c1-410c-ae08-aed7c64ac71f
cod_pvstring | arraySimCódigo(s) do(s) pedido(s) de venda para gerar a cobrança (campo cod_pv/cod_orders)."PV-2024-0001" ou ["PV-2024-0001"]

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/generate_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",
"charge_id": "pay_123456789",
"status": "OPEN",
"boleto_url": "https://asaas.com/boleto/123..."
}
]
}

A estrutura exata do retorno depende da implementação do core (generate_charge_api).

Erros Comuns

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