Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint público de update. Usado pelo browser do comprador (na hosted page ou no seu frontend) pra atualizar dados que o cliente preenche progressivamente — email, CPF, endereço, cupons. Só funciona enquanto a sessão está em status: "open". Depois do confirm, a sessão fica imutável.

​
Autenticação

Nenhuma. O client_secret na URL é a credencial. 
curl -X PATCH "https://api.chargefy.io/v1/checkout-sessions/public/{{CLIENT_SECRET}}" \
  -H "Content-Type: application/json" \
  -d '{ "customer_email": "nome@email.com" }'

​
Corpo

Todos os campos são opcionais — envie só o que quer atualizar.
​
customer_email
string
Email do comprador.
​
customer_name
string
Nome completo.
​
customer_tax_id
string
CPF ou CNPJ.
​
is_business_customer
boolean
true se o comprador é pessoa jurídica (CNPJ).
​
customer_billing_name
string
Nome de cobrança (caso difira do nome do comprador — ex: razão social).
​
customer_billing_address
object
Endereço de cobrança. Estrutura: { line1, line2?, city, state, postal_code, country }.
​
customer_ip_address
string
IP do comprador. Usado em antifraude do cartão de crédito.
​
customer_metadata
object
Bag livre com dados extras do cliente. Mesclado com o que já existe (não substitui).
​
metadata
object
Bag livre da sessão. Mesclado com o que já existe.
​
discount_id
string
Aplica um desconto pré-cadastrado da org.
​
allow_discount_codes
boolean
Liga/desliga o campo de cupom na hosted page.
​
require_billing_address
boolean
Exige endereço de cobrança no form.
​
success_url
string
Atualiza a URL de sucesso pós-pagamento.
​
cancel_url
string
Atualiza a URL de cancelamento.
​
amount
integer
Atualiza o valor unitário do primeiro line item (em centavos). Recomputa amount_subtotal e amount_total da sessão.
​
quantity
integer
Atualiza a quantidade do primeiro line item. Recomputa os totais.
amount e quantity editam só o primeiro line item — útil pra “pague quanto quiser” / quantidade por assento. Não dá pra editar line items individualmente; o jeito de mudar a estrutura é criar uma nova session.

​
Resposta

Retorna o DTO completo da sessão atualizada — mesmo shape de GET e POST.

​
Exemplo

curl -X PATCH "https://api.chargefy.io/v1/checkout-sessions/public/{{CLIENT_SECRET}}" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_email": "nome@email.com",
    "customer_name": "Cliente",
    "customer_tax_id": "123.456.789-00",
    "metadata": { "step": "form-completed" }
  }'

​
Erros

HTTPRazão
400client_secret ausente
400amount ou quantity em sessão sem line items
403Sessão não está em status: "open" (já confirmada ou expirou)
404Checkout session não encontrada