Skip to main content
Endpoint público chamado pelo frontend no momento da confirmação do pagamento. Valida os dados do comprador, processa o pagamento via gateway de pagamentos e atualiza o status do checkout. O comportamento varia conforme o método de pagamento:
  • Cartão de Crédito: Requer card_id (token obtido via SDK de tokenização do gateway no cliente) e número de parcelas (1–12)
  • PIX: Gera a transação PIX; o QR code fica disponível em zoop_payment_data (campo da API)

​
Autenticação

Endpoint público — não requer Authorization. Utiliza o client_secret como autenticação implícita.

​
Parâmetros de Path

​
client_secret
string
required
Segredo do cliente gerado na criação do checkout

​
Corpo da Requisição

​
customer_email
string
required
E-mail do comprador
​
customer_name
string
required
Nome completo do comprador
​
customer_tax_id
string
CPF ou CNPJ do comprador (obrigatório para pagamentos no Brasil)
​
customer_billing_address
object
Endereço de cobrança do comprador
​
payment_method
string
required
Método de pagamento. Valores: credit_card, pix
​
card_id
string
Token do cartão gerado pelo fluxo de tokenização do gateway (obrigatório quando payment_method = credit_card)
​
installments
integer
Número de parcelas de 1 a 12 (obrigatório quando payment_method = credit_card)
​
card_brand
string
Bandeira do cartão (ex: visa, mastercard). Opcional — quando informado, seleciona a faixa de tarifas correspondente. Se omitido, o BIN do cartão é utilizado para determinar a tarifa.
​
boleto_due_date
string
Data de vencimento do boleto no formato YYYY-MM-DD (opcional, apenas para boleto)

​
Resposta

O checkout atualizado com status, payment_method e zoop_payment_data contendo os detalhes da transação no gateway.
​
id
string
ID do checkout
​
status
string
Novo status: confirmed, succeeded ou failed
​
payment_method
string
Método utilizado: credit_card ou pix
​
zoop_payment_data
object
Dados retornados pelo gateway: transaction_id, status, authorization_code, payment_method, etc.

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/checkouts/client/chks_secret_xyz/confirm" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_email": "[email protected]",
    "customer_name": "João Silva",
    "customer_tax_id": "12345678901",
    "payment_method": "pix"
  }'

​
Resposta de Exemplo

{
  "id": "chk_1a2b3c4d5e6f",
  "status": "succeeded",
  "payment_method": "credit_card",
  "amount": 29700,
  "currency": "BRL",
  "zoop_payment_data": {
    "transaction_id": "txn_abc123",
    "status": "succeeded",
    "authorization_code": "AUTH789",
    "installments": 3,
    "payment_method": {
      "card_brand": "visa",
      "last4_digits": "1111"
    }
  }
}

​
Erros Comuns

CódigoDescrição
404Checkout não encontrado
410Checkout expirado
422Campos obrigatórios ausentes ou inválidos
400Cupom de desconto inválido