Criar link de checkout

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

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

Cria um registro de venda online vinculado a um plano de pagamento previamente cadastrado. O link retornado na resposta e a pagina de pagamento visivel ao cliente; o mesmo link pode ser pago por varios compradores — cada pagamento bem-sucedido gera um pagamento de venda online (veja Listar pagamentos do checkout) e uma transacao. Validacoes aplicadas:

O seller_id deve corresponder a um vendedor existente.
A conta unificada e resolvida automaticamente e registrada na linha.

Pre-requisitos

A conta de vendedor deve existir.
Um Plano de pagamento deve existir para este vendedor — seu UUID e obrigatorio no corpo.
O chamador precisa de vinculo de acesso para seller_id.

Parametros de caminho

string

required

UUID unificado da conta.

Corpo da requisicao

string

required

UUID do Plano de pagamento que define metodos aceitos (credito/PIX/boleto), limites de parcelas e regras de taxa/juros do boleto.

string

required

Nome exibido na pagina publica de pagamento. Maximo 255 caracteres.

string

required

Referencia externa livre. Maximo 100 caracteres. Encaminhada como identificador de referencia da transacao na infraestrutura de processamento.

string

Descricao longa exibida na pagina de pagamento.

string

required

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

string

required

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

Resposta

201 Created com o novo link de checkout.

string

UUID do novo link de checkout.

string

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

string

Eco do UUID do plano de pagamento informado.

string

integer

Sempre 0 na criacao.

{
  "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": 0
}

Erros

Status	Quando
`400`	Validacao do corpo falhou — por exemplo `payment_plan` desconhecido, campo obrigatorio ausente, ou `Seller not found.`
`401`	Credenciais ausentes ou invalidas.
`403`	Autenticado, mas sem vinculo de acesso para `seller_id`.

Exemplos

curl -X POST "https://api.dlpay.cloud/sales/seller/$SELLER_ID/checkoutlink/" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
  }'

import requests

response = requests.post(
    f"https://api.dlpay.cloud/sales/seller/{seller_id}/checkoutlink/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={
        "payment_plan": payment_plan_id,
        "name": "Curso Online de Maio",
        "reference": "curso-maio-2026",
        "description": "Acesso vitalicio ao curso online.",
        "amount": "499.00",
        "expiration_date": "2026-06-30",
    },
)
checkout = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/sales/seller/${sellerId}/checkoutlink/`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      payment_plan: paymentPlanId,
      name: "Curso Online de Maio",
      reference: "curso-maio-2026",
      description: "Acesso vitalicio ao curso online.",
      amount: "499.00",
      expiration_date: "2026-06-30",
    }),
  },
);
const checkout = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Criar link de checkout

Pre-requisitos

Parametros de caminho

Corpo da requisicao

Resposta

Erros

Exemplos

​Pre-requisitos

​Parametros de caminho

​Corpo da requisicao

​Resposta

​Erros

​Exemplos

Pre-requisitos

Parametros de caminho

Corpo da requisicao

Resposta

Erros

Exemplos