Pular para o conteúdo principal

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​

CampoTipoObrigatorioDescricao
valueMonetarioSimValor do pagamento
payment_typeSelecaoSimTipo do pagamento
installmentsNumeroCondicionalNumero de parcelas (se cartao credito)
authorization_codeTextoNaoCodigo de autorizacao da transacao
nsuTextoNaoNSU da transacao

Flags de Estado​

CampoTipoDescricao
voucher_paidBooleanoSe voucher foi quitado
is_prepaidBooleanoSe e pagamento antecipado

Relacionamentos​

Pertence a​

EntidadeObrigatorioDescricao
CheckoutSimCheckout pai
SaleSimVenda associada
AccountSimConta do petshop
StoreSimFilial
PaymentMethodSimMetodo de pagamento usado
CustomerNaoCliente (para credito/cashback)

Possui​

EntidadeDescricao
FinancialTransactionsTransacoes financeiras geradas

Tipos de Pagamento​

Dinheiro​

CaracteristicaDescricao
ParcelamentoNao
TrocoSim (calculado no checkout)
IntegracaoCaixa do PDV

Debito​

CaracteristicaDescricao
ParcelamentoNao
TaxaConforme PaymentMethod
IntegracaoGateway de pagamento

Credito​

CaracteristicaDescricao
ParcelamentoSim (1 a N parcelas)
TaxaConforme PaymentMethod por parcela
IntegracaoGateway de pagamento

PIX​

CaracteristicaDescricao
ParcelamentoNao
TaxaConforme PaymentMethod
IntegracaoGateway de pagamento

Credito do Cliente​

CaracteristicaDescricao
ParcelamentoNao
OrigemSaldo de credito do cliente
ValidacaoNao pode exceder saldo

Cashback​

CaracteristicaDescricao
ParcelamentoNao
OrigemSaldo de cashback do cliente
ValidacaoNao pode exceder saldo

Voucher​

CaracteristicaDescricao
ParcelamentoNao
OrigemVale/credito especifico
RastreioVinculado a transacao original

Convenio​

CaracteristicaDescricao
ParcelamentoConforme convenio
FaturamentoPosterior ao cliente conveniado
PrazoDefinido no convenio

Parcelamento (Cartao Credito)​

Configuracao​

O numero de parcelas e taxas sao definidos no PaymentMethod:

ParcelasTaxa (exemplo)
1x2.5%
2x3.5%
3x4.5%
4-6x5.5%
7-12x6.5%

Calculo da Taxa​

taxa_total = valor * (taxa_percentual / 100)
valor_liquido = valor - taxa_total

Geracao de Transacoes​

Para pagamento parcelado:

  1. Cria N transacoes financeiras (uma por parcela)
  2. Cada parcela com data futura calculada
  3. Valor de cada parcela = valor_total / parcelas

Geracao de Transacoes Financeiras​

Ao Confirmar Pagamento​

Para cada Payment no Checkout:

Atributos da Transacao​

CampoValor
typerevenue
statuspaid (dinheiro) ou pending (outros)
valueValor do pagamento
payment_idReferencia ao Payment
financial_account_idConta do metodo
payment_method_idMetodo 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:

  1. Transacao financeira marcada como cancelada
  2. Se credito/cashback: saldo e devolvido ao cliente
  3. 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​

CampoDescricao
authorization_codeCodigo de autorizacao
nsuNumero Sequencial Unico
tidID da transacao no gateway