IOPAY→Developers→Split API
Sellers & distribuição

Split API

Central interna para organizar a integração de distribuição entre participantes, do cadastro dos sellers à conciliação do resultado.

Pré-requisitoSellers identificados
UsoDistribuição multi-participante
EstadoMigração de documentação
Modelo de integração Checklist Sellers →
Visão geral

Visão geral

Use Split quando uma operação precisa direcionar valores para múltiplos participantes dentro de um mesmo contexto de pagamento. A implementação deve partir de sellers previamente identificados e regras de distribuição compatíveis com o contrato da operação.

Participantes

Sellers identificados.

Cada destino precisa estar corretamente representado na plataforma.

Regra

Distribuição explícita.

Monte a composição do split de acordo com o modelo comercial e o contrato vigente.

Conciliação

Referência preservada.

Mantenha IDs internos para reconciliar pedido, transação e participantes.

Modelo de integração

Fluxo

01 · CadastroIdentifique sellers.

Garanta que cada participante esteja apto à operação.

02 · RegraMonte a distribuição.

Defina participantes e valores/percentuais conforme o contrato.

03 · PagamentoCrie a transação.

Leve a regra de split para o fluxo compatível com a API.

04 · FinanceiroReconcilie.

Use referências e eventos para acompanhar o resultado da operação.

Estrutura recomendada

Modelagem

Campo lógicoPara que serveBoa prática
reference_idCorrelacionar pagamento ao seu pedido/operação.Use um valor estável e único.
seller_idIdentificar o participante que receberá parte da operação.Valide o seller antes de montar o split.
amount / percentageRepresentar a regra de distribuição quando suportada pelo contrato.Evite arredondamentos ambíguos.
metadataContexto interno complementar quando disponível.Não armazene segredos ou dados sensíveis desnecessários.
Contrato de rotas. Os nomes exatos de campos e endpoints devem ser migrados da collection oficial para esta página antes de remover a referência externa de forma definitiva.
Checklist

Checklist

  • Sellers cadastrados e elegíveis para a operação.
  • Regra de distribuição validada com financeiro/comercial.
  • Validação de soma de valores/percentuais.
  • Referência interna de pedido preservada.
  • Webhooks conectados ao ciclo transacional.
  • Conciliação e tratamento de cancelamentos/estornos definidos.
Migração da documentação

Referência externa temporária

Enquanto a migração dos endpoints não estiver concluída, use a collection do Postman para conferir o contrato técnico.

Abrir collection técnica ↗