Autenticação: Obrigatória — JWT via
Authorization: Bearer <access_token>.(payment_type, installment_count, card_brand), quais participantes recebem qual porcentagem da receita do vendedor. Duas tabelas paralelas são armazenadas — uma para transações presenciais / com cartão presente (split_details) e outra para transações online / digitadas manualmente (split_details_online).
Os planos de split são globais: não são vinculados a um vendedor específico e o registro criado fica imediatamente disponível para qualquer vendedor que o referencie. A criação não aceita o campo automatic_developer_fee como entrada — ele assume true por padrão no registro.
Corpo da requisição
Nome de exibição do plano de split. Aparece no painel e nos resultados de busca.
Identificador do plano de taxa subjacente cujas células
(type, installment, brand) este plano de split irá distribuir. Utilize GET /plans/plans/zoop/ para listar candidatos.Documento JSON serializado como string descrevendo a tabela de split para transações presenciais / com cartão presente. Aspas simples são aceitas e normalizadas para aspas duplas antes da análise. O formato esperado é:Convenções observadas em produção:
- As chaves de bandeira podem ser uma bandeira específica (ex.:
Visa,MasterCard) ou o curingaTodas as bandeiras %, usado como fallback quando uma bandeira específica não está listada. - Os rótulos de participante são strings livres em português — tipicamente
Programador(parcela do programador), além dos rótulos definidos pelo operador para o master, o agente e eventuais subagentes. Os valores são percentuais sobre o montante capturado. - A entrada
Programador, quando presente, recebe tratamento especial: ela é removida dos totais de agente/master e direcionada para a conta do programador. - Para
pixeboletoo resolvedor reescreve a busca internamente paradebit/ parcela1com bandeiraPIXouBoleto. Inclua essas chaves de bandeira emdebit→1caso precise de divisões específicas para esses meios.
Mesmo formato de
split_details, aplicado quando a transação é online / digitada manualmente (checkout online, e-commerce, link de pagamento). Armazenado de forma independente para que transações presenciais e não presenciais possam ter divisões distintas.Resposta
Retorna201 Created com o registro persistido (a resposta da criação ecoa a entrada acrescida do id atribuído):
Identificador único atribuído.
Nome do plano de split.
Identificador do plano de taxa subjacente.
Tabela de split presencial, armazenada como JSON em string.
Tabela de split online, armazenada como JSON em string.
Erros
| Status | Quando |
|---|---|
400 | Campo obrigatório ausente, ou zoop_tax_plan não corresponde a nenhum plano de taxa existente. |
401 | Cabeçalho Authorization ausente ou inválido. |