Endpoint: GET /sales/getsalecontext/{id}
Autenticação: Publica (sem autenticacao, CSRF dispensado) — voltada ao comprador.
Retorna o mesmo objeto de contexto usado pela pagina hospedada — mas em JSON. Util quando um front-end customizado quer renderizar sua propria pagina de pagamento sobre uma venda online. O endpoint complementar para a cobranca e Pagar cobranca. O max_installments retornado e min(plano.max_installments, conta.get_max_installments()). O max_installments_no_tax ainda e limitado por esse teto efetivo. As flags de PIX/boleto/credito sao retornadas como booleanos aqui (a versao HTML usa strings CSS).

Parametros de caminho

id
string
required

Resposta

200 OK. A resposta vem encapsulada em context.
context.seller_name
string
statement_descriptor da conta (o que aparece no extrato do comprador).
context.sale_name
string
Nome da venda.
context.sale_description
string
Descricao da venda.
context.sale_formated_price
string
Valor da venda em BRL como valor decimal em reais (mesmo valor que sale_price).
context.sale_price
string
Valor da venda em BRL (valor decimal em reais).
context.invoice_description
string
Descritor do extrato usado em boleto/faturas.
context.sale_id
string
UUID do link de checkout — usado como id no caminho de Pagar cobranca.
context.sale_seller_id
string
UUID unificado da conta — usado por outros endpoints com escopo de vendedor.
context.max_installments
integer
Teto efetivo de parcelas (min(plano, conta)).
context.max_installments_no_tax
integer
Parcelas em que o vendedor absorve os juros, limitado por max_installments.
context.has_pix
boolean
Se pagamento por PIX esta habilitado pelo plano.
context.has_boleto
boolean
Se pagamento por boleto esta habilitado pelo plano.
context.has_credit
boolean
Se pagamento por cartao de credito esta habilitado pelo plano.
{
  "context": {
    "seller_name": "DL Cursos",
    "sale_name": "Curso Online de Maio",
    "sale_description": "Acesso vitalicio ao curso online.",
    "sale_formated_price": "499.00",
    "invoice_description": "DL Cursos",
    "sale_id": "2c1f8a4e-3a3a-4f72-9d3c-1aa2f0c0aa11",
    "sale_seller_id": "8f3e1234-5678-4abc-9def-1234567890ab",
    "sale_price": "499.00",
    "max_installments": 12,
    "max_installments_no_tax": 3,
    "has_pix": true,
    "has_boleto": true,
    "has_credit": true
  }
}

Erros

StatusQuando
400{ "error": "sale not found" } — nenhuma venda online corresponde ao id fornecido.

Exemplos

curl "https://api.dlpay.cloud/sales/getsalecontext/$CHECKOUT_ID"