Pular para o conteúdo principal

Inicia uma cobrança TEF ou Pix

POST 
/store-front/cashier/:idbankaccount/payment

Handler PHP com set_time_limit(180). Cria o registro StoreFrontCashierPayment (status inicial Pendente) e dispara a cobrança no provedor configurado pela integração da conta bancária (BankAccount.IDCompanyIntegration → IDTypeCompanyIntegration).

Direcionamento por integração​

  • PayGo / ControlPay (IDTypeCompanyIntegration = 17): manda a venda para a maquininha (TEF) com formaPagamentoId derivado da categoria do tipo de pagamento (22=crédito → 21, 23=débito → 22, 24=Pix → 24). Exige BankAccount.TefTerminal preenchido e Token da integração configurado. Em sucesso de conexão, status vira Em pagamento (2). Erro de conexão em 15s vira status Expirado (4) com mensagem Erro ao conectar ao terminal TEF....
  • StarkBank (131): gera um QR Code Pix dinâmico (CreateDynamicBrcode) com 3600s de expiração. Retorna PixCopiaCola (string copia-cola) e QrCodeImageUrl. Status vira Em pagamento.
  • Pagar.me (13): só suporta Pix (Category = 24). Outras categorias dão Integração Pagarme no PDV suporta apenas Pix. Retorna PixCopiaCola, QrCodeImageUrl e o TID.

Categorias de tipo de pagamento aceitas​

Apenas tipos de pagamento com Category ∈ {22 crédito, 23 débito, 24 Pix}. Outros valores retornam Tipo de pagamento <id> inválido (categoria recebida: <cat>), permitido apenas crédito, débito e Pix.

IDOrderIntention​

Quando o cliente envia IDOrderIntention (UUID), o handler usa esse valor para ligar a tentativa ao pedido. Quando omite, o handler gera um UUID novo e devolve no body. Esse UUID é o que casa com StoreFrontCashierOrder.IDOrderIntention (ligação tentativa → pedido fechado).

A partir daí, o cliente deve fazer polling via GET /store-front/cashier/{idbankaccount}/payment/{idstorefrontcashierpayment} até obter Success=1 ou um status final.

Request​

Responses​

Cobrança iniciada. Para PayGo retorna apenas IDStoreFrontCashierPayment + IDOrderIntention + IDTypeStatusStoreFrontCashierPayment. Para Pix (StarkBank/Pagar.me) retorna também ExternalId, PixCopiaCola, QrCodeImageUrl, QrcodeExpirationTimeInSeconds.