CreatePaymentLink

post https://sandboxapi.grow.link/api/light/server/1.0/CreatePaymentLink

Each business has its own unique identifiers - the identifiers on this documentation are for example only. To develope the API you need to contect Grow's service to get pramission and your own unique identifiers .

📘
Important note :

This call can only get a specific page code - wallet

The x-api-key is a required field.

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

Body Params

apiKey

string

Required only for companies that are working with multiple businesses. company's code

userId

string

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

pageCode

string

Required field - Unique identifier refers for this payment mathod

paymentLinkType

integer

Required field -The link is closed for one payment

isActive

integer

Required field -Link is active = 1

sendingMode

integer

Optional - 1=SMS,2=Mail

messageText

string

Optional -Message text sent to user.

chargeType

integer

Optional -
1 - Regular Charge
2- j4j5

successUrl

string

Optional -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

customText[thankPageTitle]

string

Optional -Thank you page title

customText[thankPageDescription]

string

Optional -Description to the thank you page

notifyUrl

string

Optional - A fixed server address can be set via GROW

title

string

Required field -Page title

paymentTypes[0][type]

string

Required field - payment method - payments

paymentTypes[0][payments][paymentsPaymentNum]

integer

Required field - in case the parameter
paymentTypes[0][payments][paymentsMaxPaymentNum]
is not sent.
Determine payments number. 1-12

paymentTypes[0][payments][paymentsMaxPaymentNum]

string

Required field in case the parameter
paymentTypes[0][payments][paymentsPaymentNum]
is not sent.
the customer can choose numner 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

pageFieldSettings[fullName][value]

string

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

pageFieldSettings[phone][value]

string

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

pageFieldSettings[email][value]

string

optional -A valid email address

products[data][0][catalogNumber]

integer

Optional - catalog number of the product

products[data][0][name]

string

Required field - product name

products[data][0][price]

integer

Required field - product amount

products[data][0][quantity]

integer

Optional - maximum units per product

products[data][0][minQuantity]

integer

Optional - minimum units per product

products[data][0][url]

string

Optional -URL image of the product

products[data][0][vatType]

integer

Required field - vat setting =1

transactionType[0]

integer

specify which payment method to display - Credit Card

transactionType[1]

integer

specify which payment method to display -bit

transactionType[2]

integer

specify which payment method to display -Apple Pay

transactionType[3]

integer

specify which payment method to display - Google Pay

transactionType[4]

integer

specify which payment method to display - bank transfer

cField1

string

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

cField2

string

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

Headers

x-api-key

string

Response

📘Important note :

200Successful response

📘
Important note :