Buscar plano de split

Endpoint: GET /plans/plans/split/{id}/

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

Retorna o plano de split completo — incluindo as tabelas split_details (presencial / cartão presente) e split_details_online (online / digitada manualmente) — junto com a projeção aninhada do plano de taxa. Os planos de split são globais e são referenciados por identificador a partir de vendedores e transações.

Parâmetros de caminho

string (uuid)

required

Identificador único do plano de split, conforme retornado por GET /plans/plans/split/.

Resposta

string (uuid)

Identificador do plano de split.

string

Nome de exibição.

object

Projeção aninhada do plano de taxa — id, name, description.

string

Tabela de split presencial, JSON serializado como string. Formato: { payment_type: { installments: { card_brand: { participant_label: percentual } } } }. A chave de bandeira Todas as bandeiras % funciona como fallback quando a bandeira específica não está presente. O participante Programador corresponde à parcela do programador e é normalizado para um mínimo de 0.1 quando as tarifas são compiladas.

string

Tabela de split online, mesmo formato de split_details. Aplicada quando a transação é digitada manualmente / online.

boolean

Indica se a tarifa do programador é aplicada automaticamente quando os recebíveis são gerados. Valor padrão: true.

{
  "id": "5f1e2a4b-3c5d-4f6a-9b7c-1e2d3f4a5b6c",
  "name": "Comercio - Master 100",
  "zoop_tax_plan": {
    "id": "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
    "name": "Pro-Comercio-072022",
    "description": "Plano padrao para comercio"
  },
  "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}}}}",
  "automatic_developer_fee": true
}

Erros

Status	Quando
`401`	Cabeçalho `Authorization` ausente ou inválido.
`404`	Nenhum plano de split encontrado com o `id` informado.

Exemplos

curl https://api.dlpay.cloud/plans/plans/split/5f1e2a4b-3c5d-4f6a-9b7c-1e2d3f4a5b6c/ \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh..."

import requests

response = requests.get(
    "https://api.dlpay.cloud/plans/plans/split/5f1e2a4b-3c5d-4f6a-9b7c-1e2d3f4a5b6c/",
    headers={"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJh..."},
)
split_plan = response.json()

const response = await fetch(
  "https://api.dlpay.cloud/plans/plans/split/5f1e2a4b-3c5d-4f6a-9b7c-1e2d3f4a5b6c/",
  { headers: { Authorization: "Bearer eyJ0eXAiOiJKV1QiLCJh..." } }
);
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

Buscar plano de split

Parâmetros de caminho

Resposta

Erros

Exemplos

​Parâmetros de caminho

​Resposta

​Erros

​Exemplos

Parâmetros de caminho

Resposta

Erros

Exemplos