Compra aprovada

Code Block

{
  "client_type_person": "J",
  "client_cpf": null,
  "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": "status do pagamento",
  "payment_order_code": "codigo do pagamento",
  "payment_type": "tipo de pagamento",
  "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": []
    }
  ],
  "utm_source": null,
  "utm_medium": null,
  "utm_campaign": null,
  "utm_term": null,
  "utm_content": null
}

Gerando boleto

...

Table of Contents

style	none

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.

Code Block

language	json

{
    "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

Code Block

language	json

{
    "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

Code Block

language	json

{
  "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",
  "subscriber_plan_idpayment_price": "preço",
  "payment_date": "iddata do planopagamento",
  "subscriberpayment_emailstatus": "canceled"email do| comprado"failed", |  "subscriber_name": "nome do compradorpending" | "paid",
  "subscriberpayment_order_phonecode": "telefonecodigo do compradorpagamento",
  "subscriberpayment_birthdaytype": "nascimento do compradorboleto",
  "subscriberpayment_installment_zipcodenumber": 1,
"cep do compradro""payment_installments": 1,
  "subscriberpayment_streetmodel": "rua do comprador "P",
  "subscriberpayment_customer_numbervalue": "número da residencia do comprador"1.76,
  "payment_plans_value": 4,
  "subscriberpayment_compplans": "complemento do endereço do comprador", [
    {
      "subscriber_districtid": "bairroid do compradorplano",
  "subscriber_city    "plan": "cidadenome do compradorplano",
  "subscriber_state    "type": "product"estado,
  do comprador",   "subscriber_countryprice": "paispreço do compradorplano",
      "subscriberprice_documentplus_typefees": "tipo4,
de documento do comprador",   "subscriber_document_numbercoproducers": "número[],
do documento do comprador",   "payment_priceaffiliate": "preço", []
    "payment_date": "data do pagamento",}
  ],
}

PIX gerado

Evento disparado quando o comprador gera um PIX

Code Block

language	json

{
  "paymentevent_statustype": "status do pagamentoonCreatePix",
  "paymentclient_ordertype_codeperson": "codigoJ" do| pagamento"F",
  "paymentclient_typecpf": "pix",
  "payment_installment_number": 1null | "123.456.789-01",
  "paymentclient_installmentscnpj": 1"01.234.567/0001-89",
  "paymentclient_fantasy_modelname": "Prazao social",
  "paymentclient_customercompany_valuename": 1.76"Nome da empresa aqui",
  "paymentclient_plans_valueaddress": 4"endereço",
  "paymentclient_plansnumber": [
    {
 "123",
    "idclient_complement": "id do planoap",
  "client_district": "endereço",
  "planclient_city": "nome do planocidade",
  "client_state": "estado",
  "typeclient_zipcode": "productcep",
  "client_holder_name": "Nome plataforma",
  "pricesubscriber_id": "preçoid do planocomprador",
   
  "pricesubscriber_plusplan_feesid": 4,"id do plano",
    "coproducerssubscriber_email": [],"email do comprado",
    "affiliatesubscriber_name": []"nome     }
  ],
}

Gerando Pix

Code Block

{
  "client_type_persondo comprador",
  "subscriber_phone": "Jtelefone do comprador",
  "clientsubscriber_cpfbirthday": null "nascimento do comprador",
  "clientsubscriber_cnpjzipcode": "01.234.567/0001-89cep do compradro",
  "clientsubscriber_fantasy_namestreet": "razaorua do socialcomprador",
  "clientsubscriber_company_namenumber": "Nomenúmero da empresaresidencia do aquicomprador",
  "clientsubscriber_addresscomp": "complemento do endereço do comprador",
  "clientsubscriber_numberdistrict": "123bairro do comprador",
  "clientsubscriber_complementcity": "apcidade do comprador",
  "clientsubscriber_districtstate": "endereçoestado do comprador",
  "clientsubscriber_citycountry": "cidadepais do comprador",
  "clientsubscriber_document_statetype": "estadotipo de documento do comprador",
  "clientsubscriber_document_zipcodenumber": "cepnúmero do documento do comprador",
  "clientpayment_holder_nameprice": "Nome plataformapreço",
  "subscriberpayment_iddate": "iddata do compradorpagamento",
  "subscriberpayment_plan_idstatus": "canceled" | "failed" | "pending"id do| plano"paid",
  "subscriberpayment_order_emailcode": "emailcodigo do compradopagamento",
  "subscriberpayment_nametype": "nome do compradorpix",
  "subscriberpayment_installment_phonenumber": "telefone do comprador"1,
  "subscriberpayment_birthdayinstallments": "nascimento do comprador"1,
  "subscriberpayment_zipcodemodel": "cep do compradroP",
  "subscriberpayment_customer_streetvalue": 1.76,
"rua do comprador" "payment_plans_value": 4,
  "subscriberpayment_expires_numberat": "númerodata da residenciaexpiração do compradorpix",
  "subscriberpayment_pix_compqrcode": "complementocodigo do endereço do compradorpix",
  "subscriberpayment_districtplans": "bairro[
 do comprador",  {
"subscriber_city": "cidade do comprador",   "subscriber_stateid": "estadoid do compradorplano",
      "subscriber_countryplan": "paisnome do compradorplano",
  "subscriber_document_    "type": "product"tipo,
de documento do comprador",   "subscriber_document_numberprice": "númeropreço do documentoplano",
  do comprador",   "paymentprice_plus_pricefees": "preço"4,
      "payment_datecoproducers": "data do pagamento",[],
      "payment_statusaffiliate": "status do pagamento",
  "payment_order_code": "codigo do pagamento",
  "payment[]
    }
  ],
}

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

Code Block

language	json

{
  "event_type": "pixonApprovePayment",
  "paymentclient_installmenttype_numberperson": 1,
  "payment_installments": 1,
  "payment_model": "P""J" | "F",
  "paymentclient_customer_valuecpf": 1.76,
  "payment_plans_value": 4null | "123.456.789-01",
  "paymentclient_expires_atcnpj": "data da expiração pix""01.234.567/0001-89" | null,
  "paymentclient_pixfantasy_qrcodename": "codigorazao do pixsocial",
  "paymentclient_company_plansname": ["Nome da empresa  aqui",
{       "id"client_address": "id do planoendereço",
   
  "planclient_number": "nome do plano123",
      "type"client_complement": "productap",
   
  "priceclient_district": "preço do planoendereço",
 
    "priceclient_plus_feescity": 4"cidade",
      "coproducers"client_state": [],
   "estado",
  "affiliate": []
    }
  ],
}

Compra recusada

Code Block

{client_zipcode": "cep",
  "client_holder_name": "Nome plataforma",
  "subscriber_id": 1"id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email do compradorcomprado",
  "subscriber_name": "nome do comprador",
  "subscriber_phone": "telefone do comprador",
  "subscriber_birthday": "datanascimento dedo nascimento comprador",
  "subscriber_zipcode": "cep compradordo compradro",
  "subscriber_street": "rua do comprador",
  "subscriber_number": numero casa"número da residencia do comprador",
  "subscriber_comp": comoplemento"complemento do endereço do comprador",
  "subscriber_district": "bairro do comprador",
  "subscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
  "subscriber_country": "paíspais do comprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "subscriber_document_number": "número do documento do comprador",
  "subscriber_phone_country_codepayment_price": "preço",
  "payment_date": "codigodata do paíspagamento",
  "subscriber_phone_area_codepayment_status": "codigo do paíspaid",
  "subscriberpayment_phoneorder_numbercode": "númerocodigo do telefone do compradorpagamento",
  "transactionpayment_platform_idtype": "pix" | "id da plataformaboleto" | "credit_card",
  "transactionpayment_orderinstallment_codenumber": "codigo1,
 da compra""payment_installments": 1,
  "transactionpayment_op_codemodel": "1009P",
  "transactionpayment_opcustomer_messagevalue": "Transação não autorizada"1.76,
  "transactionpayment_plans_totalvalue": 18004,
  "transactionpayment_statusplans": "failed", [
    {
      "transaction_typeid": "tipoid dedo transaçãoplano",
  "transaction_origin    "plan": "transactionnome do plano",
      "transactionproduct_id": "id dado tranaçãoproduto",
      "transactionproduct_plansname": ["nome do produto",
  {       "idtype": id"product",
      "planprice": "preço do plano",
      "typeprice_plus_fees": "default"4,
      "pricecoproducers": preço[],
    }  "affiliate": [],
  "payment_order_code": "número do pagamento",}
  "payment_price": 1800],
  "paymentutm_statussource": "failed"null,
  "paymentutm_typemedium": "tipo de pagamento"null,
  "changeutm_card_urlcampaign": "url de opções de cartões" null,
  "paymentutm_dateterm": data de pagamentonull,
  "paymentutm_planscontent": [
    null
}

Compra recusada

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

Code Block

language	json

{
  "event_type": "onRefusePayment",
  "subscriber_id": id comprador,
      "subscriber_plan_id": "plano",
 id do plano,
  "typesubscriber_email": "defaultemail comprador",
      "price"subscriber_name": preço"nome comprador",
   }
  ]
}

Compra estornada

Code Block

{
"client_type_person"subscriber_phone": "Jtelefone comprador",
  "clientsubscriber_cpfbirthday": null"data de nascimento comprador",
  "clientsubscriber_cnpjzipcode": "01.234.567/0001-89"cep comprador",
  "clientsubscriber_fantasy_namestreet": "razaorua social"comprador,
  "clientsubscriber_company_namenumber": "Nomenumero dacasa empresado aqui"comprador,
  "clientsubscriber_addresscomp": comoplemento do "endereço" do comprador,
  "clientsubscriber_numberdistrict": "123" bairro do comprador,
  "clientsubscriber_complementcity": "ap"cidade do comprador,
  "clientsubscriber_districtstate": "endereço" estado do comprador,
  "clientsubscriber_citycountry": "cidadepaís do comprador",
  "clientsubscriber_document_statetype": "estadotipo de documento do comprador",
  "clientsubscriber_document_zipcodenumber": "cepnúmero do documento do comprador",
  "clientsubscriber_phone_holdercountry_namecode": "Nomecodigo do plataformapaís",
  "subscriber_idphone_area_code": "idcodigo do compradorpaís",
  "subscriber_planphone_idnumber": "idnúmero do telefone do planocomprador",
  "subscribertransaction_platform_emailid": "emailid doda compradoplataforma",
  "subscribertransaction_order_namecode": "nomecodigo doda compradorcompra",
  "subscribertransaction_op_phonecode": "telefone do comprador1009",
  "subscribertransaction_op_birthdaymessage": "nascimentoTransação donão compradorautorizada",
  "subscribertransaction_zipcodetotal": "cep do compradro"1800,
  "subscribertransaction_streetstatus": "rua do compradorfailed",
  "subscribertransaction_numbertype": "númerotipo da residencia do compradorde transação",
  "subscribertransaction_comporigin": "complemento do endereço do compradortransaction",
  "subscribertransaction_districtid": "bairroid doda comprador"tranação,
  "subscribertransaction_cityplans": [
"cidade do comprador",  {
"subscriber_state": "estado do comprador",   "subscriber_countryid": id,
"pais  do comprador",   "subscriber_document_typeplan": "tipoplano",
de documento do comprador",   "subscriber_document_numbertype": "default"número,
do documento do comprador",   "payment_price": preço,
  "payment_date": data do pagamento,
  "payment_status": "canceled",
  "payment_expires_at": null }
  ],
  "payment_order_code": "codigonúmero do pagamento",
  "payment_typeprice": "tipo de pagamento"1800,
  "payment_installmentsstatus": 1"failed",
  "payment_modeltype": "Rtipo de pagamento",
  "paymentchange_customercard_valueurl": 41.71,
  "payment_pix_qrcode": null,
  "payment_installment_number": 1"url de opções de cartões",
  "payment_plans_valuedate": 46.5 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

Code Block

language	json

{
  "event_type": "defaultonRefundPayment",
   
  "priceclient_type_person": preço"J" | "F",
    "priceclient_plus_feescpf": 46.5,
null | "123.456.789-01",
     "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": []
    }
  ]
}

Inscrição cancelada

Code Block

{
"client_type_person": "J",
  "client_cpf": null,
  "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",
  "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": [
    {
      "plan": "nome do plano",
      "type": "tipo",
      "price": preço,
      "price_plus_fees": 4"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

Info
Informação pendente

Versions Compared

Old Version 1

New Version Current

Key

Compra aprovada

Gerando boleto

Informações gerais

Lead gerado

Carrinho abandonado

Boleto gerado

PIX gerado

Gerando Pix

Compra aprovada

Compra recusada

Compra recusada

Compra estornada

Compra estornada

Inscrição cancelada

Chargeback

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Compra aprovada

Gerando boleto

Informações gerais

Lead gerado

Carrinho abandonado

Boleto gerado

PIX gerado

Gerando Pix

Compra aprovada

Compra recusada

Compra recusada

Compra estornada

Compra estornada

Inscrição cancelada

Chargeback