Inicia uma cobrança TEF ou Pix

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

Cria o registro StoreFrontCashierPayment (status inicial Pendente) e dispara a cobrança no provedor configurado pela integração da conta bancária (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 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 sistema usa esse valor para ligar a tentativa ao pedido. Quando omite, o sistema gera um UUID novo e devolve no body. Esse UUID é o que casa com 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

200

Cobrança iniciada (status retornado = 2 Em pagamento). PayGo (TEF) retorna IDStoreFrontCashierPayment, IDOrderIntention, IDTypeStatusStoreFrontCashierPayment e ExternalId. Pix (StarkBank/Pagar.me) retorna ainda PixCopiaCola, QrCodeImageUrl e QrcodeExpirationTimeInSeconds; Pagar.me inclui também o TID.

400

Erros de validação (prefixo [BadRequest]):

• Necessário enviar dados para cobrança
• Precisa enviar o valor, conta bancária e código do tipo de pagamento
• Conta bancária não localizada
• Conta bancária não tem integração selecionada
• Conta bancária não tem integração configurada
• Tipo pagamento <id> não encontrado
• Tipo de pagamento <id> inválido (categoria recebida: <cat>), permitido apenas crédito, débito e Pix
• Conta bancária não tem terminal TEF preenchido (PayGo)
• Token integração TEF não esta preenchido (PayGo)
• Erro ao conectar ao terminal TEF. Verificar conexão da máquininha (PIN PAD) com computador, internet e aplicativo paygo (PayGo, status 15)
• Integração Pagarme no PDV suporta apenas Pix (Pagar.me, categoria ≠ 24)
• Integração não suportada para este fluxo de pagamento
• <mensagem do adquirente> (quando o provedor recusa a cobrança)

500

Erro interno inesperado (prefixo Error:).