> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar venda rápida
> Retorna uma cobrança individual pelo cs_ — estado, valor, comprador e a transação ligada.
`GET /checkout/charges/{id}`
Faz parte do recurso [Vendas rápidas](/pt-BR/checkout/charges) — 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}`](/pt-BR/checkout/links/session-get)** —
é 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](/pt-BR/checkout/links#reconciliação).
## Exemplo
```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/checkout/charges/cs_50b0abc54b632e7c57de3a73815413ace1d545dcd16da95c \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json Resposta 200 theme={null}
{
"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"
}
```
## OpenAPI
````yaml openapi/checkout.json GET /checkout/charges/{id}
openapi: 3.0.3
info:
title: Z2Pay Checkout API
version: 1.0.0
description: >-
API pública dedicada do Checkout. Autenticação via header x-api-key com a
API key unificada da conta (z2_{live|test}_{sk|pk}_...). Endpoints privados
exigem uma key secret (sk); endpoints públicos aceitam a key publishable
(pk) consumida pelo frontend do comprador.
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Checkout Links
description: Checkout Links (integração API via sk_)
- name: Checkout Sessions
description: Checkout Sessions (integração API via sk_)
- name: Vendas rápidas
description: Cobrança individual sem Link — Sessions ad-hoc criadas com a chave secreta
paths:
/checkout/charges/{id}:
get:
tags:
- Vendas rápidas
summary: Buscar venda rápida
description: >-
Retorna a venda rápida inteira. É o mesmo corpo de `GET
/checkout/sessions/{id}` — a venda rápida é uma Session sem `linkId`.
operationId: CheckoutChargeApiController_getById
parameters:
- name: id
in: path
required: true
description: ID da Session (cs_*)
schema:
type: string
responses:
'200':
description: Venda rápida encontrada
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
linkId:
type: string
nullable: true
description: >-
Identificador do link de checkout que originou o registro;
nulo em sessões ad-hoc.
status:
type: string
description: Estado atual do registro.
mode:
type: string
description: >-
Modo do checkout: 'payment' (pagamento único) ou
'subscription' (assinatura).
currency:
type: string
description: 'Moeda no padrão ISO 4217 (ex.: BRL).'
locale:
type: string
description: 'Idioma do checkout (ex.: pt-BR, en-US, es-ES).'
config:
type: object
description: >-
Snapshot da configuração do checkout (formas de pagamento,
itens e personalização visual).
customer:
type: object
nullable: true
description: >-
Dados do comprador (nome, e-mail, documento e demais
informações).
customFieldValues:
type: object
nullable: true
description: >-
Valores preenchidos nos campos personalizados, indexados
pela key de cada campo.
paymentMethodSelected:
type: string
nullable: true
description: >-
Forma de pagamento selecionada pelo comprador na sessão
(ex.: credit_card, pix, boleto).
subtotal:
type: integer
description: Soma dos itens antes dos descontos, em centavos.
discountTotal:
type: integer
description: Total de descontos aplicados, em centavos.
amount:
type: integer
description: Valor total a ser cobrado, em centavos.
discounts:
type: array
items:
type: object
nullable: true
description: Descontos aplicados ao valor da sessão.
paymentAttempts:
type: integer
description: >-
Quantidade de tentativas de pagamento realizadas na
sessão.
transactionId:
type: string
nullable: true
description: >-
Identificador da transação gerada pelo pagamento da
sessão; nulo até haver pagamento.
subscriptionId:
type: string
nullable: true
description: >-
Identificador da assinatura criada a partir da sessão;
nulo até a ativação.
metadata:
type: object
nullable: true
description: >-
Metadados livres (pares chave-valor) para uso do
integrador; não afeta o processamento.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
openedAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora em que a sessão foi aberta pelo comprador (ISO
8601); nula se ainda não aberta.
paidAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora em que o pagamento foi confirmado (ISO 8601);
nula se não pago.
canceledAt:
type: string
format: date-time
nullable: true
description: >-
Data e hora do cancelamento (ISO 8601); nula se não
cancelado.
expiresAt:
type: string
format: date-time
description: Data e hora de expiração (ISO 8601).
url:
type: string
description: >-
URL pública do checkout para o comprador finalizar o
pagamento.
example:
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
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'403':
description: >-
A chave é válida, mas não tem permissão para esta operação — é o
caso de usar uma publishable key (pk) onde a rota exige uma secret
key (sk)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: FORBIDDEN
message: Forbidden — insufficient permissions
'404':
description: Venda rápida não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Charge not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: >-
API key unificada (z2_{live|test}_{sk|pk}_...) — secret (sk) para
integração backend, publishable (pk) para uso no frontend público
````