Capturar dados parciais do comprador

curl --request POST \
  --url https://checkout-api.sandbox.z2pay.com/public/checkout/{id}/updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "document": "<string>",
    "phone": "<string>",
    "address": {
      "zipCode": "<string>",
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "BR"
    }
  },
  "customFieldsValues": {},
  "sessionId": "<string>"
}
'

Comprador

Capturar dados parciais do comprador

Captura progressiva dos dados do comprador (nome, email, documento, telefone, endereço, custom fields, método pré-selecionado) enquanto ele preenche o form — debounce 1s no front + navigator.sendBeacon no unload. Transita status opened → filling na primeira chamada; idempotente em filling → filling. Merge inteligente: campos ausentes no body NÃO apagam o que já estava salvo. Em estados terminais ou já-em-processamento (paid/expired/canceled/paying), é no-op silencioso. NUNCA aceita dados de cartão — esses só vão tokenizados no /confirm. Fires checkout.session.draft_updated. Rate limit 120/min comporta debounce + buffer pra mobile.

POST

public

checkout

{id}

updated

Capturar dados parciais do comprador

curl --request POST \
  --url https://checkout-api.sandbox.z2pay.com/public/checkout/{id}/updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "document": "<string>",
    "phone": "<string>",
    "address": {
      "zipCode": "<string>",
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "BR"
    }
  },
  "customFieldsValues": {},
  "sessionId": "<string>"
}
'

Parâmetros de caminho

string

obrigatório

ID da Session (cs_), do Link (chk_) ou slug (URL amigável) — Link/slug materializam Session on-the-fly (checkout estático)

Corpo

application/json

customer

object

Show child attributes

customFieldsValues

object

Show child attributes

paymentMethodSelected

enum<string>

Opções disponíveis:

credit_card,

pix,

boleto,

combined

sessionId

string

Pattern: ^cs_[0-9a-f]{48}$

Resposta

Snapshot atual da Session após merge

Marcar Session como aberta Adicionar nova forma de pagamento

⌘I