Create Payment Link

post

http://sandboxapi.grow.link/api/light/server/1.0/CreatePaymentLink

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…

Body Params

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

Message text sent to user.

Required only in case the parameter "sendingMode" is send.

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

Do not include special characters in this field.

customText[thankPageTitle]

string

Optional -Thank you page title

customText[thankPageDescription]

string

Optional -Description to the thank you page

invoiceNotifyUrl

string

optional - Url for invoice

Do not include special characters in this field.

notifyUrl

string

Optional - A fixed server address can be set via GROW

Do not include special characters in this field.

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. -Determine payments number must be minimum 2 Restricting the number of payments. the customer can choose between 2- 12

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

pageFieldSettings[invoiceName][isRequired]

boolean

Optional - specifies whether the customer is required to complete the invoice name field. If set to true (or 1), the field becomes mandatory. If set to false (or 0), the field remains optional.

pageFieldSettings[invoiceLicenseNumber][isRequired]

boolean

Optional - specifies whether the customer is required to complete the invoice name field. If set to true (or 1), the field becomes mandatory. If set to false (or 0), the field remains optional.

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- Specifies the value based on the business VAT status:

if the business is subject to regular VAT setting= 1 if the business is VAT-exempt - VAT setting = 3

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

transactionType[5]

integer

Defaults to 5

specify which payment method to display - Pay Box

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.

backgroundColor

string

Optional - Defines the background color of the payment page.

Format: HEX color code (e.g. #FFFFFF)

You can also configure a default business logo via the business management interface.

buttonColor

string

Optional - Defines the background color of the payment button.

Format: HEX color code (e.g. #0285AC)

You can also configure a default business logo via the business management interface.

paymentButtonText

string

Optional - Sets the text that will appear on the payment button

Validation rules: Up to 20 characters - only letters

You can also configure a default business logo via the business management interface.

Headers

x-api-key

string

Response

200Successful response