2.2. Dicionário de dados¶
Esta página define os dois vocabulários que atravessam toda a API VeFlow: o ciclo de vida dos valores da UR, fase por fase, e a lista de arranjos de pagamento aceitos nos filtros de consulta.
💰 Ciclo de vida dos valores¶
O mesmo recebível é descrito por campos diferentes conforme a fase em que está. Ler o campo certo na fase certa evita recalcular regra de negócio no integrador.
| Campo | Fase | Significado |
|---|---|---|
valorConstituido | Agenda | O que a registradora informa que existe naquela UR. |
valorComprometido | Agenda | A parte da UR já onerada, por contrato próprio ou de terceiro. |
valorLivre | Agenda | O disponível para uso naquela UR. |
valorDisponivel | Agenda | O valorLivre já descontado o percentual máximo por UR configurado na operação. É o número que você deve usar para montar o item, em vez de recalcular a regra. |
valorGarantido | Carrinho e contrato | Quanto daquela UR está sendo efetivamente utilizado. |
valorNominal | Antecipação, após a cessão | O valor da UR cedido ao fundo. Somente em troca de titularidade. |
valorDesconto | Antecipação | O deságio aplicado, isto é, a taxa de antecipação. Somente em troca de titularidade. |
valorAquisicao | Antecipação | O valorNominal já com o deságio aplicado — ou seja, o que o fundo, securitizadora ou financeira paga para receber aquele recebível no futuro. Somente em troca de titularidade. |
valorLiquidado | Pós-contratação | Posição de caixa conciliada: quanto do recebível já foi creditado e casado com a UR. Válido nos dois fluxos, antecipação e garantia. |
valorChargeback | Pós-contratação | Posição de caixa conciliada: quanto foi estornado depois de a UR ter sido constituída. Válido nos dois fluxos, antecipação e garantia. |
valorEmAberto | Pós-contratação | Posição de caixa conciliada: quanto ainda falta liquidar. Válido nos dois fluxos, antecipação e garantia. |
⚠️ Consequência prática¶
valorNominal,valorDescontoevalorAquisicaoexistem apenas onde houve CESSÃO.O contrato de garantia (
tipoContrato=2) não tem cessão nem deságio. Portanto o blocototaisde um contrato de garantia não traznominal,desconto,aquisicaonemtaxa— traz somenteconstituido,livre,garantidoedisponivel. Isso não é omissão de exemplo: esses campos não existem nesse tipo de contrato.O campo CET esteve documentado sem nunca ter existido no retorno da API e foi removido: a plataforma não apura IOF e, portanto, não calcula custo efetivo total.
🧮 Identidades úteis¶
valorConstituido=valorComprometido+valorLivrevalorAquisicao=valorNominal-valorDesconto
Lista de arranjos¶
| Sigla | Definição |
|---|---|
| ACC | Amex Cartão de Crédito |
| AGC | Agiplan Cartão de Crédito |
| ALC | Alelo Crédito Pós |
| AUC | Aura Cartão de Crédito |
| AVC | Avista Cartão de Crédito |
| BCC | Banescard Cartão de Crédito |
| BCD | Banescard Cartão de Débito |
| BNC | Banese Crédito |
| BRC | Brasil Card Cartão de Crédito |
| BRS | Banrisul (Compra) |
| BVV | Ben Visa Vale |
| CAC | Cielo Amex Crédito |
| CBC | Cabal Crédito |
| CBD | Cabal Débito |
| CCD | Calcard Cartão de Crédito |
| CSC | Credi-Shop Cartão de Crédito |
| CUP | CUP Cartão de Crédito |
| CZC | Credz Cartão de Crédito |
| DAC | Dacasa Cartão de Crédito |
| DBC | Discover Cartão de Crédito |
| DCC | Dinners Cartão de Crédito |
| ECC | Elo Cartão de Crédito |
| ECD | Elo Cartão de Débito |
| FRC | Fortbrasil Cartão de Crédito |
| GCC | Goodcard Crédito |
| HCC | Hipercard Cartão de Crédito |
| HCD | Hipercard Cartão de Débito |
| JCC | JCB Cartão de Crédito |
| MAC | Mais Cartão de Crédito |
| MCC | Mastercard Cartão de Crédito |
| MCD | Mastercard Cartão de Débito |
| MXC | Maxifrota Cartão de Crédito |
| OCD | Ourocard Cartão de Débito |
| RCC | Redesplan Cartão de Crédito |
| SCC | Sorocred Cartão de Crédito |
| SCD | Sorocred Cartão de Débito |
| SFC | Senff Cartão de Crédito |
| SIC | Sicred (Compra) |
| SPC | Sem Parar Cartão de Crédito |
| TKC | Ticketlog Pós Cartão de Crédito |
| VCC | Visa Cartão de Crédito |
| VCD | Visa Cartão de Débito |
| VDC | Verdecard Cartão de Crédito |
| VDD | Verdecard Débito Pré-Pago |
| VCB | Visa Cartão Benefícios |
| MCB | Mastercard Cartão Benefícios |
| ECB | Elo Cartão Benefícios |
As siglas acima são os valores aceitos no campo arranjos da solicitação de agenda — ver 4.1. Solicitar agenda. Quando arranjos é omitido, a consulta considera todos os arranjos.
🕒 Observações¶
- A definição dos termos de negócio — agenda, carrinho, item, contrato, efeito, ônus, fumaça, UR performada — está em 2.1. Conceitos.
- Compare sempre a alocação contra
valorDisponivel, nunca contravalorLivre: o percentual máximo por UR é uma trava da operação e a alocação é recusada quando o item passa desse teto. - Headers obrigatórios (
Authorization,GrupoEconomico) e convenções gerais: 1.1. Primeiros Passos.