Guides

Overview

Achieve Effortless Updates and Management

Suggest Edits

At Grow, we believe in providing automated solutions for a seamless transaction experience. Our Webhooks service allows you to receive real-time updates on transactions and manage various aspects of your business.

📘

how you can set up Webhooks for different scenarios ?

Contact our support team to enable Webhooks for your account.

Options for Webhooks:
Choose from the following options or a combination :

  1. All transactions.
  2. Static payment pages only.
  3. Specific static payment pages.
  4. WordPress plugin only.
  5. Recurring payment (from the second payments) .
  6. Failure recurring payments.
  7. Pos device.
  8. Invoices .
  9. Grow application .

Examples

Webhook for Invoice (for VAT invoice/receipt and for automatically generated invoices only).

{
  "transactionCode":"ABCD1234",	 
  "invoiceNumber": "20", 
  "invoiceUrl": "https://secure.meshulam.co.il" 
}

Webhook for recurring payment (from the second payment)

{ 
  "webhookKey":"ABC1234", 
  "transactionCode":"ABCD1234", 
  "transactionType":"אשראי",  
  "paymentSum":8, 
  "paymentsNum":0, 
  "allPaymentNum":1, 
  "firstPaymentSum":0, 
  "periodicalPaymentSum":0, 
  "paymentType":"הוראת קבע", 
  "paymentDate":"14/10/21",
  "asmachta":"123456789", 
  "paymentDesc":"תיאור עסקה",
  "fullName":"Full Name", 
  "payerPhone":"0500000000", 
  "payerEmail":"[email protected]", 
	"cardSuffix":"1234", 
	"cardBrand":"Mastercard", 
	"cardType":"Local", 
	"paymentSource":"ריצת הוראת קבע", 
	"directDebitId":"123456" (קוד הוראת קבע ולא קוד עסקה) 
}

Webhook for failed recurring payment .

{ 
  "regular_payment_id": "55545, (קוד הוראת קבע ולא קוד עסקה)",
  "payer_name": "Full Name", 
  "phone": "0500000000", 
  "email": "[email protected]", 
  "transaction_type": "הוראת קבע", 
	"card_suffix": "4580", 
	"sum": "1", 
	"description": "תיאור עסקה", 
	"business_title": "שם העסק", 
	"error_message": "פג תוקף",  
	"charges_attempts": "6",  
  "webhook_key": "123456ABCD"
}

Payment with API :

Recurring payment via the API :

{ 
  "webhookKey":"ABC1234", 
  "transactionCode":"ABCD1234", 
  "transactionType":"אשראי",  
  "paymentSum":8, 
  "paymentsNum":0, 
  "allPaymentNum":1, 
  "firstPaymentSum":0, 
  "periodicalPaymentSum":0, 
  "paymentType":"הוראת קבע", 
  "paymentDate":"14/10/21",
  "asmachta":"123456789",
  "paymentDesc":"תיאור עסקה" ,
  "fullName":"Full Name", 
  "payerPhone":"0500000000", 
  "payerEmail":"[email protected]", 
  "cardSuffix":"1234", 
  "cardBrand":"Mastercard", 
  "cardType":"Local", 
  "paymentSource":"מערכת חיצונית"
}

Multiple payments via API:

{ 
  "webhookKey":"ABC1234",
  "transactionCode":"ABCD1234", 
  "transactionType":"אשראי",  
  "paymentSum":2.00, 
  "paymentsNum":1, 
  "allPaymentNum":2, 
  "firstPaymentSum":1, 
  "periodicalPaymentSum":1, 
  "paymentType":"תשלומים", 
  "paymentDate":"14/10/21",
  "asmachta":"123456789", 
  "paymentDesc":"Description",
  "fullName":"Full Name", 
  "payerPhone":"0500000000", 
  "payerEmail":"[email protected]", 
  "cardSuffix":"1234", 
  "cardBrand":"Mastercard", 
  "cardType":"Local", 
  "paymentSource":"מערכת חיצונית"
}

Regular payment via API:

{ 
  "webhookKey":"ABC1234", 
  "transactionCode":"ABCD1234", 
  "transactionType":"אשראי",  
  "paymentSum":2.00, 
  "paymentsNum":1, 
  "allPaymentNum":2, 
  "firstPaymentSum":1, 
  "periodicalPaymentSum":1, 
  "paymentType":"רגיל", 
  "paymentDate":"14/10/21",
  "asmachta":"123456789", 
  "paymentDesc":"Description",
  "fullName":"Full Name", 
  "payerPhone":"0500000000", 
  "payerEmail":"[email protected]", 
  "cardSuffix":"1234", 
  "cardBrand":"Mastercard", 
  "cardType":"Local", 
  "paymentSource":"מערכת חיצונית"
}

Payment on Business management interface:

Regular payment from business management interface

{
"webhookKey":"ABC1234",
"transactionCode":"ABCD1234",
"transactionType":"אשראי", 
"paymentSum":1.00,
"paymentsNum":0,
"allPaymentNum":1,
"firstPaymentSum":0,
"periodicalPaymentSum":0,
"paymentType":"רגיל",
"paymentDate":"14/10/21"
"asmachta":"123456789",
"paymentDesc":"Description"
"fullName":"Full Name",
"payerPhone":"0500000000",
"payerEmail":"[email protected]",
"cardSuffix":"1234",
"cardBrand":"Mastercard",
"cardType":"Local",
"paymentSource":"אתר עסקי",
}

Multiple payments from business management interface:

{
"webhookKey":"ABC1234",
"transactionCode":"ABCD1234",
"transactionType":"אשראי", 
"paymentSum":2.00,
"paymentsNum":1,
"allPaymentNum":2,
"firstPaymentSum":1,
"periodicalPaymentSum":1,
"paymentType":"תשלומים",
"paymentDate":"14/10/21",
"asmachta":"123456789",
"paymentDesc":"Description",
"fullName":"Full Name",
"payerPhone":"0500000000",
"payerEmail":"[email protected]",
"cardSuffix":"1234",
"cardBrand":"Mastercard",
"cardType":"Local",
"paymentSource":"אתר עסקי",
}

Recurring payment with business management interface :

{
"webhookKey":"ABC1234",
"transactionCode":"ABCD1234",
"transactionType":"אשראי", 
"paymentSum":1.00,
"paymentsNum":0,
"allPaymentNum":1,
"firstPaymentSum":0,
"periodicalPaymentSum":0,
"paymentType":"הוראת קבע",
"paymentDate":"14/10/21",
"asmachta":"123456789",
"paymentDesc":"Description",
"fullName":"Full Name",
"payerPhone":"0500000000",
"payerEmail":"[email protected]",
"cardSuffix":"1234",
"cardBrand":"Mastercard",
"cardType":"Local",
"paymentSource":"אתר עסקי",
}

Payment with static payment pages :

Recurring payment from static payment pages :

{
"webhookKey":"ABC1234",
"transactionCode":"ABCD1234",
"transactionType":"אשראי", 
"paymentSum":8,
"paymentsNum":0,
"allPaymentNum":1,
"firstPaymentSum":0,
"periodicalPaymentSum":0,
"paymentType":"הוראת קבע",
"paymentDate":"14/10/21",
"asmachta":"123456789",
"paymentDesc":"שם העמוד",
"fullName":"Full Name",
"payerPhone":"0500000000",
"payerEmail":"[email protected]",
"cardSuffix":"1234",
"cardBrand":"Mastercard",
"cardType":"Local",
"paymentSource":"עמוד מכירה",
"purchasePageKey":"ABCD1234",
"purchasePageTitle":"עמוד תבנית תשלום מהיר",
"amount":1,
"purchaseCustomField":{"field1":"נתון1","field2":"נתון2","field3":"נתון3"}
}

Regular payment from static payment pages:


{
"webhookKey":"ABC1234",
"transactionCode":"ABCD1234",
"transactionType":"אשראי", 
"paymentSum":5,
"paymentsNum":0,
"allPaymentNum":1,
"firstPaymentSum":0,
"periodicalPaymentSum":0,
"paymentType": "רגיל",
"paymentDate": "28/3/22",
"asmachta": "123456789",
"paymentDesc":"תיאור עסקה",
"fullName":"Full Name",
"payerPhone":"0500000000",
"payerEmail":"[email protected]",
"cardSuffix": "0000",
"cardBrand": "Visa",
"cardType": "Local",
"paymentSource": "עמוד מכירה עסקי",

"purchasePageKey":"ABC1234",
"purchasePageTitle": "ספר",
"amount": " 1 ",
"purchaseCustomField": {
            "city": "abc",
            "street": "abc",
            "state": "gg"
   }
}
}

Achieve automation excellence with Grow's Webhooks, enhancing your control and management capabilities.

Updated 6 months ago