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

​
seller_id
string
required
UUID unificado da conta.

​
GET — listar

​
Parametros de consulta

​
page
integer
​
page_size
integer
Limitado a 100.

​
Resposta

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

​
POST — criar

​
Corpo da requisicao

​
name
string
required
Nome legivel do plano.
​
allow_credit_card
boolean
default:"true"
Se pagamentos com cartao de credito sao aceitos.
​
max_installments
string
Maximo de parcelas permitidas (inteiro como string, ex.: "12"). Restringido pelas opcoes do modelo.
​
max_installments_no_tax
string
Numero de parcelas em que o vendedor absorve os juros (inteiro como string).
​
allow_boleto
boolean
default:"true"
Se boleto e aceito.
​
boleto_max_installments
integer
Numero de parcelas no boleto (carne). Padrao 1.
​
boleto_expiration_date
string
Data ISO — vencimento visivel ao comprador.
​
boleto_payment_limit_date
string
Data ISO — ultima data em que o boleto pode ser pago (deve ser ≥ boleto_expiration_date).
​
boleto_body_instructions
string
Instrucoes livres impressas no boleto. Maximo 60 caracteres.
​
boleto_late_fee_mode
string
default:"NONE"
Modo de calculo da multa por atraso. Um de FIXED, PERCENTAGE, NONE.
​
boleto_late_fee_value
integer
Valor da multa. Interpretado em centavos (FIXED) ou pontos-base (PERCENTAGE) — confirmar conforme o caso. Minimo 1.
​
boleto_late_fee_start_date
string
Data ISO — deve ser ≥ boleto_expiration_date.
​
boleto_interest_mode
string
default:"NONE"
Um de DAILY_AMOUNT, DAILY_PERCENTAGE, MONTHLY_PERCENTAGE, NONE.
​
boleto_interest_value
integer
Minimo 1.
​
boleto_interest_start_date
string
Data ISO — deve ser ≥ boleto_expiration_date.
​
boleto_discounts
array
Lista de descontos: { "mode": "PERCENTAGE"|"FIXED", "value": <int minimo 1>, "until_date": "YYYY-MM-DD" }.
​
allow_pix
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

​
id
string
UUID do plano.
​
name
string
​
allow_credit_card
boolean
​
max_installments
string
​
max_installments_no_tax
string
​
allow_boleto
boolean
​
boleto_max_installments
integer
​
boleto_expiration_date
string
​
boleto_payment_limit_date
string
​
boleto_body_instructions
string
​
boleto_late_fee_mode
string
​
boleto_late_fee_value
integer
​
boleto_late_fee_start_date
string
​
boleto_interest_mode
string
​
boleto_interest_value
integer
​
boleto_interest_start_date
string
​
boleto_discounts
array
​
allow_pix
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

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

​
Exemplos

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