> ## 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 split por ID
> Retorna uma configuração de divisão e as regras que ela carrega.
`GET /splits/:id`
Faz parte do recurso [Splits](/pt-BR/splits) — as regras de validação do array `config` estão lá.
Devolve a configuração com o array `config` completo: quem recebe, quanto, e quem carrega a taxa e o
risco de chargeback.
**Isto é a regra, não o que foi pago.** A configuração pode ter sido alterada depois de uma venda,
e o que cada recebedor efetivamente recebeu está na transação, não aqui. Para auditar dinheiro,
parta da [transação](/pt-BR/transactions/get).
**A resposta não diz se os recebedores continuam aptos.** O `config` guarda os `rec_` como estavam
na criação; se um deles perdeu a aptidão depois, a configuração continua igual e é a **cobrança**
que passa a falhar. Ver [`GET /recipients`](/pt-BR/recipients/list).
## Exemplo
```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/splits/spl_t8k3nzc1qvre6y0wjaxm5fdbh \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json Resposta 200 theme={null}
{
"id": "spl_t8k3nzc1qvre6y0wjaxm5fdbh",
"name": "Marketplace — 80/20",
"isActive": true,
"salesKey": null,
"checkoutId": null,
"config": [
{
"recipientId": "rec_v57bi6ruyolouw3cpaq2ofy1k",
"value": 80,
"valueType": "percentage",
"type": "sale",
"processingFee": true,
"liable": true
},
{
"recipientId": "rec_h2q8dm4xzkw05rbvtsc7jyneo",
"value": 20,
"valueType": "percentage",
"type": "platform_fee",
"processingFee": false,
"liable": false
}
],
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-11T12:00:00.000Z"
}
```
## OpenAPI
````yaml openapi/psp.json GET /splits/{id}
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/{id}:
get:
tags:
- Splits
summary: Buscar split por ID
description: Retorna um split e as regras de divisão que ele carrega
operationId: SplitConfigController_getById
parameters:
- name: id
in: path
required: true
description: ID do split
schema:
type: string
responses:
'200':
description: Dados do split
content:
application/json:
schema:
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).
example:
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'
'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
'404':
description: Split não encontrado
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: Split not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````