Compra aprovada

...

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",
      "price_plus_fees  "type": 4"-",
        "coproducersprice": [],
      "affiliate": []
"100.00",
   }   ],   "utmprice_plus_sourcefees": null,
  "utm_medium": null,0.00"
   "utm_campaign": null },
    "utm_termproduct": null,{
  "utm_content": null }

Carrinho abandonado

Code Block

{
    "subscriber_id": 1,
        "subscriber_nameproduct": "Nome do aluno",Produto 100",
        "subscriber_emailtype": "aluno-exemplo@xgrow.comP",
        "subscriber_phonedescription": "(99) 999999999Incrivel Produto 100",
        "subscribersupport_document_typeemail": "CPFproduto100@xgrow.com",
    "subscriber_document_number": "01234567890",
}
}

Boleto gerado

Evento disparado quando o comprador gera um Boleto

Code Block

language	json

{
   "subscriberevent_zipcodetype": "onCreateBankSlip",
 
  "subscriber_street": null,
    "subscriber_numberclient_type_person": null,
    "subscriber_comp": null,
    "subscriber_district": null"J" | "F",
    "subscriberclient_citycpf": null,   |  "subscriber_state": null"123.456.789-01",
    "subscriberclient_countrycnpj": "BRA01.234.567/0001-89",
    "subscriberclient_planfantasy_idname": 1"razao social",
    "plan"client_company_name": {"Nome da        "id": 1,
  empresa aqui",
     "plan"client_address": "Plano 100 Reaisendereço",
     
  "typeclient_number": "-123",
   
    "priceclient_complement": "100.00ap",
    
   "priceclient_plus_feesdistrict": "0.00"
    },
 endereço",
  "productclient_city": {
    "cidade",
   "idclient_state": 1"estado",
    "client_zipcode": "cep",
   "productclient_holder_name": "ProdutoNome 100plataforma",
  "subscriber_id": "id do comprador",
  "typesubscriber_plan_id": "Pid do plano",
  "subscriber_email": "email do comprado",
  "descriptionsubscriber_name": "Incrivelnome Produtodo 100comprador",
    
   "supportsubscriber_email": "produto100@xgrow.com"
    }
}

Gerando boleto

Code Block

{phone": "telefone do comprador",
  "clientsubscriber_type_personbirthday": "Jnascimento do comprador",
  "clientsubscriber_cpfzipcode": null"cep do compradro",
  "clientsubscriber_cnpjstreet": "01.234.567/0001-89rua do comprador",
  "clientsubscriber_fantasy_namenumber": "razao socialnúmero da residencia do comprador",
  "clientsubscriber_company_namecomp": "Nomecomplemento do daendereço empresado aquicomprador",
  "clientsubscriber_addressdistrict": "endereçobairro do comprador",
  "clientsubscriber_numbercity": "123cidade do comprador",
  "clientsubscriber_complementstate": "apestado do comprador",
  "clientsubscriber_districtcountry": "endereçopais do comprador",
  "clientsubscriber_document_citytype": "cidadetipo de documento do comprador",
  "clientsubscriber_document_statenumber": "estadonúmero do documento do comprador",
  "clientpayment_zipcodeprice": "ceppreço",
  "clientpayment_holder_namedate": "Nomedata do plataformapagamento",
  "subscriberpayment_idstatus": "idcanceled" do| comprador"failed", |  "subscriber_plan_id": "id do planopending" | "paid",
  "subscriberpayment_order_emailcode": "emailcodigo do compradopagamento",
  "subscriberpayment_nametype": "nome do compradorboleto",
  "subscriberpayment_installment_phonenumber": 1,
"telefone do comprador""payment_installments": 1,
  "subscriberpayment_birthdaymodel": "nascimento do compradorP",
  "subscriberpayment_customer_zipcodevalue": "cep do compradro"1.76,
  "subscriberpayment_plans_streetvalue": "rua do comprador"4,
  "subscriberpayment_numberplans": "número da residencia do comprador",[
   "subscriber_comp": "complemento do endereço do comprador", {
      "subscriber_districtid": "bairroid do compradorplano",
      "subscriber_cityplan": "cidadenome do compradorplano",
  "subscriber_state    "type": "product"estado,
  do comprador",   "subscriber_countryprice": "paispreço do compradorplano",
  "subscriber_document_type": "tipo de documento do comprador",   "subscriberprice_documentplus_numberfees": "número4,
do documento do comprador",   "payment_pricecoproducers": "preço"[],
  "payment_date    "affiliate": "data do pagamento",
  "payment_status": "status do pagamento",[]
    }
  ],
}

PIX gerado

Evento disparado quando o comprador gera um PIX

Code Block

language	json

{
  "paymentevent_order_codetype": "codigo do pagamentoonCreatePix",
  "paymentclient_type_person": "pixJ", |  "payment_installment_number": 1F",
  "paymentclient_installmentscpf": 1,null |  "payment_model": "P""123.456.789-01",
  "paymentclient_customer_valuecnpj": 1.76"01.234.567/0001-89",
  "paymentclient_plansfantasy_valuename": 4"razao social",
  "paymentclient_company_plansname": ["Nome da empresa aqui",
 { "client_address": "endereço",
    "idclient_number": "id do plano123",
      "plan"client_complement": "nome do planoap",
      "type"client_district": "productendereço",

     "price"client_city": "preço do planocidade",
 
    "priceclient_plus_feesstate": 4"estado",
      "coproducers"client_zipcode": [],
   "cep",
  "affiliateclient_holder_name": []
    }
  ],
}

Gerando Pix

Code Block

{
  "client_type_person"Nome plataforma",
  "subscriber_id": "Jid do comprador",
  "clientsubscriber_plan_cpfid": null"id do plano",
  "clientsubscriber_cnpjemail": "01.234.567/0001-89email do comprado",
  "client_fantasysubscriber_name": "razaonome do socialcomprador",
  "clientsubscriber_company_namephone": "Nometelefone dado empresa aquicomprador",
  "clientsubscriber_addressbirthday": "endereçonascimento do comprador",
  "clientsubscriber_numberzipcode": "123cep do compradro",
  "clientsubscriber_complementstreet": "aprua do comprador",
  "clientsubscriber_districtnumber": "endereçonúmero da residencia do comprador",
  "clientsubscriber_citycomp": "cidadecomplemento do endereço do comprador",
  "clientsubscriber_statedistrict": "estadobairro do comprador",
  "clientsubscriber_zipcodecity": "cepcidade do comprador",
  "clientsubscriber_holder_namestate": "Nomeestado do plataformacomprador",
  "subscriber_idcountry": "idpais do comprador",
  "subscriber_plandocument_idtype": "idtipo de documento do planocomprador",
  "subscriber_emaildocument_number": "emailnúmero do documento do compradocomprador",
  "subscriberpayment_nameprice": "nome do compradorpreço",
  "subscriberpayment_phonedate": "telefonedata do compradorpagamento",
  "subscriberpayment_birthdaystatus": "canceled" | "failed" | "nascimentopending" do| comprador"paid",
  "subscriberpayment_order_zipcodecode": "cepcodigo do compradropagamento",
  "subscriberpayment_streettype": "rua do compradorpix",
  "subscriberpayment_installment_number": "número1,
da residencia do comprador" "payment_installments": 1,
  "subscriberpayment_compmodel": "complemento do endereço do compradorP",
  "subscriberpayment_customer_districtvalue": "bairro do comprador"1.76,
  "subscriberpayment_plans_city": "cidade do comprador"value": 4,
  "subscriberpayment_expires_stateat": "estadodata da doexpiração compradorpix",
  "subscriberpayment_pix_countryqrcode": "paiscodigo do compradorpix",
  "subscriberpayment_document_typeplans": "tipo de documento do comprador",[
    {
      "subscriber_document_numberid": "númeroid do documento do compradorplano",
  "payment_price": "preço",   "payment_dateplan": "datanome do pagamentoplano",
      "payment_statustype": "statusproduct",
  do pagamento",   "payment_order_codeprice": "codigopreço do pagamentoplano",
  "payment_type    "price_plus_fees": "pix"4,
  "payment_installment_number    "coproducers": 1,[],
      "payment_installmentsaffiliate": 1,[]
   "payment_model": "P", }
  "payment_customer_value": 1.76,],
}

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

{
  "paymentevent_plans_valuetype": 4"onApprovePayment",
  "paymentclient_expirestype_atperson": "data da expiração pixJ" | "F",
  "paymentclient_pix_qrcodecpf": "codigonull do pix| "123.456.789-01",
  "paymentclient_planscnpj": [
 "01.234.567/0001-89" | null,
  {
  "client_fantasy_name": "razao social",
   "idclient_company_name": "idNome da doempresa planoaqui",
   
  "planclient_address": "nome do planoendereço",
  "client_number": "123",
  "typeclient_complement": "productap",
  "client_district": "endereço",
  "priceclient_city": "preço do planocidade",
      "priceclient_plus_feesstate": 4,
  "estado",
   "coproducersclient_zipcode": [],
   "cep",
  "affiliateclient_holder_name": []
    }
  ],
}

Compra recusada

Code Block

{
  "Nome plataforma",
  "subscriber_id": 1"id do comprador",
  "subscriber_plan_id": "id do plano",
  "subscriber_email": "email compradordo comprado",
  "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": "número numeroda casaresidencia 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_areapayment_status": "paid",
  "payment_order_code": "codigo do país pagamento",
  "payment_type": "pix" | "boleto" | "credit_card",
  "subscriberpayment_phoneinstallment_number": "número1,
do telefone do comprador" "payment_installments": 1,
  "transactionpayment_platform_idmodel": "id da plataformaP",
  "transactionpayment_ordercustomer_codevalue": "codigo da compra"1.76,
  "transactionpayment_opplans_codevalue": "1009"4,
  "transaction_op_messagepayment_plans": [
    {
      "id": "Transaçãoid nãodo autorizadaplano",
  "transaction_total": 1800,   "transaction_statusplan": "failednome do plano",
      "transactionproduct_typeid": "tipoid dedo transaçãoproduto",
  "transaction_origin": "transaction",   "transactionproduct_idname": id"nome dado tranaçãoproduto",
  "transaction_plans": [   "type": "product",
{       "idprice": id "preço do plano",
      "planprice_plus_fees": "plano"4,
      "typecoproducers": "default"[],
      "priceaffiliate": preço[]
    }
  ],
  "payment_order_codeutm_source": null,
  "utm_medium": "número do pagamento"null,
  "utm_campaign": null,
  "utm_term": null,
  "paymentutm_pricecontent": 1800, null
}

Compra recusada

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

Code Block

language	json

{
  "paymentevent_statustype": "failedonRefusePayment",
  "paymentsubscriber_typeid": "tipo de pagamento"id comprador,
  "changesubscriber_cardplan_urlid": "urlid de opções de cartões"do plano,
  "paymentsubscriber_dateemail": data de pagamento"email comprador",
  "paymentsubscriber_plansname": ["nome comprador",
   {
   "subscriber_phone": "telefone comprador",
  "idsubscriber_birthday": id,"data de nascimento comprador",
   "plansubscriber_zipcode": "planocep comprador",
      "type"subscriber_street": rua "default"comprador,
  "subscriber_number": numero casa  "price": preço
    }
  ]
}

Compra estornada

Code Block

{
"client_type_person": "J"do comprador,
  "subscriber_comp": comoplemento do endereço do comprador,
  "subscriber_district": bairro do comprador,
  "clientsubscriber_cpfcity": cidade do nullcomprador,
  "clientsubscriber_cnpjstate": "01.234.567/0001-89"estado do comprador,
  "clientsubscriber_fantasy_namecountry": "razaopaís do socialcomprador",
  "clientsubscriber_companydocument_nametype": "Nometipo de dadocumento empresado aquicomprador",
  "clientsubscriber_document_addressnumber": "endereçonúmero do documento do comprador",
  "client_numbersubscriber_phone_country_code": "123codigo do país",
  "client_complementsubscriber_phone_area_code": "apcodigo do país",
  "clientsubscriber_phone_districtnumber": "endereçonúmero do telefone do comprador",
  "clienttransaction_platform_cityid": "cidadeid da plataforma",
  "clienttransaction_order_statecode": "estadocodigo da compra",
  "clienttransaction_op_zipcodecode": "cep1009",
  "clienttransaction_holderop_namemessage": "NomeTransação não plataformaautorizada",
  "subscribertransaction_idtotal": "id do comprador"1800,
  "subscribertransaction_plan_idstatus": "id do planofailed",
  "subscribertransaction_emailtype": "emailtipo dode compradotransação",
  "subscribertransaction_nameorigin": "nome do compradortransaction",
  "subscribertransaction_phoneid": "telefoneid doda comprador"tranação,
  "subscribertransaction_birthdayplans": "nascimento[
 do comprador",  {
"subscriber_zipcode": "cep do compradro",   "subscriber_streetid": "rua do comprador",id,
      "subscriber_numberplan": "númeroplano",
da residencia do comprador",   "subscriber_comptype": "default"complemento,
do endereço do comprador",   "subscriber_districtprice": "bairro do comprador"preço
    }
  ],
  "subscriberpayment_order_citycode": "cidadenúmero do compradorpagamento",
  "subscriberpayment_stateprice": "estado do comprador"1800,
  "subscriberpayment_countrystatus": "pais do compradorfailed",
  "subscriberpayment_document_type": "tipo de documento do compradorpagamento",
  "subscriberchange_documentcard_numberurl": "númerourl dode documentoopções dode compradorcartões",
  "payment_pricedate": data preçode pagamento,
  "payment_dateplans": data do pagamento, [
    {
      "payment_statusid": "canceled"id,
   "payment_expires_at   "plan": null"plano",
   "payment_order_code   "type": "codigodefault",
  do pagamento",   "payment_typeprice": preço
"tipo   de pagamento",}
  "payment_installments": 1,]
}

Compra estornada

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

Code Block

language	json

{
  "paymentevent_modeltype": "RonRefundPayment",
  "paymentclient_customertype_valueperson": 41.71,
  "payment_pix_qrcode": null"J" | "F",
  "paymentclient_installment_numbercpf": 1 null | "123.456.789-01",
  "paymentclient_plans_valuecnpj": 46.5"01.234.567/0001-89",
  "paymentclient_fantasy_plansname": [
    {
"razao social",
     "id"client_company_name": id,"Nome da empresa  aqui",
  "planclient_address": "planoendereço",
   
  "typeclient_number": "default123",
      "price"client_complement": preço"ap",
      "priceclient_plus_feesdistrict": 46.5"endereço",
      "coproducers": [
        {
       "client_city": "cidade",
  "idclient_state": id do coprodutor"estado",
       "client_zipcode": "cep",
  "client_holder_name": "namdeNome do coprodutorplataforma",
 
        "email"subscriber_id": email"id do coprodutor,
    comprador",
     "issue_invoice"subscriber_plan_id": false,
       "id do plano",
  "invoicesubscriber_percentemail": 20,"email do comprado",
  "subscriber_name": "nome do comprador",
  "addresssubscriber_phone": rua"telefone do coprodutorcomprador",
  "subscriber_birthday": "nascimento do comprador",
    "citysubscriber_zipcode": cidade"cep do coprodutorcompradro",
          "document"subscriber_street": numero do documento "rua do coprodutorcomprador",
  "subscriber_number": "número da residencia do comprador",
  "documentsubscriber_typecomp": tipo"complemento dedo documentoendereço do coprodutorcomprador",
  "subscriber_district": "bairro do comprador",
    "complementsubscriber_city": "cidade do comprador",
  "subscriber_state": "estado do comprador",
    "districtsubscriber_country": bairro"pais do coprodutorcomprador",
  "subscriber_document_type": "tipo de documento do comprador",
  "fantasysubscriber_document_namenumber": null,"número do documento do comprador",
  "payment_price": preço,
  "numberpayment_date": númerodata da casa do coprodutorpagamento,
  "payment_status": "refunded"    | "pending_refund",
  "statepayment_expires_at": estado do coprodutornull,
  "payment_order_code": "codigo do pagamento",
    "payment_type_person": "tipo de pessoa "fisico" ou "juridica"pagamento",
  "payment_installments": 1,
          "zipcode"payment_model": cep"R",
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": " "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 comprador"coprodutor,
   "subscriber_document_number       "complement": "número",
do documento do comprador",   "payment_price": preço,   "payment_datedistrict": databairro do pagamentocoprodutor,
  "payment_status": "canceled",   "payment_expires_at": null,   "payment_orderfantasy_codename": "codigonull,
do pagamento",   "payment_type": "tipo de pagamento",   "payment_installmentsnumber": 1número da casa do coprodutor,
  "payment_model": "R",   "payment_customer_value": 41.71,   "payment_pix_qrcodestate": nullestado do coprodutor,
  "payment_installment_number": 1,        "paymenttype_plans_valueperson": 46.5,tipo de pessoa "fisico" ou "payment_plansjuridica":,
[     {       "planzipcode": "nomecep do plano",coprodutor
      "type": "tipo", }
     "price": preço],
      "price_plus_feesaffiliate": 4[]
    }
  ]
  }}

Chargeback

Info
Informação pendente

Versions Compared

Old Version 2

New Version Current

Key

Compra aprovada

Informações gerais

Lead gerado

Carrinho abandonado

Carrinho abandonado

Boleto gerado

Gerando boleto

PIX gerado

Gerando Pix

Compra aprovada

Compra recusada

Compra recusada

Compra estornada

Compra estornada

Inscrição cancelada

Chargeback

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Compra aprovada

Informações gerais

Lead gerado

Carrinho abandonado

Carrinho abandonado

Boleto gerado

Gerando boleto

PIX gerado

Gerando Pix

Compra aprovada

Compra recusada

Compra recusada

Compra estornada

Compra estornada

Inscrição cancelada

Chargeback