Buscar plano de taxa

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

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

Retorna o plano de taxa completo, incluindo um objeto details calculado a partir das tarifas configuradas. A resposta apresenta um conjunto estruturado (brands, types, fees) pronto para renderizar uma tabela de tarifas em uma interface. Os planos de taxa são globais — o mesmo id pode ser referenciado por qualquer plano de split e por qualquer vendedor que adote essa tabela de tarifas. Este endpoint não aplica filtragem por vendedor.

Parâmetros de caminho

string (uuid)

required

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

Resposta

string (uuid)

Identificador do plano.

string

Nome do plano.

string | null

Descrição opcional.

object

Tabela de tarifas compilada.

brands — lista ordenada de bandeiras de cartão extraídas das tarifas configuradas (ex.: Visa, MasterCard, Elo).
types — valores fixos ["debit", "credit"].
fees — mapa aninhado fees[payment_type][installment_count][card_brand] cujas folhas são arrays de entradas de tarifa. Cada entrada inclui campos como source, capture_mode, payment_type, number_installments, card_brand, percent_amount e amount. Valores de percent_amount de entradas que compartilham o mesmo capture_mode são somados.

{
  "id": "6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22",
  "name": "Pro-Comercio-072022",
  "description": "Plano padrao para comercio",
  "details": {
    "brands": ["Elo", "MasterCard", "Visa"],
    "types": ["debit", "credit"],
    "fees": {
      "debit": {
        "1": {
          "MasterCard": [
            {
              "source": "zoop",
              "capture_mode": "manually_keyed",
              "payment_type": "debit",
              "number_installments": "1",
              "card_brand": "MasterCard",
              "percent_amount": 1.99,
              "amount": 0
            }
          ]
        }
      },
      "credit": {
        "1": {
          "Visa": [
            {
              "source": "zoop",
              "capture_mode": "manually_keyed",
              "payment_type": "credit",
              "number_installments": "1",
              "card_brand": "Visa",
              "percent_amount": 3.19,
              "amount": 0
            }
          ]
        },
        "12": {
          "Visa": [
            {
              "source": "zoop",
              "capture_mode": "manually_keyed",
              "payment_type": "credit",
              "number_installments": "12",
              "card_brand": "Visa",
              "percent_amount": 6.49,
              "amount": 0
            }
          ]
        }
      }
    }
  }
}

Erros

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

Exemplos

curl https://api.dlpay.cloud/plans/plans/zoop/6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22/ \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJh..."

import requests

response = requests.get(
    "https://api.dlpay.cloud/plans/plans/zoop/6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22/",
    headers={"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJh..."},
)
plan = response.json()

const response = await fetch(
  "https://api.dlpay.cloud/plans/plans/zoop/6a3a5b1e-7c2a-4b6f-9a3e-2c1d8e4f1b22/",
  { headers: { Authorization: "Bearer eyJ0eXAiOiJKV1QiLCJh..." } }
);
const plan = 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 taxa

Parâmetros de caminho

Resposta

Erros

Exemplos

​Parâmetros de caminho

​Resposta

​Erros

​Exemplos

Parâmetros de caminho

Resposta

Erros

Exemplos