Skip to main content
Um split é uma regra reutilizável que descreve como dividir o valor de uma transação entre seus recebedores. Você cria a configuração uma vez e a referencia depois ao criar transações. O vínculo com o dinheiro é por pagamento, não por transação: ao criar a transação, cada item de payments[] aceita splitId (referência a uma configuração salva, prefixo spl_) ou split (a mesma regra inline). Os dois no mesmo pagamento são recusados — é um ou outro.
Todas as requisições usam o header x-api-key. Veja Autenticação. A base URL de sandbox é https://api.sandbox.z2pay.com/v1.
O modelo conceitual da divisão, com exemplos numéricos passo a passo, está em Split.

​
Endpoints

​
Regras do array config

Um split tem um name, opcionalmente vínculos com vendas/checkout, e um array config com as regras de divisão. O que cada campo do item significa está no playground de Criar split; o que a validação exige do array inteiro está aqui.
Violar qualquer uma destas retorna 400:
  • Pelo menos 1 item de split é obrigatório.
  • Exatamente 1 item com processingFee: true — é quem arca com a taxa de processamento.
  • Exatamente 1 item com liable: true — é quem responde por chargebacks.
  • Se houver pelo menos um item com valueType: "percentage", a soma dos value desses itens percentuais deve ser exatamente 100 (tolerância de 0.01). Itens fixed não entram nessa soma.

​
Veja também

Split (valores)

Modelo conceitual e exemplos numéricos passo a passo da divisão.

Recebedores

Cadastre os recebedores referenciados em recipientId.

Transações

Aplique um split ao criar uma transação.

Erros

Formato dos erros e como tratar 400 / 404.