Buscar venda rápida

curl --request GET \
  --url https://api.sandbox.z2pay.com/v1/checkout/charges/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.z2pay.com/v1/checkout/charges/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc",
  "linkId": null,
  "status": "paid",
  "mode": "payment",
  "currency": "BRL",
  "locale": "pt-BR",
  "config": {
    "paymentMethods": {
      "card": {
        "enabled": true,
        "installments": {
          "maxInstallments": 12
        }
      },
      "pix": {
        "enabled": true,
        "expiresIn": 3600
      }
    },
    "description": "Curso de Marketing Digital"
  },
  "customer": {
    "name": "Maria Souza",
    "email": "maria.souza@example.com",
    "document": "12345678909",
    "documentType": "cpf",
    "phone": "+5511988887777"
  },
  "customFieldValues": null,
  "paymentMethodSelected": "pix",
  "subtotal": 19900,
  "discountTotal": 0,
  "amount": 19900,
  "discounts": [],
  "paymentAttempts": 1,
  "transactionId": "txn_g1d59ic6u50u3jouf3v1v305e",
  "subscriptionId": null,
  "metadata": null,
  "createdAt": "2025-06-29T13:45:30.000Z",
  "updatedAt": "2025-06-29T13:52:10.000Z",
  "openedAt": "2025-06-29T13:46:02.000Z",
  "paidAt": "2025-06-29T13:52:10.000Z",
  "canceledAt": null,
  "expiresAt": "2025-06-30T13:45:30.000Z",
  "url": "https://checkout.z2pay.com.br/c/s/cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden — insufficient permissions"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Charge not found"
  }
}

GET

checkout

charges

{id}

Buscar venda rápida

curl --request GET \
  --url https://api.sandbox.z2pay.com/v1/checkout/charges/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.z2pay.com/v1/checkout/charges/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc",
  "linkId": null,
  "status": "paid",
  "mode": "payment",
  "currency": "BRL",
  "locale": "pt-BR",
  "config": {
    "paymentMethods": {
      "card": {
        "enabled": true,
        "installments": {
          "maxInstallments": 12
        }
      },
      "pix": {
        "enabled": true,
        "expiresIn": 3600
      }
    },
    "description": "Curso de Marketing Digital"
  },
  "customer": {
    "name": "Maria Souza",
    "email": "maria.souza@example.com",
    "document": "12345678909",
    "documentType": "cpf",
    "phone": "+5511988887777"
  },
  "customFieldValues": null,
  "paymentMethodSelected": "pix",
  "subtotal": 19900,
  "discountTotal": 0,
  "amount": 19900,
  "discounts": [],
  "paymentAttempts": 1,
  "transactionId": "txn_g1d59ic6u50u3jouf3v1v305e",
  "subscriptionId": null,
  "metadata": null,
  "createdAt": "2025-06-29T13:45:30.000Z",
  "updatedAt": "2025-06-29T13:52:10.000Z",
  "openedAt": "2025-06-29T13:46:02.000Z",
  "paidAt": "2025-06-29T13:52:10.000Z",
  "canceledAt": null,
  "expiresAt": "2025-06-30T13:45:30.000Z",
  "url": "https://checkout.z2pay.com.br/c/s/cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden — insufficient permissions"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Charge not found"
  }
}

GET /checkout/charges/{id} Faz parte do recurso Vendas rápidas — a relação com Link e Session está lá. Devolve a cobrança com o valor congelado na criação, o customer até onde foi preenchido, o metadata que você gravou e o transactionId.

Devolve o mesmo objeto de GET /checkout/sessions/{id} — é a mesma Session, alcançada por outro endereço. Chamar uma rota ou outra com o mesmo cs_ dá o mesmo resultado.

transactionId só existe a partir de paying. Antes disso a compra ainda não virou transação e o campo vem null. Veja Reconciliação.

Exemplo

curl https://api.sandbox.z2pay.com/v1/checkout/charges/cs_50b0abc54b632e7c57de3a73815413ace1d545dcd16da95c \
  -H "x-api-key: SUA_CHAVE_DE_SANDBOX"

Resposta 200

{
  "id": "cs_50b0abc54b632e7c57de3a73815413ace1d545dcd16da95c",
  "linkId": null,
  "status": "paid",
  "amount": 30000,
  "currency": "BRL",
  "customer": {
    "name": "Cliente X",
    "email": "x@example.com"
  },
  "transactionId": "txn_ebgsvfsb4151nmbgvj4sek6ol",
  "metadata": { "invoice_id": "inv_2026_01_joao" },
  "createdAt": "2026-06-24T12:00:00.000Z",
  "expiresAt": "2026-06-25T12:00:00.000Z",
  "url": "https://pay.sandbox.z2pay.com/c/cs_50b0abc54b632e7c57de3a73815413ace1d545dcd16da95c"
}

Authorizations

x-api-key

string

header

required

API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público

Path Parameters

string

required

ID da Session (cs_*)

Response

Venda rápida encontrada

string

Identificador único do registro.

linkId

string | null

Identificador do link de checkout que originou o registro; nulo em sessões ad-hoc.

status

string

Estado atual do registro.

mode

string

Modo do checkout: 'payment' (pagamento único) ou 'subscription' (assinatura).

currency

string

Moeda no padrão ISO 4217 (ex.: BRL).

locale

string

Idioma do checkout (ex.: pt-BR, en-US, es-ES).

config

object

Snapshot da configuração do checkout (formas de pagamento, itens e personalização visual).

customer

object | null

Dados do comprador (nome, e-mail, documento e demais informações).

customFieldValues

object | null

Valores preenchidos nos campos personalizados, indexados pela key de cada campo.

paymentMethodSelected

string | null

Forma de pagamento selecionada pelo comprador na sessão (ex.: credit_card, pix, boleto).

subtotal

integer

Soma dos itens antes dos descontos, em centavos.

discountTotal

integer

Total de descontos aplicados, em centavos.

amount

integer

Valor total a ser cobrado, em centavos.

discounts

object[] | null

Descontos aplicados ao valor da sessão.

paymentAttempts

integer

Quantidade de tentativas de pagamento realizadas na sessão.

transactionId

string | null

Identificador da transação gerada pelo pagamento da sessão; nulo até haver pagamento.

subscriptionId

string | null

Identificador da assinatura criada a partir da sessão; nulo até a ativação.

metadata

object | null

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

createdAt

string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt

string<date-time>

Data e hora da última atualização do registro (ISO 8601).

openedAt

string<date-time> | null

Data e hora em que a sessão foi aberta pelo comprador (ISO 8601); nula se ainda não aberta.

paidAt

string<date-time> | null

Data e hora em que o pagamento foi confirmado (ISO 8601); nula se não pago.

canceledAt

string<date-time> | null

Data e hora do cancelamento (ISO 8601); nula se não cancelado.

expiresAt

string<date-time>

Data e hora de expiração (ISO 8601).

url

string

URL pública do checkout para o comprador finalizar o pagamento.

Cobranças

Clientes & Cartões

Checkout

Cobrança recorrente

Split & Recebedores

Webhooks & Eventos

Valores & Taxas

Buscar venda rápida

Exemplo

Authorizations

Path Parameters

Response

​Exemplo

Authorizations

Path Parameters

Response

Exemplo