> ## 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.
# Listar splits
> Lista paginada dos splits da conta, com filtros por nome, ativação, chave de venda, checkout e período.
`GET /splits`
Faz parte do recurso [Splits](/pt-BR/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](/pt-BR/convencoes)).
**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
```bash theme={null}
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"
```
```json theme={null}
{
"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
}
}
```
## OpenAPI
````yaml openapi/psp.json GET /splits
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/splits:
get:
tags:
- Splits
summary: Listar splits
description: >-
Retorna a lista paginada dos splits da sua conta, do mais recente para o
mais antigo
operationId: SplitConfigController_list
parameters:
- name: page
in: query
required: false
description: 'Página da listagem. Padrão: 1.'
schema:
type: integer
minimum: 1
default: 1
description: 'Página da listagem. Padrão: 1.'
- name: limit
in: query
required: false
description: 'Itens por página. Padrão: 20. Máximo: 100.'
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: 'Itens por página. Padrão: 20. Máximo: 100.'
- name: name
in: query
required: false
description: >-
Busca parcial no nome do split, sem diferenciar maiúsculas de
minúsculas. Um valor por requisição.
schema:
type: string
nullable: true
description: >-
Busca parcial no nome do split, sem diferenciar maiúsculas de
minúsculas. Um valor por requisição.
- name: isActive
in: query
required: false
description: >-
Filtra por splits ativos (`true`) ou inativos (`false`). Omitido,
traz ambos.
schema:
type: string
enum:
- 'true'
- 'false'
description: >-
Filtra por splits ativos (`true`) ou inativos (`false`). Omitido,
traz ambos.
- name: salesKey
in: query
required: false
description: >-
Sua chave de venda associada ao split. Correspondência exata, um
valor por requisição.
schema:
type: string
nullable: true
description: >-
Sua chave de venda associada ao split. Correspondência exata, um
valor por requisição.
- name: checkoutId
in: query
required: false
description: >-
Retorna o split vinculado a este checkout. Correspondência exata, um
valor por requisição.
schema:
type: string
nullable: true
description: >-
Retorna o split vinculado a este checkout. Correspondência exata,
um valor por requisição.
- name: startDate
in: query
required: false
description: >-
Traz splits criados a partir deste instante (ISO 8601 com timezone),
inclusive.
schema:
type: string
format: date-time
nullable: true
description: >-
Traz splits criados a partir deste instante (ISO 8601 com
timezone), inclusive.
- name: endDate
in: query
required: false
description: >-
Traz splits criados até este instante (ISO 8601 com timezone),
inclusive.
schema:
type: string
format: date-time
nullable: true
description: >-
Traz splits criados até este instante (ISO 8601 com timezone),
inclusive.
responses:
'200':
description: Lista paginada de splits
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
description: Identificador único do registro.
name:
type: string
description: Nome do registro.
config:
type: array
items:
type: object
properties:
recipientId:
type: string
description: ID do recebedor.
type:
type: string
enum:
- sale
- interest
- platform_fee
description: >-
Categoria da parte do split: sale (venda),
interest (juros) ou platform_fee (taxa da
plataforma).
value:
type: number
description: >-
Valor da parte do split (percentual ou em
centavos, conforme valueType).
valueType:
type: string
description: 'Tipo do valor do split: percentage ou fixed.'
processingFee:
type: boolean
description: >-
Indica se esta parte arca com as taxas de
processamento.
liable:
type: boolean
description: >-
Indica se este recebedor é responsável por
chargebacks e estornos desta parte.
description: Regras de divisão do split por recebedor.
salesKey:
type: string
nullable: true
description: Chave de vendas (salesKey) associada ao split.
checkoutId:
type: string
nullable: true
description: ID do checkout vinculado à configuração de split.
isActive:
type: boolean
description: Indica se o registro está ativo.
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).
description: Lista de registros retornados na página atual.
pagination:
type: object
properties:
page:
type: integer
description: Página atual retornada.
limit:
type: integer
description: Quantidade de itens por página.
total:
type: integer
description: Total de itens que atendem ao filtro.
totalPages:
type: integer
description: Total de páginas disponíveis.
description: Dados de paginação do resultado.
example:
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
'400':
description: >-
Requisição inválida — algum parâmetro ou campo do corpo não passou
na validação
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.
issues:
type: array
description: >-
Um item por campo rejeitado. Nunca vem vazio: se há
400 de validação, há pelo menos um.
items:
type: object
properties:
path:
type: string
description: >-
Campo que falhou. Vem vazio quando o erro é do
corpo como um todo.
message:
type: string
description: O que há de errado com esse campo.
example:
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)
'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
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````