Criar plano de split

Endpoint: POST /plans/plans/split/

Autenticação: Obrigatória — JWT via Authorization: Bearer <access_token>.

Cria um novo plano de split. O plano de split é aplicado sobre um plano de taxa e define, para cada combinação de (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

string

required

Nome de exibição do plano de split. Aparece no painel e nos resultados de busca.

string (uuid)

required

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.

string

required

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 é:

{
  "<payment_type>": {            // "credit" | "debit"
    "<installments>": {          // "1" .. "N" como strings
      "<card_brand>": {          // ex.: "Visa", "MasterCard", "Elo"; ou "Todas as bandeiras %"
        "<participant_label>": <percentual>
      }
    }
  }
}

Convenções observadas em produção:

As chaves de bandeira podem ser uma bandeira específica (ex.: Visa, MasterCard) ou o curinga Todas 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 pix e boleto o resolvedor reescreve a busca internamente para debit / parcela 1 com bandeira PIX ou Boleto. Inclua essas chaves de bandeira em debit → 1 caso precise de divisões específicas para esses meios.

string

required

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

Retorna 201 Created com o registro persistido (a resposta da criação ecoa a entrada acrescida do id atribuído):

string (uuid)

Identificador único atribuído.

string

Nome do plano de split.

string (uuid)

Identificador do plano de taxa subjacente.

string

Tabela de split presencial, armazenada como JSON em string.

string

Tabela de split online, armazenada como JSON em string.

{
  "id": "5f1e2a4b-3c5d-4f6a-9b7c-1e2d3f4a5b6c",
  "name": "Comercio - Master 100",
  "zoop_tax_plan": "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
  "split_details": "{'credit': {'1': {'Todas as bandeiras %': {'Master': 1.0, 'Programador': 0.1}}, '12': {'Todas as bandeiras %': {'Master': 2.5, 'Programador': 0.1}}}, 'debit': {'1': {'Todas as bandeiras %': {'Master': 0.5, 'Programador': 0.1}, 'PIX': {'Master': 0.3, 'Programador': 0.1}, 'Boleto': {'Master': 1.5, 'Programador': 0.1}}}}",
  "split_details_online": "{'credit': {'1': {'Todas as bandeiras %': {'Master': 1.5, 'Programador': 0.1}}, '12': {'Todas as bandeiras %': {'Master': 3.0, 'Programador': 0.1}}}, 'debit': {'1': {'Todas as bandeiras %': {'Master': 0.8, 'Programador': 0.1}}}}"
}

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.

Exemplos

curl -X POST https://api.dlpay.cloud/plans/plans/split/ \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Comercio - Master 100",
    "zoop_tax_plan": "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
    "split_details": "{\"credit\": {\"1\": {\"Todas as bandeiras %\": {\"Master\": 1.0, \"Programador\": 0.1}}}}",
    "split_details_online": "{\"credit\": {\"1\": {\"Todas as bandeiras %\": {\"Master\": 1.5, \"Programador\": 0.1}}}}"
  }'

import json
import requests

split_details = {
    "credit": {
        "1": {"Todas as bandeiras %": {"Master": 1.0, "Programador": 0.1}}
    }
}
split_details_online = {
    "credit": {
        "1": {"Todas as bandeiras %": {"Master": 1.5, "Programador": 0.1}}
    }
}

response = requests.post(
    "https://api.dlpay.cloud/plans/plans/split/",
    headers={"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJh..."},
    json={
        "name": "Comercio - Master 100",
        "zoop_tax_plan": "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
        "split_details": json.dumps(split_details),
        "split_details_online": json.dumps(split_details_online),
    },
)
split_plan = response.json()

const splitDetails = {
  credit: { "1": { "Todas as bandeiras %": { Master: 1.0, Programador: 0.1 } } },
};
const splitDetailsOnline = {
  credit: { "1": { "Todas as bandeiras %": { Master: 1.5, Programador: 0.1 } } },
};

const response = await fetch("https://api.dlpay.cloud/plans/plans/split/", {
  method: "POST",
  headers: {
    Authorization: "Bearer eyJ0eXAiOiJKV1QiLCJh...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Comercio - Master 100",
    zoop_tax_plan: "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
    split_details: JSON.stringify(splitDetails),
    split_details_online: JSON.stringify(splitDetailsOnline),
  }),
});
const splitPlan = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Criar plano de split

Corpo da requisição

Resposta

Erros

Exemplos

​Corpo da requisição

​Resposta

​Erros

​Exemplos

Corpo da requisição

Resposta

Erros

Exemplos