Listar links de checkout

Endpoint: GET /sales/seller/{seller_id}/checkoutlink/

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

Retorna os links de checkout da conta informada, do mais recente para o mais antigo. Um link de checkout e uma pagina de pagamento reutilizavel hospedada pela plataforma — o mesmo link pode ser pago por varios compradores, gerando um pagamento de venda online e uma ou mais transacoes. A listagem e paginada (tamanho padrao 10, maximo 100).

Pre-requisitos

A conta de vendedor deve existir — veja Cadastrar vendedor.
O chamador precisa ter vinculo de acesso a conta, ou ser um superusuario. Veja Autenticacao e acesso.
Um Plano de pagamento deve existir antes da criacao de qualquer link, mas a listagem simples retorna uma pagina vazia quando nao houver nenhum.

Parametros de caminho

string

required

UUID unificado da conta (o mesmo id usado nas rotas com escopo de vendedor).

Parametros de consulta

string

Busca textual (case-insensitive) sobre name, reference e description.

integer

Numero da pagina (1-based).

integer

Tamanho da pagina, limitado a 100.

Resposta

Envelope padrao paginado.

integer

Total de links de checkout que correspondem ao filtro.

string | null

URL da proxima pagina, ou null na ultima pagina.

string | null

URL da pagina anterior, ou null na primeira pagina.

array

Lista de objetos de link de checkout (campos abaixo).

string

UUID do link de checkout.

string

UUID do Plano de pagamento usado por este link.

string

Nome exibido na pagina publica de pagamento.

string

Referencia externa livre (usada como identificador de referencia da cobranca na infraestrutura de processamento).

string

Descricao longa exibida na pagina de pagamento.

string

Valor total em BRL como valor decimal em reais (ex.: "199.90"). Internamente multiplicado por 100 para obter centavos antes do envio. Inconsistencia conhecida com a convencao de centavos do restante da API.

string

Data ISO-8601 (YYYY-MM-DD) apos a qual o link nao deve mais ser pago.

string

URL publica de pagamento no formato ${FRONTEND_BASE_URL}/pagar/{id}. Compartilhe esta URL com o comprador.

integer

Quantidade de pagamentos ja criados sob este link.

{
  "count": 12,
  "next": "https://api.dlpay.cloud/sales/seller/8f3e.../checkoutlink/?page=2",
  "previous": null,
  "results": [
    {
      "id": "2c1f8a4e-3a3a-4f72-9d3c-1aa2f0c0aa11",
      "payment_plan": "f2c0c1a4-9c98-4e6e-bd14-7c5a3a6b1bcd",
      "name": "Curso Online de Maio",
      "reference": "curso-maio-2026",
      "description": "Acesso vitalicio ao curso online.",
      "amount": "499.00",
      "expiration_date": "2026-06-30",
      "link": "https://painel.dlpay.cloud/pagar/2c1f8a4e-3a3a-4f72-9d3c-1aa2f0c0aa11",
      "payment_count": 4
    }
  ]
}

Erros

Status	Quando
`401`	Token ou chave de API ausente/invalido.
`403`	Autenticado, mas sem vinculo de acesso para `seller_id`.
`404`	`seller_id` nao corresponde a nenhuma conta.

Exemplos

curl "https://api.dlpay.cloud/sales/seller/$SELLER_ID/checkoutlink/?search=curso" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://api.dlpay.cloud/sales/seller/{seller_id}/checkoutlink/",
    headers={"Authorization": f"Bearer {access_token}"},
    params={"search": "curso", "page": 1, "page_size": 20},
)
data = response.json()

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

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Listar links de checkout

Pre-requisitos

Parametros de caminho

Parametros de consulta

Resposta

Erros

Exemplos

​Pre-requisitos

​Parametros de caminho

​Parametros de consulta

​Resposta

​Erros

​Exemplos

Pre-requisitos

Parametros de caminho

Parametros de consulta

Resposta

Erros

Exemplos