Ir para o conteúdo

6.1. Recebimento de Liquidações Bancárias

🔗 Endpoint

Método URL
POST /api/v1/cartao/liquidacoes

🧾 Descrição

Recebe as informações de liquidações realizadas pelas credenciadoras (ex: via PIX) para os estabelecimentos comerciais. As liquidações são utilizadas para conciliação automática com as URs previamente constituídas nos contratos do VeFlow.

Como as credenciadoras fazem a transferência no valor exato de cada UR por contrato e data, isso permite uma conciliação simplificada e automatizada.

⚠️ O resultado da conciliação será informado exclusivamente via WebHook.


📤 Requisição

📋 Payload (JSON)

{
  "idOperacao": 0,
  "contaBancaria": {
    "banco": 0,
    "agencia": "0000",
    "conta": "000000"
  },
  "liquidacoes": [
    {
      "data": "2025-09-10",
      "cnpj": "12345678000199",
      "credenciadora": "11111111000191",
      "arranjo": "VCC",
      "valor": 1500.00
    }
  ]
}
Campo Tipo Obrigatório Descrição
idOperacao number Sim ID da Operação, valor fixo a ser informado pelo time de implantação.
contaBancaria object Sim Conta bancária atrelada a movimentação de liquidação
→ banco number Sim Nr do banco da conta bancária
→ agencia string Sim Agência da conta bancária
→ conta string Sim Número da conta bancária
→ liquidacoes list Sim abc
→ data string Sim Data em que o valor foi creditado (YYYY-MM-DD)
→ cnpj string Sim CNPJ do estabelecimento comercial (sem formatação)
→ credenciadora string Sim CNPJ da credenciadora
→ arranjo string Sim Sigla do arranjo (ex: MCC, VCC)
→ valor number Sim Valor exato creditado na conta do EC

🧪 Exemplo de cURL

curl -X POST https://api.veflow.com/api/v1/cartao/liquidacoes \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
      "idOperacao": 1,
      "contaBancaria": {
        "banco": 1,
        "agencia": "1111",
        "conta": "1111111"
      },
      "liquidacoes": [
        {
          "data": "2025-09-10",
          "cnpj": "12345678000199",
          "credenciadora": "11111111000191",
          "arranjo": "VCC",
          "valor": 1500.00
        }
      ]
    }'

📥 Response

✅ 200 OK

{
  "identificador": "86A12031-E774-4D90-A065-8E078DAB8AB2",
  "mensagem": "Liquidações recebidas para conciliação!"
}

Indica que as informações foram aceitas e serão processadas pelo motor de conciliação interna do VeFlow.


🕒 Observações

  • Este endpoint não possui limite de horário para envio.
  • O processo de conciliação será executado de forma recorrente e o resultado será disparado via WebHook/evento.