Skip to main content
GET
Listar splits
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

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
name
string | null

Busca parcial no nome do split, sem diferenciar maiúsculas de minúsculas. Um valor por requisição.

isActive
enum<string>

Filtra por splits ativos (true) ou inativos (false). Omitido, traz ambos.

Available options:
true,
false
salesKey
string | null

Sua chave de venda associada ao split. Correspondência exata, um valor por requisição.

checkoutId
string | null

Retorna o split vinculado a este checkout. Correspondência exata, um valor por requisição.

startDate
string<date-time> | null

Traz splits criados a partir deste instante (ISO 8601 com timezone), inclusive.

endDate
string<date-time> | null

Traz splits criados até este instante (ISO 8601 com timezone), inclusive.

Response

Lista paginada de splits

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.