Ir para o conteúdo
DocsAPI 2026-11-13

Integração

Produtos e ofertas

Cadastre um produto no painel, crie ofertas com preço e forma de pagamento e compartilhe o link permanente de cada uma. O comprador informa os próprios dados e paga no checkout, sem você criar uma cobrança por cliente.

Produto e oferta

  • Produto é o que você vende (nome e descrição curta), por organização e conta de pagamentos. Fica ativo ou arquivado.
  • Oferta é uma forma de vender o produto: nome, preço em centavos, tipo e regras do tipo, situação (ativa ou inativa) e, se quiser, um endereço de retorno https:// para depois do pagamento. Um produto pode ter várias ofertas (por exemplo, à vista e mensal).
  • Mudar o preço vale para pedidos novos. Pedidos já criados mantêm o preço da hora da compra. O tipo da oferta não muda depois de criado.

Tipos de oferta

Tipos de oferta e regras
TipoComo funciona
Pagamento únicoPix, boleto e cartão de crédito (escolha quais). No cartão, você define até quantas parcelas o comprador pode escolher, de 1 a 12.
AssinaturaPix, boleto ou cartão com o ciclo escolhido (semanal a anual). A 1ª cobrança vence no dia da compra e é paga no checkout; as próximas seguem o ciclo.
Pix parceladoO comprador paga em parcelas Pix, com as quantidades e datas que o checkout oferece para a conta.
Cartão mensalParcelas cobradas no cartão a cada mês, com as quantidades que o checkout oferece e o aceite do comprador.

Cada forma depende das capacidades da conta. Uma forma indisponível é recusada ao criar a oferta (422 MODE_NOT_AVAILABLE), e o checkout confere de novo na hora da compra. Detalhes das modalidades em Dois cartões e planos e Assinaturas.

Cada oferta ganha um link no checkout, no formato pay.eclipta.com.br/o/<código>. O código é aleatório e não segue sequência, então ninguém chega a outras ofertas trocando letras do endereço. Copie o link no painel, em Produtos.

  • Desativar a oferta ou arquivar o produto encerra o link: quem abrir vê que a oferta não está mais disponível, sem preço nem formas de pagamento.
  • Reativar volta a abrir o mesmo link.
  • A página mostra só dados públicos: nome e logo da loja, produto, oferta, preço e formas de pagamento.
GET /v1/checkout/offers/{code}
{
  "code": "k7m2xq9prt4hwd",
  "environment": "sandbox",
  "merchantName": "Loja Exemplo",
  "merchantLogo": null,
  "product": {
    "name": "Curso de fotografia",
    "description": "Aulas gravadas e material de apoio."
  },
  "offer": {
    "name": "À vista",
    "kind": "ONE_TIME",
    "priceCents": "29700",
    "methods": [
      "PIX",
      "CARD_INSTALLMENTS"
    ],
    "maxInstallments": 6,
    "subscriptionCycle": null
  },
  "disclosure": "Serviços de pagamento prestados por Asaas Gestão Financeira S.A."
}

Checkout aberto

  1. O comprador abre o link e vê o produto, a oferta e o preço.
  2. Informa nome, CPF ou CNPJ, e-mail e telefone (opcional). Os dígitos do documento são conferidos no servidor.
  3. O servidor cria o pedido. Reaproveita o cliente da conta com o mesmo documento e e-mail (ou cria um), registra o pedido com o preço da oferta e abre a sessão de checkout. Nenhum valor é calculado no navegador.
  4. O comprador paga no checkout de sempre: Pix, boleto, cartão transparente ou a modalidade da oferta.
POST /v1/checkout/offers/{code}/sessions
{
  "name": "Maria Sintética",
  "taxId": "52998224725",
  "email": "[email protected]",
  "phone": "11987654321"
}
201 Created
{
  "checkoutSessionId": "chk_01JDY8E1B2C3D4E5F6G7H8J9KE",
  "url": "https://pay.exemplo.test/c/chk_01JDY8E1B2C3D4E5F6G7H8J9KE#t=token-efemero",
  "expiresAt": "2026-11-14T13:00:00.000Z"
}

Depois do pagamento

  • O checkout mostra a página de sucesso. Se a oferta tiver endereço de retorno, o comprador volta para ele em seguida.
  • Quando o prestador confirma o total do pedido, o comprador recebe um e-mail de confirmação com o produto, a oferta e o valor.
  • O seu sistema recebe o webhook order.payment_completed com offerId e productId, para liberar o produto certo. O retorno do navegador não prova pagamento: libere só pelo evento.
  • Em assinatura, cada cobrança paga do ciclo é um pedido próprio, com o mesmo offerId, e conta como uma venda.
order.payment_completed
{
  "eventId": "evt_01JDY9C1B2C3D4E5F6G7H8J9KH",
  "type": "order.payment_completed",
  "apiVersion": "2026-11-13",
  "occurredAt": "2026-11-14T13:05:00Z",
  "tenantId": "org_01JDY7Q2M3N4P5R6S7T8V9W0XA",
  "accountId": "acc_01JDY7Q2M3N4P5R6S7T8V9W0XB",
  "environment": "sandbox",
  "aggregateId": "ord_01JDY8B1B2C3D4E5F6G7H8J9KB",
  "aggregateVersion": 1,
  "data": {
    "orderId": "ord_01JDY8B1B2C3D4E5F6G7H8J9KB",
    "confirmedCents": "29700",
    "currency": "BRL",
    "offerId": "ofr_01JDY0000000000000000000AA",
    "productId": "prd_01JDY0000000000000000000AA"
  }
}

A verificação da assinatura do webhook e as retentativas estão em Webhooks e assinatura.

Vendas por oferta

Em Produtos, cada oferta mostra os pedidos pagos e o valor confirmado. Só entra o que o prestador confirmou:

  • Pagos: pedidos quitados, com o total confirmado e nenhuma parte incerta. Pedidos estornados ou em disputa deixam de contar.
  • Em parcelas: Pix parcelado e cartão mensal com parte já confirmada, mostrados à parte.

Próximo: Webhooks e assinatura