Recurring Payment

post

https://sandbox.meshulam.co.il/api/light/server/1.0/createPaymentProcess

Each business has its own unique identifiers (userId + pageCode) - the identifiers on this documentation are for example only. To integrate with the API, please contact Grow support to obtain the necessary permissions and your unique identifiers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Important note :

You must use the page code for Recurring Payment

All requests must be sent exclusively from your server’s back end. Client-side (browser-based) requests are not supported and will be blocked.

Do not include any special characters in any parameter of the API request.

Body Params

pageCode

string

Required field -Unique identifier refers to payment mathod

userId

string

Required field -Unique identifier refers to every business that is connected and uses Grow payments solutions.

chargeType

integer

optional -
1 - Regular Charge
2 - Suspended Charge

sum

double

Required field -Total amount for payment Example: 10.99.

successUrl

string

Required field - An after payment "Thank you" URL. make sure to use HTTPS and not HTTP. Must use an external URL and not localhost. Example: https://mysite.co.il?success=true

Do not include special characters in this field.

cancelUrl

string

Required field - The page users will be redirected to if a payment is cancelled.

Do not include special characters in this field.

paymentNum

integer

optional- Determine payments number. 2-12

maxPaymentNum

integer

optional -the customer can choose number of payments between 2- to the value that you choose in this parameter.
The payments number must be minimum 2
Determine Restricting the number of payments

description

string

Required field - Description of the product to be charged (will appear in the details of the transaction as well) Example: Payment for a monthly subscription.

Do not include special characters in this field.

pageField[invoiceName]

string

optional - the name for the invoice

pageField[invoiceLicenseNumber]

string

optional - Invoice License Number for invoice

pageField[fullName]

string

Required field - Full name must consist of at least two names.

pageField[phone]

string

Required field - A valid israeli mobile phone numebr Example: 0500000000

pageField[email]

string

optional -A valid email address

cField1

string

optional - Custom field, you may add up to 9 fields.

Do not include special characters in this field.

cField2

string

optional - Custom field, you may add up to 9 fields.

Do not include special characters in this field.

productData[0][catalogNumber]

integer

optional - catalog number for an item in the Invoice

productData[0][quantity]

integer

optional- quantity for an item in the Invoice

productData[0][price]

integer

optional - price for an item in the Invoice

productData[0][itemDescription]

string

optional - item description for an item in the Invoice

notifyUrl

string

optional

Do not include special characters in this field.

invoiceNotifyUrl

string

optional - Url for invoice

Do not include special characters in this field.

Response

Important note :

200Successful response