Pular para o conteúdo
Referência

Split

Recebedores, regras de divisão e repasses.

Exige o produto SPLIT ativo para a empresa em Produção. No Sandbox basta não estar desativado.
GET/v1/split/recipients

Lista recebedores

Escopo marketplace.manage
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
POST/v1/split/recipients

Cadastra recebedor

Escopo marketplace.manage
Corpo (JSON)
nameobrigatório
stringNome.
documentobrigatório
CPF/CNPJValidado.
email
e-mailE-mail.
bankCode / branch / accountobrigatório
stringBanco (3 dígitos), agência e conta.
GET/v1/split/recipients/:id

Consulta recebedor

Escopo marketplace.manage
PATCH/v1/split/recipients/:id

Atualiza recebedor

Escopo marketplace.manage
DELETE/v1/split/recipients/:id

Remove recebedor (com uso, apenas desativa)

Escopo marketplace.manage
GET/v1/split/rules

Lista regras

Escopo marketplace.manage
POST/v1/split/rules

Cria regra de split

Escopo marketplace.manage
Corpo (JSON)
nameobrigatório
stringNome da regra.
active
booleanoPadrão true.
itemsobrigatório
lista (2–20)recipientId (null = sua empresa), percentBps ou fixedAmount, priority, chargeFees, chargeRemainder.
GET/v1/split/rules/:id

Consulta regra

Escopo marketplace.manage
PATCH/v1/split/rules/:id

Atualiza regra

Escopo marketplace.manage
DELETE/v1/split/rules/:id

Remove regra (já usada, apenas desativa)

Escopo marketplace.manage
POST/v1/split/simulate

Simula a divisão de um valor

Escopo marketplace.manage
GET/v1/split/transfers

Repasses aos recebedores

Escopo marketplace.manage
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).