🔗 Endpoint
| Método | URL |
 | /public/api/v1.1/cartao/urs/{idUr}/conciliacoes |
🧾 Descrição
Retorna o extrato de conciliação de uma UR: a página de auditoria que responde, linha por linha, o que a agenda anunciou, quais créditos chegaram e quais ônus existiam sobre a UR no momento da liquidação.
É o nível mais fino do acompanhamento. Quando a posição do contrato (7.1. Posição do contrato) ou a fila de exceções (7.4. Divergências) apontam um problema em uma UR, é aqui que se prova o que aconteceu.
O retorno é o mesmo para os dois tipos de contrato (1 = Troca de titularidade e 2 = Garantia). O que muda é apenas a origem de cada crédito, informada no campo creditos[].origem: na antecipação o crédito vem da baixa da UR cedida ao fundo; na garantia, da conciliação da movimentação bancária com a agenda.
📤 Requisição
🔎 Path Params
| Parâmetro | Tipo | Obrigatório | Descrição |
| idUr | string | Sim | GUID da UR (Unidade de Recebível) na plataforma VeFlow. |
🧪 Exemplo de cURL
curl -X GET https://api.veflow.com/public/api/v1.1/cartao/urs/7D121577-3C5A-494D-B052-291D9E100D0D/conciliacoes \
-H "Authorization: Bearer {seu_token}" \
-H "GrupoEconomico: {seu_grupo_economico}"
📥 Responses
✅ 200 OK
{
"identificadorUr": "7D121577-3C5A-494D-B052-291D9E100D0D",
"statusLiquidacao": 2,
"esperado": [
{
"dataPrevista": "2025-09-10",
"dataEfetiva": "2025-09-10",
"valor": 1000.00,
"idEfeitoContrato": "0DC43268-E05F-478E-931C-A43B8B3DD79B",
"consumida": false
}
],
"creditos": [
{
"identificadorMovimentacao": "1B428B23-C0A8-46D5-AF2C-1AFFAFAAC653",
"dataCredito": "2025-09-10",
"valor": 700.00,
"valorConciliado": 700.00,
"origem": 1,
"situacao": 3,
"documentoOrigem": "E60701190202509101030s01234567890",
"arranjo": "MCC",
"credenciadora": "11223344000155"
},
{
"identificadorMovimentacao": "9C55D0B1-77A4-4F2E-9C0B-3D51A2E9B7A2",
"dataCredito": "2025-09-10",
"valor": 250.00,
"valorConciliado": 250.00,
"origem": 1,
"situacao": 3,
"documentoOrigem": "E60701190202509101044s0987654321",
"arranjo": "MCC",
"credenciadora": "11223344000155"
}
],
"efeitos": [
{
"idEfeitoContrato": "0DC43268-E05F-478E-931C-A43B8B3DD79B",
"idContrato": "19710560-04CD-4E48-881D-D38350B39079",
"tipo": 2,
"titular": "45678901000122",
"valor": 1000.00,
"prioridade": 1,
"situacao": 1
},
{
"idEfeitoContrato": "F1A9C4E2-88B7-4C31-9A5D-2E6F0B7C4D19",
"idContrato": null,
"tipo": 3,
"titular": "98765432000188",
"valor": 300.00,
"prioridade": 2,
"situacao": 1
}
],
"totais": {
"esperado": 1000.00,
"liquidado": 950.00,
"chargeback": 50.00
}
}
🧾 Detalhamento dos Campos
🔹 Nível raiz
| Campo | Tipo | Descrição |
| identificadorUr | string | GUID da UR consultada. |
| statusLiquidacao | integer | Situação de liquidação da UR (ver tabela abaixo). |
| esperado | array | O que a agenda anunciou para a UR: datas previstas e valores. |
| creditos | array | Créditos recebidos e o quanto de cada um foi atribuído a esta UR. |
| efeitos | array | Ônus e efeitos de contrato que existiam sobre a UR, próprios ou de terceiros. |
| totais | object | Totais consolidados da UR (ver abaixo). |
🔹 esperado
| Campo | Tipo | Descrição |
| dataPrevista | string | Data prevista de liquidação anunciada pela agenda (YYYY-MM-DD). |
| dataEfetiva | string/null | Data em que o crédito foi efetivamente recebido. null enquanto a linha não recebe crédito. |
| valor | number | Valor anunciado pela agenda para essa linha. |
| idEfeitoContrato | string | ID de efeito de contrato ao qual a linha está atrelada — ver 2.1. Conceitos. |
| consumida | boolean | true quando a linha foi integralmente coberta por crédito conciliado. |
Normalmente há uma linha por UR. Quando a agenda é republicada com novo valor ou nova data para a mesma UR, a linha anterior deixa de ser consumida e uma nova linha aparece no array, preservando o histórico do que foi anunciado.
🔹 creditos
| Campo | Tipo | Descrição |
| identificadorMovimentacao | string | Identificador da movimentação no sistema de origem, o mesmo enviado na integração de liquidações. |
| dataCredito | string | Data em que o valor foi creditado (YYYY-MM-DD). |
| valor | number | Valor total do crédito recebido. |
| valorConciliado | number | Parte do crédito atribuída a esta UR. Um mesmo crédito pode ser rateado entre várias URs. |
| origem | integer | Origem do dado de liquidação (ver tabela abaixo). |
| situacao | integer | Situação da conciliação do crédito (ver tabela abaixo). |
| documentoOrigem | string | Documento que originou o crédito (ex.: end-to-end do PIX, identificação do arquivo de extrato ou da baixa junto ao fundo). |
| arranjo | string | Sigla do arranjo de pagamento do crédito (ex.: MCC, VCC). |
| credenciadora | string | CNPJ da credenciadora que efetuou o crédito (somente números). |
🔹 efeitos
| Campo | Tipo | Descrição |
| idEfeitoContrato | string | ID de efeito de contrato no ambiente de interoperabilidade. |
| idContrato | string/null | GUID do contrato na plataforma quando o efeito é do próprio grupo econômico. null quando é ônus de terceiro. |
| tipo | integer | Tipo do ônus/efeito sobre a UR (ver tabela abaixo). |
| titular | string | CNPJ do titular do efeito (somente números). |
| valor | number | Valor da UR comprometido por esse efeito. |
| prioridade | integer | Ordem de precedência do efeito na liquidação da UR: 1 é atendido primeiro. Define quem recebe quando o crédito não cobre tudo. |
| situacao | integer | Situação do efeito: 1 = Ativo, 2 = Liquidado, 3 = Cancelado. |
🔹 totais
| Campo | Tipo | Descrição |
| esperado | number | Soma do que a agenda anunciou para a UR nas linhas vigentes de esperado. |
| liquidado | number | Soma de creditos[].valorConciliado: o que efetivamente entrou em conta e foi atribuído a esta UR. |
| chargeback | number | Redução de posição ou estorno: valor anunciado que deixou de existir, por chargeback da venda ou ajuste da posição. |
🔢 Situação de liquidação da UR
| Código | Significado | Aplicação |
| 1 | Em aberto | Data prevista ainda não venceu, ou o dia ainda não fechou na rodada das 19:00. |
| 2 | Liquidada parcialmente | Chegou crédito, mas menos do que a agenda anunciou. |
| 3 | Liquidada | Crédito recebido cobre integralmente o esperado. |
| 4 | Não liquidada | Data prevista passou, o dia fechou e nenhum crédito foi atribuído à UR. |
| 5 | Removida | UR retirada do contrato antes da liquidação. |
| 6 | Rejeitada | UR recusada no registro do contrato (indisponível ou já onerada por terceiro). |
| 7 | Cancelada | UR cancelada na registradora após o registro. |
🔢 Origem do crédito
| Código | Significado | Aplicação |
| 1 | Conciliação da movimentação bancária | Crédito em conta informado à plataforma e conciliado com a agenda. Origem típica dos contratos de garantia. |
| 2 | Baixa da UR cedida ao fundo | Liquidação apurada na baixa do recebível cedido. Origem típica dos contratos de troca de titularidade. |
| 3 | Ajuste da operação | Lançamento manual feito pela operação para corrigir uma atribuição, sempre rastreado em documentoOrigem. |
🔢 Situação da conciliação do crédito
| Código | Significado | Aplicação |
| 1 | Pendente de atribuição | Crédito recebido e ainda não atribuído a nenhuma linha de agenda. |
| 2 | Conciliado parcialmente | Parte do valor do crédito foi atribuída; o restante segue pendente. |
| 3 | Conciliado | Valor integralmente atribuído a linhas de agenda. |
| 4 | Estornado | Crédito revertido após a conciliação; o valor volta para chargeback. |
| 5 | Atribuição ambígua | Mais de uma UR compatível com o mesmo crédito. A conciliação fica suspensa até o desempate. |
🔢 Tipo de ônus/efeito sobre a UR
| Código | Significado | Aplicação |
| 1 | Troca de titularidade | A UR foi cedida: a titularidade do recebível mudou. |
| 2 | Garantia | A UR está travada como garantia, sem cessão. |
| 3 | Promessa de cessão | Ônus de terceiro sobre a UR. Aparece apenas em leitura e nunca pode ser criada pela API. |
| 4 | Penhor | Efeito legado, mantido no retorno apenas para leitura de contratos antigos. |
❌ 404 Not Found
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"titulo": "Atenção",
"status": 404,
"erros": [
"UR não encontrada."
]
}
🕒 Observações
- A leitura do extrato é sempre a mesma nos dois tipos de contrato.
tipoContrato tem somente dois valores: 1 = Troca de titularidade e 2 = Garantia. - Promessa de cessão nunca é criada por esta API: ela aparece em
efeitos como ônus de terceiro sobre a UR, para explicar por que parte do crédito não chegou ao seu contrato. Penhor é efeito legado, presente apenas em leitura. - O campo
prioridade explica os casos de liquidação parcial: quando o crédito recebido não cobre a soma dos efeitos, os de menor prioridade ficam descobertos. Mudanças de prioridade são notificadas por webhook — ver 3.3. Atualizações da UR. - Contrato de garantia não tem deságio: o extrato nunca traz valor nominal, desconto, aquisição nem taxa. Esses valores existem somente em antecipação (troca de titularidade), onde houve cessão da UR ao fundo.
- No exemplo acima, a agenda anunciou
1.000,00, entraram 950,00 em dois créditos e os 50,00 restantes foram baixados como chargeback — por isso statusLiquidacao é 2 (liquidada parcialmente) e a linha de esperado não está consumida. - Os créditos aparecem no extrato depois de recebidos pela integração de liquidações — ver 6.1. Envio dos créditos em conta. O envio deve ocorrer após as 10:05, por causa do processamento batch das agendas às 10:00.
- A conciliação roda de forma recorrente ao longo do dia; a última rodada é às 19:00. Só depois dela uma UR vencida sem crédito passa para
4 (não liquidada). - Créditos com
situacao igual a 1 ou 5 também aparecem na fila de exceções — ver 7.4. Divergências. - Headers obrigatórios e convenções gerais: 1.2. Convenções da API.