Listar splits
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/splits \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/splits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/splits"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "spl_rja7dpb3xfyccdg7ukuicd0am",
"name": "Split padrão produtores",
"config": [
{
"recipientId": "rec_tazseadvfg6aym95njwzvc6fs",
"type": "sale",
"value": 80,
"valueType": "percentage",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_guuh4ppadxc0n47i82fuseq5u",
"type": "platform_fee",
"value": 20,
"valueType": "percentage",
"processingFee": false,
"liable": false
}
],
"salesKey": "SALES-2025-ABC",
"checkoutId": "chk_yi65vojl1sh936l7b93tdg8ix",
"isActive": true,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}
],
"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"
}
}Splits
Listar splits
Lista paginada dos splits da conta, com filtros por nome, ativação, chave de venda, checkout e período.
GET
/
splits
Listar splits
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/splits \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/splits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/splits"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "spl_rja7dpb3xfyccdg7ukuicd0am",
"name": "Split padrão produtores",
"config": [
{
"recipientId": "rec_tazseadvfg6aym95njwzvc6fs",
"type": "sale",
"value": 80,
"valueType": "percentage",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_guuh4ppadxc0n47i82fuseq5u",
"type": "platform_fee",
"value": 20,
"valueType": "percentage",
"processingFee": false,
"liable": false
}
],
"salesKey": "SALES-2025-ABC",
"checkoutId": "chk_yi65vojl1sh936l7b93tdg8ix",
"isActive": true,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}
],
"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"
}
}GET /splits
Faz parte do recurso Splits — as regras de divisão e o que a validação exige
estão lá.
Retorna os splits da sua conta do mais antigo para o mais recente, paginados: limit vem 20
por padrão e aceita até 100. Nada no corpo avisa que houve corte — confira
pagination.totalPages antes de concluir que a lista acabou. Todos os filtros são opcionais e
podem ser combinados; as datas seguem ISO 8601 com timezone (veja
Convenções).
Filtro com valor inválido responde
400, não é ignorado. ?isActive=talvez recusa a
requisição inteira, sem devolver resultado parcial.name faz busca parcial; salesKey e checkoutId exigem o valor exato. As datas incidem
sobre a criação do split — não sobre as transações que o usaram.Exemplo
curl -G https://api.sandbox.z2pay.com/v1/splits \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
--data-urlencode "isActive=true" \
--data-urlencode "limit=20"
{
"data": [
{
"id": "spl_rja7dpb3xfyccdg7ukuicd0am",
"name": "Split padrão produtores",
"config": [
{
"recipientId": "rec_tazseadvfg6aym95njwzvc6fs",
"type": "sale",
"value": 80,
"valueType": "percentage",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_guuh4ppadxc0n47i82fuseq5u",
"type": "platform_fee",
"value": 20,
"valueType": "percentage",
"processingFee": false,
"liable": false
}
],
"isActive": true
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}
Authorizations
API Key da Credential (gerada no Backoffice)
Query Parameters
Página da listagem. Padrão: 1.
Required range:
x >= 1Itens por página. Padrão: 20. Máximo: 100.
Required range:
1 <= x <= 100Busca parcial no nome do split, sem diferenciar maiúsculas de minúsculas. Um valor por requisição.
Filtra por splits ativos (true) ou inativos (false). Omitido, traz ambos.
Available options:
true, false Sua chave de venda associada ao split. Correspondência exata, um valor por requisição.
Retorna o split vinculado a este checkout. Correspondência exata, um valor por requisição.
Traz splits criados a partir deste instante (ISO 8601 com timezone), inclusive.
Traz splits criados até este instante (ISO 8601 com timezone), inclusive.