Payment (Pagamento)
O Payment registra cada pagamento individual realizado em uma venda, podendo haver multiplos pagamentos por venda.
Descricao
Um pagamento representa a entrada de dinheiro de um metodo especifico. Uma venda pode ter varios pagamentos combinados (ex: parte em dinheiro, parte em cartao).
Dados
Informacoes do Pagamento
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| value | Monetario | Sim | Valor do pagamento |
| payment_type | Selecao | Sim | Tipo do pagamento |
| installments | Numero | Condicional | Numero de parcelas (se cartao credito) |
| authorization_code | Texto | Nao | Codigo de autorizacao da transacao |
| nsu | Texto | Nao | NSU da transacao |
Flags de Estado
| Campo | Tipo | Descricao |
|---|---|---|
| voucher_paid | Booleano | Se voucher foi quitado |
| is_prepaid | Booleano | Se e pagamento antecipado |
Relacionamentos
Pertence a
| Entidade | Obrigatorio | Descricao |
|---|---|---|
| Checkout | Sim | Checkout pai |
| Sale | Sim | Venda associada |
| Account | Sim | Conta do petshop |
| Store | Sim | Filial |
| PaymentMethod | Sim | Metodo de pagamento usado |
| Customer | Nao | Cliente (para credito/cashback) |
Possui
| Entidade | Descricao |
|---|---|
| FinancialTransactions | Transacoes financeiras geradas |
Tipos de Pagamento
Dinheiro
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Troco | Sim (calculado no checkout) |
| Integracao | Caixa do PDV |
Debito
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Taxa | Conforme PaymentMethod |
| Integracao | Gateway de pagamento |
Credito
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Sim (1 a N parcelas) |
| Taxa | Conforme PaymentMethod por parcela |
| Integracao | Gateway de pagamento |
PIX
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Taxa | Conforme PaymentMethod |
| Integracao | Gateway de pagamento |
Credito do Cliente
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Origem | Saldo de credito do cliente |
| Validacao | Nao pode exceder saldo |
Cashback
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Origem | Saldo de cashback do cliente |
| Validacao | Nao pode exceder saldo |
Voucher
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Nao |
| Origem | Vale/credito especifico |
| Rastreio | Vinculado a transacao original |
Convenio
| Caracteristica | Descricao |
|---|---|
| Parcelamento | Conforme convenio |
| Faturamento | Posterior ao cliente conveniado |
| Prazo | Definido no convenio |
Parcelamento (Cartao Credito)
Configuracao
O numero de parcelas e taxas sao definidos no PaymentMethod:
| Parcelas | Taxa (exemplo) |
|---|---|
| 1x | 2.5% |
| 2x | 3.5% |
| 3x | 4.5% |
| 4-6x | 5.5% |
| 7-12x | 6.5% |
Calculo da Taxa
taxa_total = valor * (taxa_percentual / 100)
valor_liquido = valor - taxa_total
Geracao de Transacoes
Para pagamento parcelado:
- Cria N transacoes financeiras (uma por parcela)
- Cada parcela com data futura calculada
- Valor de cada parcela = valor_total / parcelas
Geracao de Transacoes Financeiras
Ao Confirmar Pagamento
Para cada Payment no Checkout:
Atributos da Transacao
| Campo | Valor |
|---|---|
| type | revenue |
| status | paid (dinheiro) ou pending (outros) |
| value | Valor do pagamento |
| payment_id | Referencia ao Payment |
| financial_account_id | Conta do metodo |
| payment_method_id | Metodo usado |
Validacoes
Valor Obrigatorio
- Valor deve ser maior que zero
- Valor deve ser numerico valido
Credito/Cashback do Cliente
- Cliente deve ter saldo suficiente
- Valor nao pode exceder saldo disponivel
- Cliente deve estar vinculado a venda
Parcelamento
- So permitido para cartao de credito
- Numero de parcelas deve estar nos limites do PaymentMethod
- Valor minimo por parcela (se configurado)
Cancelamento de Pagamento
Antes de Confirmar
- Pagamento pode ser removido livremente
- Nenhum efeito colateral
Apos Confirmar (Venda Paga)
- Nao pode remover pagamento individualmente
- Requer cancelamento da venda
- Transacoes financeiras sao estornadas
Estorno
Quando pagamento e estornado:
- Transacao financeira marcada como cancelada
- Se credito/cashback: saldo e devolvido ao cliente
- Valor e registrado como estorno
Recibo/Comprovante
O pagamento inclui informacoes para comprovante:
- Metodo de pagamento
- Valor
- Parcelas (se aplicavel)
- Codigo de autorizacao
- NSU
Integracao com Gateway
Fluxo de Cartao
Dados Retornados
| Campo | Descricao |
|---|---|
| authorization_code | Codigo de autorizacao |
| nsu | Numero Sequencial Unico |
| tid | ID da transacao no gateway |