curl --request GET \
--url https://api.sandbox.z2pay.com/v1/checkout/links \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/checkout/links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/checkout/links"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "chk_byd8p3p79re859jpkmr0j65n3",
"slug": "curso-marketing-digital",
"status": "active",
"mode": "payment",
"currency": "BRL",
"locale": "pt-BR",
"name": "Curso de Marketing Digital",
"description": "Acesso vitalício ao curso completo",
"sellable": true,
"config": {
"items": [
{
"name": "Curso de Marketing Digital",
"quantity": 1,
"unitAmount": 49700,
"chargeType": "one_time"
}
],
"paymentMethods": {
"card": {
"enabled": true
},
"pix": {
"enabled": true
}
}
},
"requiredFields": [
"email",
"document",
"phone"
],
"customFields": null,
"successUrl": "https://academia.com/obrigado",
"cancelUrl": null,
"metadata": null,
"expirationMinutes": 1440,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z",
"url": "https://pay.z2pay.com/c/curso-marketing-digital"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"issues": [
{
"path": "status",
"message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
},
{
"path": "startDate",
"message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden — insufficient permissions"
}
}Listar checkout links
Lista paginada dos seus templates de cobrança, com filtros por status, tipo e nome de item.
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/checkout/links \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/checkout/links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/checkout/links"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "chk_byd8p3p79re859jpkmr0j65n3",
"slug": "curso-marketing-digital",
"status": "active",
"mode": "payment",
"currency": "BRL",
"locale": "pt-BR",
"name": "Curso de Marketing Digital",
"description": "Acesso vitalício ao curso completo",
"sellable": true,
"config": {
"items": [
{
"name": "Curso de Marketing Digital",
"quantity": 1,
"unitAmount": 49700,
"chargeType": "one_time"
}
],
"paymentMethods": {
"card": {
"enabled": true
},
"pix": {
"enabled": true
}
}
},
"requiredFields": [
"email",
"document",
"phone"
],
"customFields": null,
"successUrl": "https://academia.com/obrigado",
"cancelUrl": null,
"metadata": null,
"expirationMinutes": 1440,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z",
"url": "https://pay.z2pay.com/c/curso-marketing-digital"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"issues": [
{
"path": "status",
"message": "Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded"
},
{
"path": "startDate",
"message": "Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z)"
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden — insufficient permissions"
}
}GET /checkout/links
Faz parte do recurso Links — o conceito e os estados estão lá.
Devolve os templates da sua conta, do mais recente para o mais antigo, em páginas de 20 por padrão
(máximo 100). Os filtros são opcionais e se somam: quem envia mais de um recebe só os Links que
atendem a todos. Cada item traz o mesmo objeto de
GET /checkout/links/{id}, incluindo a url pronta para divulgar.
active e archived juntos —
arquivar muda o estado, não remove o registro. Para ver só o que está no ar, use
?status=active.status aceita mais de um valor, separados por vírgula: ?status=active,archived. Um valor
fora da lista responde 400 com os aceitos.status enxerga só a sua decisão de arquivar. Um
Link active com sellable: false continua aparecendo como qualquer outro — é preciso ler o
campo sellable de cada item. Veja
Do Link à Session.Exemplo
curl -G https://api.sandbox.z2pay.com/v1/checkout/links \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-d status=active \
-d itemName=curso \
-d page=1 \
-d limit=20
{
"data": [
{
"id": "chk_byd8p3p79re859jpkmr0j65n3",
"name": "Curso de Backend",
"status": "active",
"sellable": true,
"mode": "payment",
"currency": "BRL",
"url": "https://pay.sandbox.z2pay.com/c/chk_byd8p3p79re859jpkmr0j65n3",
"createdAt": "2026-06-24T12:00:00.000Z",
"updatedAt": "2026-06-24T12:00:00.000Z"
}
],
"pagination": { "page": 1, "limit": 20, "total": 12, "totalPages": 1 }
}
Authorizations
API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público
Query Parameters
Página da listagem. Padrão: 1.
x >= 1Itens por página. Padrão: 20. Máximo: 100.
1 <= x <= 100Situação do Link: active ou archived. Aceita vários valores, separados por vírgula ou repetindo o parâmetro. Um valor inválido responde 400 com a lista dos aceitos.
active, archived Tipo do Link: payment (cobrança única) ou subscription (assinatura). Omitido, traz os dois.
payment, subscription Links que tenham algum item cujo nome case parcialmente com o texto. Filtra o Link, não o item.
255Apenas Links de assinatura com período de teste (true) ou apenas sem (false). Omitido, traz os dois.
true, false Campo de ordenação: createdAt ou name. Default: createdAt.
createdAt, name Direção da ordenação: asc ou desc. Default: desc.
asc, desc