Listar planos de pagamento do vendedor

Endpoint: GET / POST /sales/seller/{seller_id}/paymentplans/

Autenticação: Bearer JWT ou chave de API do vendedor (TokenAuth)

Um plano de pagamento descreve quais metodos um Link de checkout aceita (credito / PIX / boleto), seus limites de parcelas e as regras de taxa/juros/desconto do boleto. Um plano pode ser usado por varios links. A listagem e paginada (tamanho padrao 10, maximo 100) e ordenada por created_at DESC.

Pre-requisitos

O vendedor deve existir — veja Cadastrar vendedor.
O chamador precisa de vinculo de acesso para seller_id.

Parametros de caminho

string

required

UUID unificado da conta.

GET — listar

Parametros de consulta

integer

Limitado a 100.

Resposta

Envelope padrao paginado; itens em results[] seguem o esquema abaixo.

POST — criar

Corpo da requisicao

string

required

Nome legivel do plano.

boolean

default:"true"

Se pagamentos com cartao de credito sao aceitos.

string

Maximo de parcelas permitidas (inteiro como string, ex.: "12"). Restringido pelas opcoes do modelo.

string

Numero de parcelas em que o vendedor absorve os juros (inteiro como string).

boolean

default:"true"

Se boleto e aceito.

integer

Numero de parcelas no boleto (carne). Padrao 1.

string

Data ISO — vencimento visivel ao comprador.

string

Data ISO — ultima data em que o boleto pode ser pago (deve ser ≥ boleto_expiration_date).

string

Instrucoes livres impressas no boleto. Maximo 60 caracteres.

string

default:"NONE"

Modo de calculo da multa por atraso. Um de FIXED, PERCENTAGE, NONE.

integer

Valor da multa. Interpretado em centavos (FIXED) ou pontos-base (PERCENTAGE) — confirmar conforme o caso. Minimo 1.

string

Data ISO — deve ser ≥ boleto_expiration_date.

string

default:"NONE"

Um de DAILY_AMOUNT, DAILY_PERCENTAGE, MONTHLY_PERCENTAGE, NONE.

integer

Minimo 1.

string

Data ISO — deve ser ≥ boleto_expiration_date.

array

Lista de descontos: { "mode": "PERCENTAGE"|"FIXED", "value": <int minimo 1>, "until_date": "YYYY-MM-DD" }.

boolean

default:"true"

Se PIX e aceito.

Resposta

201 Created com o plano salvo, e boleto_discounts retornado como array ja decodificado.

Resposta — estrutura do plano

string

UUID do plano.

string

boolean

string

boolean

integer

string

integer

string

integer

string

array

boolean

{
  "id": "f2c0c1a4-9c98-4e6e-bd14-7c5a3a6b1bcd",
  "name": "Cursos - Padrao",
  "allow_credit_card": true,
  "max_installments": "12",
  "max_installments_no_tax": "3",
  "allow_boleto": true,
  "boleto_max_installments": 1,
  "boleto_expiration_date": "2026-06-30",
  "boleto_payment_limit_date": "2026-07-15",
  "boleto_body_instructions": "Nao aceitar apos vencimento",
  "boleto_late_fee_mode": "PERCENTAGE",
  "boleto_late_fee_value": 200,
  "boleto_late_fee_start_date": "2026-07-01",
  "boleto_interest_mode": "MONTHLY_PERCENTAGE",
  "boleto_interest_value": 100,
  "boleto_interest_start_date": "2026-07-01",
  "boleto_discounts": [
    {"mode": "PERCENTAGE", "value": 10, "until_date": "2026-06-20"}
  ],
  "allow_pix": true
}

Erros

Status	Quando
`400`	Validacao do corpo falhou (ex.: `boleto_discounts` invalido, vencimento posterior ao limite de pagamento, vendedor ausente).
`401`	Credenciais ausentes ou invalidas.
`403`	Sem vinculo de acesso para `seller_id`.

Exemplos

curl "https://api.dlpay.cloud/sales/seller/$SELLER_ID/paymentplans/" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.post(
    f"https://api.dlpay.cloud/sales/seller/{seller_id}/paymentplans/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={
        "name": "Cursos - Padrao",
        "allow_credit_card": True,
        "max_installments": "12",
        "max_installments_no_tax": "3",
        "allow_boleto": True,
        "allow_pix": True,
    },
)
plan = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/sales/seller/${sellerId}/paymentplans/`,
  { headers: { Authorization: `Bearer ${accessToken}` } },
);
const plans = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Listar planos de pagamento do vendedor

Pre-requisitos

Parametros de caminho

GET — listar

Parametros de consulta

Resposta

POST — criar

Corpo da requisicao

Resposta

Resposta — estrutura do plano

Erros

Exemplos

​Pre-requisitos

​Parametros de caminho

​GET — listar

​Parametros de consulta

​Resposta

​POST — criar

​Corpo da requisicao

​Resposta

​Resposta — estrutura do plano

​Erros

​Exemplos

Pre-requisitos

Parametros de caminho

GET — listar

Parametros de consulta

Resposta

POST — criar

Corpo da requisicao

Resposta

Resposta — estrutura do plano

Erros

Exemplos