Pagamentos

Métodos de Pagamento

Listar métodos habilitados (Admin)

GET /api/admin/order/paymentMethods

Listar métodos habilitados (Client)

GET /api/client/order/paymentMethods

Gerenciar métodos (Admin — role setting)

GET    /api/admin/paymentMethods
POST   /api/admin/paymentMethods
PUT    /api/admin/paymentMethods/{id}
DELETE /api/admin/paymentMethods/{id}

---

Pix

Verificar status da cobrança Pix

POST /api/admin/pix/{orderId}

Retorna o status atual da cobrança Pix gerada para o pedido. A cobrança Pix é criada automaticamente quando o cliente seleciona Pix como forma de pagamento ao criar um pedido.

Fluxo Pix:

1. Cliente cria pedido com payment_method = pix

2. API gera cobrança e retorna pix_qr_code e pix_copy_paste

3. Cliente paga via app do banco

4. Gateway notifica a API via webhook

5. Pedido é atualizado automaticamente

---

PicPay

Webhook PicPay

POST /api/admin/picpay

Endpoint público (sem autenticação) chamado pelo gateway PicPay para notificar pagamentos confirmados.

Fluxo PicPay:

1. Cliente cria pedido com payment_method = picpay

2. API retorna link de pagamento PicPay

3. Cliente acessa o link e paga no app PicPay

4. PicPay chama o webhook acima

5. Pedido é atualizado automaticamente

---

Cartão de Crédito

Processar transação

POST /api/client/transactions

Body:

{
  "card_number": "4111111111111111",
  "card_holder_name": "JOAO SILVA",
  "card_expiration_date": "12/26",
  "card_cvv": "123",
  "installments": 1,
  "amount": 5990
}

Erros possíveis: CARD_NOT_VALID, PAYMENT_TRANSACTION_DENIED.

Dados de cartões salvos (Admin)

GET    /api/admin/creditCards
DELETE /api/admin/creditCards/{id}

---

Dinheiro / Outros

Pagamentos em dinheiro e outros métodos presenciais não requerem integração — o campo payment_method_id no pedido já identifica a forma de pagamento selecionada.

---

Configuração de Pagamento (Client)

GET /api/client/payment-config

Retorna as chaves públicas e configurações necessárias para inicializar o gateway de pagamento no frontend.

---

Pagamento em Comanda (Client)

POST /api/client/board-sessions/{uuid}/payments

Body:

{
  "payment_method_id": 1,
  "amount": 4500
}