Compraspurchase.*

Ciclo de vida de uma compra no checkout: do lead capturado ao pagamento, ao reembolso e à contestação.

purchase.abandoned

Quando um purchase fica inativo no checkout sem ter sido pago. Ocorre quando a pessoa deixou seus dados, ou cancelou um boleto ou pix, ou teve um pagamento recusado, e não realizou nenhuma ação nova dentro da janela de inatividade configurada. Pode ocorrer mais de uma vez para o mesmo purchase, e o campo abandonment.stage do payload identifica de qual etapa a pessoa saiu.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: a compra ficou parada no checkout sem pagamento; o bloco abandonment diz em que etapa.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • abandonmentobjectsempre presente4 campos

    Só no purchase.abandoned: em que ponto a pessoa parou e há quanto tempo.

    • abandonCountintegersempre presente

      Quantas vezes esta compra já gerou purchase.abandoned, contando este envio. Se a pessoa volta, age e para de novo, o evento é enviado outra vez com o número maior.

    • idleForMinutesintegersempre presente

      Há quantos minutos a pessoa está parada, contados de idleSince até o envio deste evento.

    • idleSincestring (data)sempre presente

      Data da última ação da pessoa nesta compra, a partir da qual ela ficou parada. Data e hora em ISO 8601, no fuso UTC.

    • stagestringsempre presente

      Etapa em que a pessoa parou. lead_captured: deixou os dados e não seguiu. payment_canceled: gerou boleto ou PIX e cancelou. payment_refused: teve o cartão recusado e não tentou de novo.

      lead_capturedpayment_canceledpayment_refused
  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobjectsempre presente1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstringsempre presente

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.abandoned"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobject ou null10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente11 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountintegersempre presente

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • installmentnull

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente5 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • createdAtstring (data)

              Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

            • updatedAtstring (data)

              Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente6 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • createdAtstring (data)

              Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
            • updatedAtstring (data)

              Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente12 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data)

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobject ou null9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstring ou nullsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "963636a78304e05bce31597f",
"abandonment": {
"abandonCount": 1,
"idleForMinutes": 6,
"idleSince": "2026-10-01T19:49:08.930Z",
"stage": "payment_refused"
},
"checkout": {
"_id": "ce33da9718746362e0391d8b",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "9ybhylt1ob",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "3a01f4404578de542b1687be",
"checkoutSharedId": "9ybhylt1ob",
"createdAt": "2026-10-01T19:49:08.704Z",
"eventType": "purchase.abandoned",
"invoice": {
"_id": "f3e03758143ed028a837dbef",
"discountedAmount": 1500,
"discounts": 1 item
"dueAmount": 9999,
"items": 3 itens
"itemsAmount": 11499,
"paidAmount": 0,
"refundedAmount": 0,
"status": "OPEN",
"totalAmount": 9999
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
10 campos neste exemplo
],
"queryParams": {},
"status": "REFUSED",
"updatedAt": "2026-10-01T19:49:08.704Z",
"user": {
"_id": "a8d555b521511f5f8ae13a71",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "215a9160d4957a1199608e8e",
"address": 7 campos neste exemplo
"country": "BR",
"createdAt": "2026-10-01T19:48:58.925Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-10-01T19:48:58.925Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.chargedback

Quando uma compra tem seu pagamento com status CHARGEDBACK. Isso ocorre quando o titular do cartão contesta a compra junto ao emissor e o valor é estornado. É um evento final: o pagamento não muda mais de status depois dele.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento contestado está em CHARGEDBACK. É um status final: o pagamento não muda mais depois dele.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstringsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobjectsempre presente1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente8 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente5 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstringsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente3 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente4 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstringsempre presente

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.chargedback"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente9 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobjectsempre presente6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystringsempre presente

        ID de quem alterou o desconto pela última vez.

      • voucherstringsempre presente

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstringsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente3 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente4 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente10 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressnullsempre presente

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "6e79e4395c6eb123178aa1da",
"checkout": {
"_id": "f2e2c0101725f581bb1aa180",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "ww07i25gpj",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "2b25cc02c293bd685b83d924",
"checkoutSharedId": "ww07i25gpj",
"createdAt": "2026-09-03T21:24:08.952Z",
"eventType": "purchase.chargedback",
"invoice": {
"_id": "60906b568c5cf71f179261ce",
"discountedAmount": 209700,
"discounts": 1 item
"dueAmount": 0,
"items": 3 itens
"itemsAmount": 233000,
"paidAmount": 23300,
"refundedAmount": 0,
"status": "PAID",
"totalAmount": 23300
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
10 campos neste exemplo
],
"queryParams": {},
"status": "PAID",
"updatedAt": "2026-09-03T21:30:14.998Z",
"user": {
"_id": "4bb46dc6ae51315812cabaee",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "5aeb12935a1fa84e82217ca0",
"address": null,
"country": "BR",
"createdAt": "2026-09-03T21:30:04.235Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-09-03T21:30:04.235Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.expired

Quando uma compra tem seu status EXPIRED, e o pagamento também vai para EXPIRED.Isso ocorre quando um Boleto ou PIX expira (passa do vencimento).

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = EXPIRED: o boleto ou PIX venceu sem pagamento.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobject1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.expired"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente13 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountinteger

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • installmentnull

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobject6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

      • voucherstring

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente3 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente4 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente13 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring ou nullsempre presente

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data)sempre presente

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • qrCodeUrlnull

      Só em PIX: URL da imagem do QR Code.

    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente1 campo

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

    • {chave}string

      Valor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valuestringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstringsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "54ae0ae8343d024cd99511de",
"checkout": {
"_id": "fd10befff7b57f4fbc35a45a",
"description": null,
"purchaseChoices": 1 campo neste exemplo
"sharedId": "5gss27juzv",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "43e789554a3f1b8e64c026f2",
"checkoutSharedId": "5gss27juzv",
"createdAt": "2026-08-13T22:20:24.128Z",
"eventType": "purchase.expired",
"invoice": {
"_id": "ec14d4e5447630ded84874dd",
"discountedAmount": 26650,
"discounts": 2 itens
"dueAmount": 94350,
"items": 2 itens
"itemsAmount": 121000,
"paidAmount": 0,
"refundedAmount": 0,
"status": "EXPIRED",
"totalAmount": 94350
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
13 campos neste exemplo
],
"queryParams": {},
"status": "EXPIRED",
"updatedAt": "2026-08-13T22:35:52.162Z",
"user": {
"_id": "f4db469912f75f9346d7f09b",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "43682da0474ab26d681703a6",
"address": 7 campos neste exemplo
"country": "BR",
"createdAt": "2026-08-13T22:20:51.729Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-08-13T22:20:51.729Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.lead_captured

Quando uma compra tem seu status DRAFT. Isso ocorre quando um lead deixa suas informações na modal de captura de leads.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = DRAFT, sem pagamento nem fatura. Traz os dados que a pessoa deixou na captura de lead.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobject1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstring

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstring

              ID da configuração de exibição do valor.

            • createdAtstring (data)

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring ou null

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.lead_captured"sempre presente

    Nome do evento que gerou este envio.

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarraysempre presente

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

  • queryParamsobjectsempre presente1 campo

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

    • {chave}string

      Valor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstring ou nullsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystring ou nullsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

Exemplo de payload
{
"_id": "c417e66a4a45f37d9c87e5cd",
"checkout": {
"_id": "ccaf3846af5889af6cf2eace",
"description": null,
"purchaseChoices": 1 campo neste exemplo
"sharedId": "5gss27juzv",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": null,
"checkoutSharedId": "5gss27juzv",
"createdAt": "2026-08-13T21:18:00.217Z",
"eventType": "purchase.lead_captured",
"organization": "1962f4ab59f82366f96e7762",
"payments": [],
"queryParams": {},
"status": "DRAFT",
"updatedAt": "2026-08-13T21:18:00.217Z",
"user": {
"_id": "da1cf8a91de085d650d6c1da",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.open.payment.canceled

Quando uma compra é cancelada após ter sido gerada no Checkout. Isso ocorre quando um PIX ou Boleto é gerado, e o usuário pagador opta por cancelar para voltar ao checkout e optar por outro método de pagamento.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = OPEN e o boleto ou PIX gerado foi cancelado (pagamento em CANCELED).

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobject1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente8 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceItemsarray de objectsempre presente7 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • productobjectsempre presente8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestringsempre presente

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.open.payment.canceled"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente11 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountintegersempre presente

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • installmentnull

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente5 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • createdAtstring (data)

              Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

            • updatedAtstring (data)

              Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente6 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • createdAtstring (data)

              Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
            • updatedAtstring (data)

              Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente13 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestringsempre presente

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data)sempre presente

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • qrCodeUrlstring

      Só em PIX: URL da imagem do QR Code.

    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente1 campo

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

    • {chave}string

      Valor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valuestringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstring ou nullsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "ffcbe0819c9e157b6d8a55b1",
"checkout": {
"_id": "88d3bdee72e44ec1cc0b7c4e",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "ww07i25gpj",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "2b25cc02c293bd685b83d924",
"checkoutSharedId": "ww07i25gpj",
"createdAt": "2026-09-15T21:56:25.322Z",
"eventType": "purchase.open.payment.canceled",
"invoice": {
"_id": "2ab3fe52e484a70ab96de4f9",
"discountedAmount": 0,
"discounts": [],
"dueAmount": 188333,
"items": 3 itens
"itemsAmount": 188333,
"paidAmount": 0,
"refundedAmount": 0,
"status": "OPEN",
"totalAmount": 188333
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
12 campos neste exemplo
],
"queryParams": {},
"status": "VOID",
"updatedAt": "2026-09-15T22:48:34.430Z",
"user": {
"_id": "6e8c546174c1c99c3b547d19",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "6a8d6e56f974d780abe3cfab",
"address": 8 campos neste exemplo
"country": "BR",
"createdAt": "2026-09-15T21:59:41.025Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-09-15T21:59:41.025Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.open.payment.waiting_payment

Quando uma compra tem seu status OPEN, e o pagamento vai para WAITING_PAYMENT.Isso ocorre quando um Boleto ou PIX é gerado no Checkout.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = OPEN e o pagamento mais recente em WAITING_PAYMENT, com código e vencimento do boleto ou PIX.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobject1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray de object ou nullsempre presente5 campos

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

              • _idstringsempre presente

                ID do metadado.

              • createdAtstring (data)sempre presente

                Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

              • keystringsempre presente

                Chave do metadado, como foi cadastrada no produto.

              • updatedAtstring (data)sempre presente

                Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

              • valuestringsempre presente

                Valor do metadado.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.open.payment.waiting_payment"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente13 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountinteger

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • installmentnull

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobject6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

      • voucherstring

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente10 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • orderBumpIdstring

        Só nos itens que entraram pela oferta adicional (order bump) do checkout: ID dessa oferta. Itens escolhidos normalmente não têm este campo.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray de object ou nullsempre presente5 campos

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

          • _idstringsempre presente

            ID do metadado.

          • createdAtstring (data)sempre presente

            Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

          • keystringsempre presente

            Chave do metadado, como foi cadastrada no produto.

          • updatedAtstring (data)sempre presente

            Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

          • valuestringsempre presente

            Valor do metadado.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente5 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • createdAtstring (data)

              Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

            • updatedAtstring (data)

              Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente6 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • createdAtstring (data)

              Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
            • updatedAtstring (data)

              Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente13 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring ou null

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data) ou null

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • qrCodeUrlstring ou null

      Só em PIX: URL da imagem do QR Code.

    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente1 campo

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

    • {chave}string

      Valor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstring ou nullsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "85ce4bc1cad8606fd6d9fcd1",
"checkout": {
"_id": "fd10befff7b57f4fbc35a45a",
"description": null,
"purchaseChoices": 1 campo neste exemplo
"sharedId": "5gss27juzv",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "43e789554a3f1b8e64c026f2",
"checkoutSharedId": "5gss27juzv",
"createdAt": "2026-08-13T22:22:50.341Z",
"eventType": "purchase.open.payment.waiting_payment",
"invoice": {
"_id": "42425f6e44882db26641f2ee",
"discountedAmount": 10000,
"discounts": 1 item
"dueAmount": 111000,
"items": 2 itens
"itemsAmount": 121000,
"paidAmount": 0,
"refundedAmount": 0,
"status": "OPEN",
"totalAmount": 111000
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
12 campos neste exemplo
],
"queryParams": {},
"status": "OPEN",
"updatedAt": "2026-08-13T22:23:30.367Z",
"user": {
"_id": "21e0af4a0add86d9317a6d8c",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "22b628ed651bb9ad585fb257",
"address": 7 campos neste exemplo
"country": "BR",
"createdAt": "2026-08-13T22:23:15.504Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-08-13T22:23:15.504Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.paid

Quando uma compra é efetivada no Checkout.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = PAID e o pagamento mais recente em PAID. Se algum produto for recorrente, vem também o bloco subscription.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstring ou nullsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobject1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente7 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • badgeTextstring

            Selo de destaque exibido na opção (ex.: "Mais vendido").

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • descriptionstring

            Texto de apoio exibido abaixo do nome da opção.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray de object ou nullsempre presente5 campos

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

              • _idstringsempre presente

                ID do metadado.

              • createdAtstring (data)sempre presente

                Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

              • keystringsempre presente

                Chave do metadado, como foi cadastrada no produto.

              • updatedAtstring (data)sempre presente

                Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

              • valuestringsempre presente

                Valor do metadado.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente5 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • createdAtstring (data)

                  Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

                • updatedAtstring (data)

                  Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente6 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • createdAtstring (data)

                  Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
                • updatedAtstring (data)

                  Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.paid"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente13 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountinteger

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • installmentinteger ou null

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobject6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

      • voucherstring

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente10 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • orderBumpIdstring

        Só nos itens que entraram pela oferta adicional (order bump) do checkout: ID dessa oferta. Itens escolhidos normalmente não têm este campo.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray de object ou nullsempre presente5 campos

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

          • _idstringsempre presente

            ID do metadado.

          • createdAtstring (data)sempre presente

            Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

          • keystringsempre presente

            Chave do metadado, como foi cadastrada no produto.

          • updatedAtstring (data)sempre presente

            Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

          • valuestringsempre presente

            Valor do metadado.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente5 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • createdAtstring (data)

              Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

            • updatedAtstring (data)

              Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente6 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • createdAtstring (data)

              Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
            • updatedAtstring (data)

              Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.

        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente13 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring ou null

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data) ou null

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • qrCodeUrlstring ou null

      Só em PIX: URL da imagem do QR Code.

    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente1 campo

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

    • {chave}string

      Valor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • subscriptionobject7 campos

    Só no purchase.paid de uma compra com produto recorrente: a assinatura criada por esta compra, com o cronograma de cobranças.

    • _idstringsempre presente

      ID da assinatura. É o mesmo que aparece nos eventos subscription.* e subscription.charge.*.

    • billingobjectsempre presente2 campos

      Cobranças da assinatura.

      • chargesarray de objectsempre presente8 campos

        Cronograma de cobranças da assinatura, das já geradas às futuras, em ordem de data.

        • _idstringsempre presente

          ID da cobrança.

        • amountintegersempre presente

          Valor da cobrança. Valor em centavos (ex.: 9990 = R$ 99,90).

        • createdAtstring (data)sempre presente

          Data em que a cobrança entrou no cronograma. Data e hora em ISO 8601, no fuso UTC.

        • expirationDatestring (data)sempre presente

          Data de vencimento da cobrança. Data e hora em ISO 8601, no fuso UTC.

        • generationDatestring (data)sempre presente

          Data em que a cobrança é gerada (no boleto, quando o boleto é emitido). Data e hora em ISO 8601, no fuso UTC.

        • invoiceIdstring ou nullsempre presente

          ID da fatura desta cobrança. Só aparece nas cobranças já geradas.

        • paymentMethodstringsempre presente

          Forma de pagamento da cobrança.

          BANK_SLIPCREDIT_CARDMONEYPIX
        • updatedAtstring (data)sempre presente

          Data da última alteração da cobrança. Data e hora em ISO 8601, no fuso UTC.

      • nextInvoiceobjectsempre presente5 campos

        A próxima cobrança a ser gerada. É um dos itens de charges.

        • _idstringsempre presente

          ID da cobrança.

        • amountintegersempre presente

          Valor da cobrança. Valor em centavos (ex.: 9990 = R$ 99,90).

        • expirationDatestring (data)sempre presente

          Data de vencimento da cobrança. Data e hora em ISO 8601, no fuso UTC.

        • generationDatestring (data)sempre presente

          Data em que a cobrança é gerada (no boleto, quando o boleto é emitido). Data e hora em ISO 8601, no fuso UTC.

        • paymentMethodstringsempre presente

          Forma de pagamento da cobrança.

          BANK_SLIPCREDIT_CARDMONEYPIX
    • createdAtstring (data)sempre presente

      Data em que a assinatura foi criada. Data e hora em ISO 8601, no fuso UTC.

    • intervalobjectsempre presente2 campos

      De quanto em quanto tempo a assinatura é cobrada.

      • amountintegersempre presente

        Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês).

      • unitstringsempre presente

        Unidade de tempo do intervalo.

        DAYMINUTEMONTHWEEKYEAR
    • statusstringsempre presente

      Status da assinatura.

      ACTIVECANCELEDFINISHEDLATE
    • statusAtstring (data)sempre presente

      Data em que a assinatura entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

    • updatedAtstring (data)sempre presente

      Data da última alteração da assinatura. Data e hora em ISO 8601, no fuso UTC.

  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valuearray de string | integer | string ou nullsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstring ou nullsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "e32556ab6f4f3715efd3b115",
"checkout": {
"_id": "fd10befff7b57f4fbc35a45a",
"description": null,
"purchaseChoices": 1 campo neste exemplo
"sharedId": "5gss27juzv",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "1e7909f5c8b5c8a17e4f35ce",
"checkoutSharedId": "5gss27juzv",
"createdAt": "2026-08-13T22:53:13.239Z",
"eventType": "purchase.paid",
"invoice": {
"_id": "72bf76b9ea392d4e0b829feb",
"discountedAmount": 0,
"discounts": [],
"dueAmount": 0,
"items": 1 item
"itemsAmount": 132132,
"paidAmount": 132132,
"refundedAmount": 0,
"status": "PAID",
"totalAmount": 132132
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
10 campos neste exemplo
],
"queryParams": {},
"status": "PAID",
"subscription": {
"_id": "6be61aa3bfe7cd5418966401",
"billing": 2 campos neste exemplo
"createdAt": "2026-08-13T23:01:06.579Z",
"interval": 2 campos neste exemplo
"status": "ACTIVE",
"statusAt": "2026-08-13T23:01:06.579Z",
"updatedAt": "2026-08-13T23:01:06.579Z"
},
"updatedAt": "2026-08-13T23:01:05.241Z",
"user": {
"_id": "1d557503124e09adb00bc129",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "6e81196e187a57011543efae",
"address": 7 campos neste exemplo
"country": "BR",
"createdAt": "2026-08-13T23:00:49.121Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-08-13T23:00:49.121Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.partially_refunded

Quando uma compra tem seu status PARTIALLY_REFUNDED, e o pagamento também vai para PARTIALLY_REFUNDED. Isso ocorre quando parte do valor de uma compra já paga é devolvida ao pagador. Pode ocorrer mais de uma vez para a mesma compra, e o campo refundedAmount do pagamento é acumulado.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento está em PARTIALLY_REFUNDED e refundedAmount mostra o total já devolvido. Cada novo reembolso parcial gera um novo evento.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstringsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobjectsempre presente1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente8 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente5 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstringsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente3 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente4 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstringsempre presente

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.partially_refunded"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente9 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobjectsempre presente6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystringsempre presente

        ID de quem alterou o desconto pela última vez.

      • voucherstringsempre presente

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstringsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente3 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente4 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente11 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundsarray de object7 campos

      Histórico de reembolsos deste pagamento, do mais antigo para o mais recente, com todos os status (inclusive os que falharam). Só aparece quando o pagamento teve algum reembolso. Não some os amount daqui para saber o total devolvido; use refundedAmount.

      • _idstringsempre presente

        ID do reembolso.

      • amountintegersempre presente

        Valor deste reembolso isolado. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o reembolso foi solicitado. Data e hora em ISO 8601, no fuso UTC.

      • currencystringsempre presente

        Moeda do reembolso, em código ISO 4217 (ex.: BRL).

      • descriptionstringsempre presente

        Observação livre escrita pelo administrador ao fazer o reembolso. Só aparece quando foi preenchida.

      • reasonstringsempre presente

        Motivo do reembolso informado pelo administrador.

        DUPLICATEFRAUDULENTOTHERREQUESTED_BY_CUSTOMER
      • statusstringsempre presente

        Status do reembolso. PAID é o reembolso concluído.

        CANCELEDFAILEDPAIDPENDING
    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressnullsempre presente

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "4407b261b3b676a9820ec13f",
"checkout": {
"_id": "ea7932306ae6b442e1eee027",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "qjixs4eej0",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "f325e8f40750fe2104a52f90",
"checkoutSharedId": "qjixs4eej0",
"createdAt": "2026-09-03T03:51:45.277Z",
"eventType": "purchase.partially_refunded",
"invoice": {
"_id": "1b5d520c5f3e5e3bce2d7eb9",
"discountedAmount": 0,
"discounts": [],
"dueAmount": 20000,
"items": 3 itens
"itemsAmount": 25555,
"paidAmount": 5555,
"refundedAmount": 20000,
"status": "PARTIALLY_REFUNDED",
"totalAmount": 25555
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
10 campos neste exemplo
11 campos neste exemplo
],
"queryParams": {},
"status": "PARTIALLY_REFUNDED",
"updatedAt": "2026-09-03T05:10:32.476Z",
"user": {
"_id": "a05f0167552cde3a4edea585",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "4ac7ce470a947b5e585df0a8",
"address": null,
"country": "BR",
"createdAt": "2026-09-03T03:51:31.912Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-09-03T03:51:31.912Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.refunded

Quando uma compra tem seu status REFUNDED, e o pagamento também vai para REFUNDED. Isso ocorre quando o valor total de uma compra já paga é devolvido ao pagador.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento reembolsado está em REFUNDED; veja payments[].refunds para o histórico.

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstringsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobjectsempre presente1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente8 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente5 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstring

            ID da configuração de aparência.

          • createdAtstring (data)

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstring

              ID da configuração de exibição do valor.

            • createdAtstring (data)

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstringsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray de object ou nullsempre presente5 campos

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

              • _idstringsempre presente

                ID do metadado.

              • createdAtstring (data)sempre presente

                Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

              • keystringsempre presente

                Chave do metadado, como foi cadastrada no produto.

              • updatedAtstring (data)sempre presente

                Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

              • valuestringsempre presente

                Valor do metadado.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente3 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente4 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstring ou nullsempre presente

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.refunded"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente12 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountinteger

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • installmentnull

        Só em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.

      • paymentMethodstring

        Só em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.

        BANK_SLIPCREDIT_CARDMONEYPIX
      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobject6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystringsempre presente

        ID de quem alterou o desconto pela última vez.

      • voucherstring

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstringsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray de object ou nullsempre presente5 campos

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

          • _idstringsempre presente

            ID do metadado.

          • createdAtstring (data)sempre presente

            Data em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.

          • keystringsempre presente

            Chave do metadado, como foi cadastrada no produto.

          • updatedAtstring (data)sempre presente

            Data da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.

          • valuestringsempre presente

            Valor do metadado.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente3 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente4 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente14 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data)

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • qrCodeUrlstring

      Só em PIX: URL da imagem do QR Code.

    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundsarray de object7 campos

      Histórico de reembolsos deste pagamento, do mais antigo para o mais recente, com todos os status (inclusive os que falharam). Só aparece quando o pagamento teve algum reembolso. Não some os amount daqui para saber o total devolvido; use refundedAmount.

      • _idstringsempre presente

        ID do reembolso.

      • amountintegersempre presente

        Valor deste reembolso isolado. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o reembolso foi solicitado. Data e hora em ISO 8601, no fuso UTC.

      • currencystringsempre presente

        Moeda do reembolso, em código ISO 4217 (ex.: BRL).

      • descriptionstring

        Observação livre escrita pelo administrador ao fazer o reembolso. Só aparece quando foi preenchida.

      • reasonstringsempre presente

        Motivo do reembolso informado pelo administrador.

        DUPLICATEFRAUDULENTOTHERREQUESTED_BY_CUSTOMER
      • statusstringsempre presente

        Status do reembolso. PAID é o reembolso concluído.

        CANCELEDFAILEDPAIDPENDING
    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressnullsempre presente

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "b2851d1084f4a5aaffb14b91",
"checkout": {
"_id": "a2419d08c120c1f9b9c7473b",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "i3cjs4yjtd",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "453f629f8e0da6858ebe9142",
"checkoutSharedId": "i3cjs4yjtd",
"createdAt": "2026-08-27T13:19:15.474Z",
"eventType": "purchase.refunded",
"invoice": {
"_id": "663388cb7e5da9dd04eaeb83",
"discountedAmount": 50000,
"discounts": 1 item
"dueAmount": 5333,
"items": 4 itens
"itemsAmount": 55333,
"paidAmount": 0,
"refundedAmount": 5333,
"status": "REFUNDED",
"totalAmount": 5333
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
14 campos neste exemplo
],
"queryParams": {},
"status": "REFUNDED",
"updatedAt": "2026-09-15T03:46:11.304Z",
"user": {
"_id": "cf2598bcad104cbd5543dc35",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "9764800ae02ec43127c6db9a",
"address": null,
"country": "BR",
"createdAt": "2026-08-27T13:19:05.119Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-08-27T13:19:05.119Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.

purchase.refused

Quando uma compra é recusada no Checkout.Isso ocorre quando uma compra no Cartão de Crédito é recusada.

A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = REFUSED e o pagamento mais recente em REFUSED (cartão recusado pelo emissor).

Campos

  • _idstringsempre presente

    ID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).

  • checkoutobjectsempre presente5 campos

    O checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.

    • _idstringsempre presente

      ID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.

    • descriptionstringsempre presente

      Descrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.

    • purchaseChoicesobjectsempre presente1 campo

      Opções de venda do checkout.

      • choicesarray de objectsempre presente9 campos

        Lista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.

        • _idstringsempre presente

          ID da opção de venda.

        • appearanceobjectsempre presente5 campos

          Como a opção de venda aparece para o comprador no checkout.

          • _idstringsempre presente

            ID da configuração de aparência.

          • createdAtstring (data)sempre presente

            Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.

          • namestringsempre presente

            Nome da opção de venda exibido no checkout (ex.: "Plano anual").

          • updatedAtstring (data)sempre presente

            Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.

          • valueDisplayobjectsempre presente6 campos

            Como o valor da opção é mostrado no checkout.

            • _idstringsempre presente

              ID da configuração de exibição do valor.

            • createdAtstring (data)sempre presente

              Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.

            • priceTextstring

              Só em CUSTOM: texto exibido no lugar do valor.

            • supportTextstring

              Só em CUSTOM: texto de apoio exibido junto ao valor.

            • typestringsempre presente

              AUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.

              AUTOMATICCUSTOM
            • updatedAtstring (data)sempre presente

              Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.

        • defaultbooleansempre presente

          true na opção que aparece selecionada quando a pessoa abre o checkout.

        • invoiceDiscountedAmountintegersempre presente

          Total de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceDiscountsarray de object8 campos

          Descontos configurados na opção de venda. Só aparece quando a opção tem algum.

          • _idstringsempre presente

            ID do desconto.

          • amountintegersempre presente

            Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

          • createdBystringsempre presente

            ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

          • descriptionstringsempre presente

            Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

          • percentnumber

            Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

          • typestringsempre presente

            Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

            MANUALPAYMENT_METHODVOUCHER
          • updatedAtstring (data)sempre presente

            Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsarray de objectsempre presente9 campos

          Itens cobrados, um por produto ou item avulso.

          • _idstringsempre presente

            ID do item.

          • amountinteger

            Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

          • createdAtstring (data)sempre presente

            Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

          • namestring

            Só em itens INLINE: nome do item avulso.

          • productobject8 campos

            Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

            • _idstringsempre presente

              ID do produto.

            • createdAtstring (data)sempre presente

              Data em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.

            • descriptionstring ou nullsempre presente

              Descrição do produto. Vem null quando não foi preenchida.

            • metadataarray ou nullsempre presente

              Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

            • namestringsempre presente

              Nome do produto.

            • priceobjectsempre presente7 campos

              Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

              • _idstringsempre presente

                ID do preço.

              • billingConfigobjectsempre presente3 campos

                Como o valor do preço é calculado.

                • _idstringsempre presente

                  ID da configuração de valor.

                • typestringsempre presente

                  Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

                  ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
                • unitAmountintegersempre presente

                  Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

              • createdAtstring (data)sempre presente

                Data em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.

              • currencystringsempre presente

                Moeda do preço, em código ISO 4217 (ex.: BRL).

              • descriptionstring ou nullsempre presente

                Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

              • paymentConfigobjectsempre presente4 campos

                Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

                • _idstringsempre presente

                  ID da configuração de cobrança.

                • chargeLimitinteger

                  Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

                • intervalobject5 campos

                  Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

                  • _idstringsempre presente

                    ID do intervalo.

                  • amountintegersempre presente

                    Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

                  • createdAtstring (data)sempre presente

                    Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

                  • unitstringsempre presente

                    Unidade de tempo do intervalo.

                    DAYMINUTEMONTHWEEKYEAR
                  • updatedAtstring (data)sempre presente

                    Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

                • typestringsempre presente

                  Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

                  GIVEN_TIMEONE_TIMERECURRING
              • updatedAtstring (data)sempre presente

                Data da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

              ACCESSOTHER
            • updatedAtstring (data)sempre presente

              Data da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.

          • productPricestring

            ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

          • quantityintegersempre presente

            Quantidade do produto neste item.

          • typestringsempre presente

            Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

            INLINEPRODUCT
          • updatedAtstring (data)sempre presente

            Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

        • invoiceItemsAmountintegersempre presente

          Soma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

        • invoiceTotalAmountintegersempre presente

          Valor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).

        • statusstringsempre presente

          Status da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.

          ACTIVEINACTIVE
    • sharedIdstringsempre presente

      ID do checkout, o mesmo de checkoutSharedId na raiz.

    • statusstringsempre presente

      Status do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.

      ACTIVEINACTIVE
  • checkoutPurchaseChoiceIdstringsempre presente

    ID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.

  • checkoutSharedIdstringsempre presente

    ID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.

  • createdAtstring (data)sempre presente

    Data em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.

  • eventTypestring = "purchase.refused"sempre presente

    Nome do evento que gerou este envio.

  • invoiceobjectsempre presente10 campos

    A fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.

    • _idstringsempre presente

      ID da fatura.

    • discountedAmountintegersempre presente

      Total de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).

    • discountsarray de objectsempre presente11 campos

      Descontos aplicados na fatura.

      • _idstringsempre presente

        ID do desconto.

      • amountinteger

        Valor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.

      • createdBystringsempre presente

        ID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.

      • descriptionstring

        Texto do desconto, como aparece para o comprador (ex.: "Primeira compra").

      • percentnumber

        Só em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.

      • redemptionobject6 campos

        Só em VOUCHER: o resgate do cupom nesta compra.

        • _idstringsempre presente

          ID do resgate.

        • createdAtstring (data)sempre presente

          Data em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.

        • discountedAmountintegersempre presente

          Valor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).

        • redeemedAtstring (data)sempre presente

          Data em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.

        • redeemedCodestringsempre presente

          Código do cupom como o comprador digitou.

        • updatedAtstring (data)sempre presente

          Data da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Origem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.

        MANUALPAYMENT_METHODVOUCHER
      • updatedAtstring (data)sempre presente

        Data da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.

      • updatedBystring

        ID de quem alterou o desconto pela última vez.

      • voucherstring

        Só em VOUCHER: ID do cupom usado.

    • dueAmountintegersempre presente

      Valor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).

    • itemsarray de objectsempre presente9 campos

      Itens cobrados, um por produto ou item avulso.

      • _idstringsempre presente

        ID do item.

      • amountinteger

        Só em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).

      • createdAtstring (data)sempre presente

        Data em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.

      • namestring

        Só em itens INLINE: nome do item avulso.

      • productobject6 campos

        Só em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.

        • _idstringsempre presente

          ID do produto.

        • descriptionstring ou nullsempre presente

          Descrição do produto. Vem null quando não foi preenchida.

        • metadataarray ou nullsempre presente

          Metadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.

        • namestringsempre presente

          Nome do produto.

        • priceobjectsempre presente5 campos

          Preço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.

          • _idstringsempre presente

            ID do preço.

          • billingConfigobjectsempre presente3 campos

            Como o valor do preço é calculado.

            • _idstringsempre presente

              ID da configuração de valor.

            • typestringsempre presente

              Modelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.

              ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUME
            • unitAmountintegersempre presente

              Valor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

          • currencystringsempre presente

            Moeda do preço, em código ISO 4217 (ex.: BRL).

          • descriptionstring ou nullsempre presente

            Descrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.

          • paymentConfigobjectsempre presente4 campos

            Como o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.

            • _idstringsempre presente

              ID da configuração de cobrança.

            • chargeLimitinteger

              Só em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.

            • intervalobject5 campos

              Só em RECURRING: de quanto em quanto tempo a assinatura é cobrada.

              • _idstringsempre presente

                ID do intervalo.

              • amountintegersempre presente

                Quantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).

              • createdAtstring (data)sempre presente

                Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.

              • unitstringsempre presente

                Unidade de tempo do intervalo.

                DAYMINUTEMONTHWEEKYEAR
              • updatedAtstring (data)sempre presente

                Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.

            • typestringsempre presente

              Forma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.

              GIVEN_TIMEONE_TIMERECURRING
        • typestringsempre presente

          Tipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).

          ACCESSOTHER
      • productPricestring

        ID do preço do produto usado neste item. É o mesmo valor de product.price._id.

      • quantityintegersempre presente

        Quantidade do produto neste item.

      • typestringsempre presente

        Tipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.

        INLINEPRODUCT
      • updatedAtstring (data)sempre presente

        Data da última alteração do item. Data e hora em ISO 8601, no fuso UTC.

    • itemsAmountintegersempre presente

      Soma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • paidAmountintegersempre presente

      Valor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).

    • refundedAmountintegersempre presente

      Valor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status da fatura.

      DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOID
    • totalAmountintegersempre presente

      Valor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).

  • organizationstringsempre presente

    ID da sua organização na EngagED.

  • paymentsarray de objectsempre presente12 campos

    Todas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.

    • _idstringsempre presente

      ID do pagamento.

    • additionalAdvanceFeeintegersempre presente

      Juros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).

    • amountintegersempre presente

      Valor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).

    • codestring

      Só em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.

    • createdAtstring (data)sempre presente

      Data em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do pagamento, em código ISO 4217 (ex.: BRL).

    • expirationDatestring (data)

      Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.

    • installmentsintegersempre presente

      Número de parcelas. Em boleto e PIX é sempre 1.

    • paymentMethodstringsempre presente

      Forma de pagamento. BANK_SLIP é boleto.

      BANK_SLIPCREDIT_CARDMONEYPIX
    • refundedAmountintegersempre presente

      Valor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).

    • statusstringsempre presente

      Status do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.

      ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENT
    • statusAtstring (data)sempre presente

      Data em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.

  • queryParamsobjectsempre presente

    Parâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.

  • statusstringsempre presente

    Status da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).

    DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOID
  • updatedAtstring (data)sempre presente

    Data da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.

  • userobjectsempre presente6 campos

    A pessoa que fez a compra.

    • _idstringsempre presente

      ID da pessoa na EngagED. É o mesmo em todas as compras dela.

    • customFieldsAnswersobject1 campo

      Respostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.

      • {chave}object5 campos

        Resposta a um campo personalizado.

        • _idstringsempre presente

          ID da resposta.

        • documentTypestring

          Só em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.

          BR_CNPJBR_CPF
        • typestringsempre presente

          Tipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).

          DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORT
        • updatedAtstring (data)sempre presente

          Data da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.

        • valueinteger | stringsempre presente

          A resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.

    • emailstringsempre presente

      E-mail informado no checkout.

    • namestringsempre presente

      Nome completo informado no checkout.

    • phoneNumberstringsempre presente

      Telefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.

    • phoneNumberCountrystringsempre presente

      País do telefone, em código ISO 3166 de duas letras (ex.: BR).

  • userPaymentProfileobjectsempre presente9 campos

    Dados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.

    • _idstringsempre presente

      ID do perfil de cobrança.

    • addressobject ou nullsempre presente8 campos

      Endereço de cobrança. Vem null quando o checkout não pede endereço.

      • cityobjectsempre presente2 campos

        Cidade.

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais da cidade, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE da cidade).

        • namestringsempre presente

          Nome da cidade.

      • complementstring

        Complemento. Só aparece quando foi preenchido.

      • countrystringsempre presente

        País do endereço, em código ISO 3166 de duas letras (ex.: BR).

      • neighborhoodstringsempre presente

        Bairro.

      • numberstring ou nullsempre presente

        Número. Pode vir null.

      • stateobjectsempre presente3 campos

        Estado.

        • codestringsempre presente

          Sigla do estado (ex.: PR).

        • metadataarray de objectsempre presente2 campos

          Códigos oficiais do estado, em pares chave e valor.

          • keystringsempre presente

            Nome do código (ex.: ibge_id).

          • valuestringsempre presente

            Valor do código (ex.: o código IBGE do estado).

        • namestringsempre presente

          Nome do estado.

      • streetstringsempre presente

        Logradouro.

      • zipcodestringsempre presente

        CEP, só com dígitos.

    • countrystringsempre presente

      País do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).

    • createdAtstring (data)sempre presente

      Data em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.

    • currencystringsempre presente

      Moeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).

    • namestringsempre presente

      Nome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).

    • taxIdsarray de objectsempre presente6 campos

      Documentos fiscais do titular.

      • _idstringsempre presente

        ID do documento.

      • countrystringsempre presente

        País do documento, em código ISO 3166 de duas letras (ex.: BR).

      • createdAtstring (data)sempre presente

        Data em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.

      • typestringsempre presente

        Tipo do documento. No Brasil: BR_CPF ou BR_CNPJ.

        BR_CNPJBR_CPFPASSPORT
      • updatedAtstring (data)sempre presente

        Data da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.

      • valuestringsempre presente

        Número do documento, só com dígitos (sem pontos, traço ou barra).

    • typestringsempre presente

      Tipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).

      COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFIT
    • updatedAtstring (data)sempre presente

      Data da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.

Exemplo de payload
{
"_id": "0f70eb697154eae61a0df4e2",
"checkout": {
"_id": "ce33da9718746362e0391d8b",
"description": "Checkout do Curso Exemplo",
"purchaseChoices": 1 campo neste exemplo
"sharedId": "9ybhylt1ob",
"status": "ACTIVE"
},
"checkoutPurchaseChoiceId": "3a01f4404578de542b1687be",
"checkoutSharedId": "9ybhylt1ob",
"createdAt": "2026-09-18T20:32:18.688Z",
"eventType": "purchase.refused",
"invoice": {
"_id": "28b69d10351976b96b9a1859",
"discountedAmount": 6499,
"discounts": 2 itens
"dueAmount": 5000,
"items": 3 itens
"itemsAmount": 11499,
"paidAmount": 0,
"refundedAmount": 0,
"status": "OPEN",
"totalAmount": 5000
},
"organization": "1962f4ab59f82366f96e7762",
"payments": [
10 campos neste exemplo
],
"queryParams": {},
"status": "REFUSED",
"updatedAt": "2026-09-18T20:32:18.688Z",
"user": {
"_id": "3e0a98b0e59fdf5487a3bec1",
"customFieldsAnswers": 8 campos neste exemplo
"email": "maria.oliveira@exemplo.com.br",
"name": "Maria Oliveira",
"phoneNumber": "+5541999990000",
"phoneNumberCountry": "BR"
},
"userPaymentProfile": {
"_id": "43113def09e9a94a27a715ac",
"address": 7 campos neste exemplo
"country": "BR",
"createdAt": "2026-09-18T20:32:08.067Z",
"currency": "BRL",
"name": "Maria Oliveira",
"taxIds": 1 item
"type": "INDIVIDUAL",
"updatedAt": "2026-09-18T20:32:08.067Z"
}
}

Dados fictícios, com a mesma estrutura de um envio real.