1 Informações gerais
2 Lead gerado
3 Carrinho abandonado
4 Boleto gerado
5 PIX gerado
6 Compra aprovada
7 Compra recusada
8 Compra estornada
9 Chargeback

Informações gerais

Todos os webhook disparados utilizam o formato json com método POST

Lead gerado

Evento disparado após o comprador preencher os campos de contato (nome/email/telefone). No checkout de de dois passos, ocorre ao avançar para o segundo passo; no checkout de passo único, ocorre apenas se é efetuada a tentativa de compra.

{
    "event_type": "OnCreateLead"
    "subscriber_email": "lead@xgrow.com",
    "subscriber_name": "Nome do comprador",
    "subscriber_zipcode": "",
    "subscriber_city": null,
    "subscriber_district": null,
    "subscriber_street": null,
    "subscriber_number": null,
    "subscriber_comp": null,
    "subscriber_plan_id": 1,
    "subscriber_state": null,
    "subscriber_phone": "(10) 999999999",
    "subscriber_phone_country_code": "55",
    "subscriber_phone_area_code": "99",
    "subscriber_phone_number": "999999999",
    "subscriber_document_number": "01234567890",
    "subscriber_document_type": "CPF",
    "subscriber_country": "BRA",
    "plan": {
        "id": 1,
        "plan": "Plano100",
        "type": "-",
        "price": "100.00",
        "price_plus_fees": "100.00"
    },
    "product": {
        "id": 1,
        "product": "Venda100",
        "type": "P",
        "description": "V100",
        "support_email": "venda100@xgrow.com"
    }
}

Carrinho abandonado

Evento disparado após 15min de um Lead (conferir evento anterior) que não finalizou a compra

{
    "event_type": "onAbandonedCart"
    "subscriber_id": 1,
    "subscriber_name": "Nome do aluno",
    "subscriber_email": "aluno-exemplo@xgrow.com",
    "subscriber_phone": "(99) 999999999",
    "subscriber_document_type": "CPF",
    "subscriber_document_number": "01234567890",
    "subscriber_zipcode": "",
    "subscriber_street": null,
    "subscriber_number": null,
    "subscriber_comp": null,
    "subscriber_district": null,
    "subscriber_city": null,
    "subscriber_state": null,
    "subscriber_country": "BRA",
    "subscriber_plan_id": 1,
    "plan": {
        "id": 1,
        "plan": "Plano 100 Reais",
        "type": "-",
        "price": "100.00",
        "price_plus_fees": "0.00"
    },
    "product": {
        "id": 1,
        "product": "Produto 100",
        "type": "P",
        "description": "Incrivel Produto 100",
        "support_email": "produto100@xgrow.com"
    }
}

Boleto gerado

Evento disparado quando o comprador gera um Boleto

{
  "event_type": "onCreateBankSlip"
  "client_type_person": "J" | "F",
  "client_cpf": null | "123.456.789-01",
  "client_cnpj": "01.234.567/0001-89",
  "client_fantasy_name": "razao social",
  "client_company_name": "Nome da empresa aqui",
  "client_address": "endereço",
  "client_number": "123",
  "client_complement": "ap",
  "client_district": "endereço",
  "client_city": "cidade",
  "client_state": "estado",
  "client_zipcode": "cep",
  "client_holder_name": "Nome plataforma",
  "subscriber_id": "id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email do comprado",
  "subscriber_name": "nome do comprador",
  "subscriber_phone": "telefone do comprador",
  "subscriber_birthday": "nascimento do comprador",
  "subscriber_zipcode": "cep do compradro",
  "subscriber_street": "rua do comprador",
  "subscriber_number": "número da residencia do comprador",
  "subscriber_comp": "complemento do endereço do comprador",
  "subscriber_district": "bairro do comprador",
  "subscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
  "subscriber_country": "pais do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "payment_price": "preço",
  "payment_date": "data do pagamento",
  "payment_status": "canceled" | "failed" | "pending" | "paid",
  "payment_order_code": "codigo do pagamento",
  "payment_type": "boleto",
  "payment_installment_number": 1,
  "payment_installments": 1,
  "payment_model": "P",
  "payment_customer_value": 1.76,
  "payment_plans_value": 4,
  "payment_plans": [
    {
      "id": "id do plano",
      "plan": "nome do plano",
      "type": "product",
      "price": "preço do plano",
      "price_plus_fees": 4,
      "coproducers": [],
      "affiliate": []
    }
  ],
}

PIX gerado

Evento disparado quando o comprador gera um PIX

{
  "event_type": "onCreatePix",
  "client_type_person": "J" | "F",
  "client_cpf": null | "123.456.789-01",
  "client_cnpj": "01.234.567/0001-89",
  "client_fantasy_name": "razao social",
  "client_company_name": "Nome da empresa aqui",
  "client_address": "endereço",
  "client_number": "123",
  "client_complement": "ap",
  "client_district": "endereço",
  "client_city": "cidade",
  "client_state": "estado",
  "client_zipcode": "cep",
  "client_holder_name": "Nome plataforma",
  "subscriber_id": "id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email do comprado",
  "subscriber_name": "nome do comprador",
  "subscriber_phone": "telefone do comprador",
  "subscriber_birthday": "nascimento do comprador",
  "subscriber_zipcode": "cep do compradro",
  "subscriber_street": "rua do comprador",
  "subscriber_number": "número da residencia do comprador",
  "subscriber_comp": "complemento do endereço do comprador",
  "subscriber_district": "bairro do comprador",
  "subscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
  "subscriber_country": "pais do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "payment_price": "preço",
  "payment_date": "data do pagamento",
  "payment_status": "canceled" | "failed" | "pending" | "paid",
  "payment_order_code": "codigo do pagamento",
  "payment_type": "pix",
  "payment_installment_number": 1,
  "payment_installments": 1,
  "payment_model": "P",
  "payment_customer_value": 1.76,
  "payment_plans_value": 4,
  "payment_expires_at": "data da expiração pix",
  "payment_pix_qrcode": "codigo do pix",
  "payment_plans": [
    {
      "id": "id do plano",
      "plan": "nome do plano",
      "type": "product",
      "price": "preço do plano",
      "price_plus_fees": 4,
      "coproducers": [],
      "affiliate": []
    }
  ],
}

Compra aprovada

Evento disparado quando a compra é aprovada, pode ser após a aprovação no Cartão de Crédito, confirmação do PIX ou compensação do Boleto

{
  "event_type": "onApprovePayment",
  "client_type_person": "J" | "F",
  "client_cpf": null | "123.456.789-01",
  "client_cnpj": "01.234.567/0001-89" | null,
  "client_fantasy_name": "razao social",
  "client_company_name": "Nome da empresa aqui",
  "client_address": "endereço",
  "client_number": "123",
  "client_complement": "ap",
  "client_district": "endereço",
  "client_city": "cidade",
  "client_state": "estado",
  "client_zipcode": "cep",
  "client_holder_name": "Nome plataforma",
  "subscriber_id": 1"id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email do comprado",
  "subscriber_name": "nome do comprador",
  "subscriber_phone": "telefone do comprador",
  "subscriber_birthday": "nascimento do comprador",
  "subscriber_zipcode": "cep do compradro",
  "subscriber_street": "rua do comprador",
  "subscriber_number": "número da residencia do comprador",
  "subscriber_comp": "complemento do endereço do comprador",
  "subscriber_district": "bairro do comprador",
  "subscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
  "subscriber_country": "pais do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "payment_price": "preço",
  "payment_date": "data do pagamento",
  "payment_status": "paid",
  "payment_order_code": "codigo do pagamento",
  "payment_type": "pix" | "boleto" | "credit_card",
  "payment_installment_number": 1,
  "payment_installments": 1,
  "payment_model": "P",
  "payment_customer_value": 1.76,
  "payment_plans_value": 4,
  "payment_plans": [
    {
      "id": "id do plano",
      "plan": "nome do plano",
      "product_id": "id do produto",
      "product_name": "nome do produto",
      "type": "product",
      "price": "preço do plano",
      "price_plus_fees": 4,
      "coproducers": [],
      "affiliate": []
    }
  ],
  "utm_source": null,
  "utm_medium": null,
  "utm_campaign": null,
  "utm_term": null,
  "utm_content": null
}

Compra recusada

Evento disparado quando a compra é recusada, ocorre apenas para Cartão

{
  "event_type": "onRefusePayment",
  "subscriber_id": id comprador,
  "subscriber_plan_id": id do plano,
  "subscriber_email": "email comprador",
  "subscriber_name": "nome comprador",
  "subscriber_phone": "telefone comprador",
  "subscriber_birthday": "data de nascimento comprador",
  "subscriber_zipcode": "cep comprador",
  "subscriber_street": rua comprador,
  "subscriber_number": numero casa do comprador,
  "subscriber_comp": comoplemento do endereço do comprador,
  "subscriber_district": bairro do comprador,
  "subscriber_city": cidade do comprador,
  "subscriber_state": estado do comprador,
  "subscriber_country": "país do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "subscriber_phone_country_code": "codigo do país",
  "subscriber_phone_area_code": "codigo do país",
  "subscriber_phone_number": "número do telefone do comprador",
  "transaction_platform_id": "id da plataforma",
  "transaction_order_code": "codigo da compra",
  "transaction_op_code": "1009",
  "transaction_op_message": "Transação não autorizada",
  "transaction_total": 1800,
  "transaction_status": "failed",
  "transaction_type": "tipo de transação",
  "transaction_origin": "transaction",
  "transaction_id": id da tranação,
  "transaction_plans": [
    {
      "id": id,
      "plan": "plano",
      "type": "default",
      "price": preço
    }
  ],
  "payment_order_code": "número do pagamento",
  "payment_price": 1800,
  "payment_status": "failed",
  "payment_type": "tipo de pagamento",
  "change_card_url": "url de opções de cartões",
  "payment_date": data de pagamento,
  "payment_plans": [
    {
      "id": id,
      "plan": "plano",
      "type": "default",
      "price": preço
    }
  ]
}

Compra estornada

Evento quando a compra foi estornadas, seja via Cartão, Boleto ou PIX

{
  "event_type": "onRefundPayment",
  "client_type_person": "J" | "F",
  "client_cpf": null | "123.456.789-01",
  "client_cnpj": "01.234.567/0001-89",
  "client_fantasy_name": "razao social",
  "client_company_name": "Nome da empresa aqui",
  "client_address": "endereço",
  "client_number": "123",
  "client_complement": "ap",
  "client_district": "endereço",
  "client_city": "cidade",
  "client_state": "estado",
  "client_zipcode": "cep",
  "client_holder_name": "Nome plataforma",
  "subscriber_id": "id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email do comprado",
  "subscriber_name": "nome do comprador",
  "subscriber_phone": "telefone do comprador",
  "subscriber_birthday": "nascimento do comprador",
  "subscriber_zipcode": "cep do compradro",
  "subscriber_street": "rua do comprador",
  "subscriber_number": "número da residencia do comprador",
  "subscriber_comp": "complemento do endereço do comprador",
  "subscriber_district": "bairro do comprador",
  "subscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
  "subscriber_country": "pais do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "payment_price": preço,
  "payment_date": data do pagamento,
  "payment_status": "refunded" | "pending_refund",
  "payment_expires_at": null,
  "payment_order_code": "codigo do pagamento",
  "payment_type": "tipo de pagamento",
  "payment_installments": 1,
  "payment_model": "R",
  "payment_customer_value": 41.71,
  "payment_pix_qrcode": null,
  "payment_installment_number": 1,
  "payment_plans_value": 46.5,
  "payment_plans": [
    {
      "id": id,
      "plan": "plano",
      "type": "default",
      "price": preço
      "price_plus_fees": 46.5,
      "coproducers": [
        {
          "id": id do coprodutor,
          "name": "namde do coprodutor",
          "email": email do coprodutor,
          "issue_invoice": false,
          "invoice_percent": 20,
          "address" rua do coprodutor,
          "city": cidade do coprodutor,
          "document": numero do documento do coprodutor,
          "document_type": tipo de documento do coprodutor,
          "complement": "",
          "district": bairro do coprodutor,
          "fantasy_name": null,
          "number": número da casa do coprodutor,
          "state": estado do coprodutor,
          "type_person": tipo de pessoa "fisico" ou "juridica",
          "zipcode": cep do coprodutor
        }
      ],
      "affiliate": []
    }
  ]
}

Chargeback

Informação pendente

Documentações

Documentação webhooks