Skip to main content
POST
Criar split
POST /splits Faz parte do recurso Splits — as regras de validação do array config estão lá, e o modelo com exemplos numéricos em Split. Salva a configuração para reusar: depois de criada, basta passar o spl_ em payments[].splitId ao criar a transação. Criar um split não move dinheiro nenhum — ele só descreve a divisão.
Os recebedores precisam existir e estar vinculados à sua conta. A validação recusa em dois níveis: 404 se algum recipientId não existe; 400 se existe mas não está vinculado.O status do vínculo não é conferido aqui: dá para salvar um split com um recebedor ainda pending (ou até refused), e o erro só aparece na cobrança que usar o split — com mensagem genérica de propósito, porque ela sobe até a página de checkout e o comprador final não pode ver o status cadastral de terceiros. Antes de vender, confira os vínculos em GET /recipients.
processingFee e liable são obrigatórios em quem os carrega. Exatamente um item precisa marcar cada um: quem arca com a taxa de processamento e quem responde por chargebacks. Não é preferência — o adquirente recusa a venda sem um responsável definido.
A soma dos percentuais tem de fechar em 100. Só entram nessa conta os itens valueType: "percentage" — os fixed ficam de fora. A tolerância é de 0,01.
isActive: false guarda a regra sem colocá-la em uso. Serve para montar a divisão antes de ela valer.

Exemplo

Resposta 201

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Body

application/json
name
string
required

Nome de identificação da configuração de split.

Minimum string length: 1
config
object[]
required

Regras de divisão: como o valor é repartido entre os recebedores.

Minimum array length: 1
salesKey
string | null

Chave de vendas (salesKey) para vincular/identificar este split.

checkoutId
string | null

ID do checkout vinculado a este split.

isActive
boolean
default:true

Define se a configuração de split está ativa.

Response

Split criado

id
string

Identificador único do registro.

name
string

Nome do registro.

config
object[]

Regras de divisão do split por recebedor.

salesKey
string | null

Chave de vendas (salesKey) associada ao split.

checkoutId
string | null

ID do checkout vinculado à configuração de split.

isActive
boolean

Indica se o registro está ativo.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).