API Reference

Generate Payment Link

post
https://restapi.payplus.co.il/api/v1.0/PaymentPages/generateLink

The PaymentPages/GenerateLink endpoint allows you to generate a payment link for processing transactions. You can configure options like charge methods, amount, and success/failure callbacks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to 7a0bc4d4-f35f-4301-a945-926378a2416d

UID of the Payment Page

integer
enum
Defaults to 1

0 - Check (J2) 1 - Charge (J4) 2 - Approval (J5) 3 - Recurring Payments 4 - Refund (J4) 5 - Token (J2)

  • If not set, default value - what is set in the payment page settings.
Allowed:
string
enum
Defaults to nullable

Options: credit-card, bit, multipass, paypal, praxell, valuecard, verifone. If your payment page includes multiple options, you can select which tab will be opened by default when the user lands on the payment page.

Allowed:
boolean
Defaults to false

If you have multiple payment methods in your page with this option you will be able to hide other payment methods and manage the selection in your website

string
Defaults to he

(Transfer the language code that displayed in your page, by default will take the general setting of the page)

number
required

Amount of the page

integer
Defaults to 0

Minimum amount of required payment for Credit Card transactions (Apple Pay, Google Pay, Bit, PayPal)

string
required
Defaults to ILS

Currency of the page

boolean
required
Defaults to true

Send email for successful transaction

boolean
required
Defaults to false

Send email for failed transaction

string
Defaults to 30

number, minutes until page expired (if sent we will use it instead of payment page settings)

string
Defaults to https://www.domain.com/success/

nullable (if sent we will use it instead of payment page settings)

string
Defaults to https://www.domain.com/failure/

nullable (if sent we will use it instead of payment page settings)

string
Defaults to https://www.domain.com/cancel/

nullable (if sent we show "Return To Site" and linked to the url provided instead of payment page settings)

string
Defaults to https://www.domain.com/callback/

nullable (if sent we will use it instead of payment page settings)

boolean
Defaults to false

(In case you would like to receive the callback also in failure transaction)

string
Defaults to Customer Name

nullable (In case you have integrated invoice company you can decide if the invoice customer name will be different then the "customer_name" parameter in customer object)

boolean
Defaults to false

nullable (In case you have tokenization permission, you can decide if you would like to return the token of the customer for future charges)

boolean
Defaults to true

nullable (In case you have invoice company and it's activated in your payment page, you can decide if for spesfic transaction invoice will be initial or not, to use default please don't send this parameter at all)

boolean
Defaults to false

nullable (In this field you can send the language of the invoice you would like us to send to your invoice company. In case this field will not be sent, language will be default setting)

boolean
Defaults to true

nullable (In case you would like that tax document will be include VAT or not included VAT, This parameter is not required)

boolean
Defaults to false

nullable (Option to hide payments field for foreign transactions that acquires are not supported)

integer
Defaults to 5

nullable (if sent this will be the amount of installments for the payment)

boolean
Defaults to false

nullable (Option to make credit transaction, number of payments will be minimum 3 and maximum based on payments value)

integer
Defaults to 1

nullable (if sent then the number of the payments will be as selected in the payment page)

integer
Defaults to 5

nullable (Works only if sending "payments_selected" and payplus will calculated other installments. First installment amount can be changed due to other payments)

boolean
Defaults to false

nullable (Option to hide identification id field for foreign transactions)

boolean
Defaults to false

If SMS package purchased the system will notify your customer by SMS

boolean
Defaults to false

If SMS package purchased the system will notify your customer by SMS

boolean
Defaults to false

In case you would like to control the customer details form

allowed_cards
array of strings
Defaults to mastercard,visa

In case you would like to proceed just specific card brands (ex. ["mastercard","visa"])

allowed_cards
allowed_bins
array of strings

In case you would like to proceed just specific BINs in the specific transaction (6 or 8 digits).

allowed_bins
allowed_charge_methods
array of strings
Defaults to credit-card,google-pay

In case you would like to show specific payment methods options in the payment page (ex. ["credit-card","google-pay"])

allowed_charge_methods
string

nullable (Additional Information)

string

nullable (Additional Information)

string

nullable (Additional Information)

string

nullable (Additional Information)

string

nullable (Additional Information)

string
Defaults to false

nullable (Encrypt using Base64 the customer details object in the redirect back to your website and callback)

string
Defaults to false

nullable (Show general information of the more_info's on the payment page if they sent)

boolean
Defaults to false

nullable (Support track2 in payment pages)

string

In case you would like to close document in invoice+ by payment confirmation.

customer
object
items
array of objects

nullable if send in item "product_uid" we will use this product or send error, if send "name" and not "product_uid" we will create new product with this name. more option to send if ("name" && !product_uid): vat_type, barcode, value,price.last option we will use default product.

items
recurring_settings
object

nullable To use this setting recurring payments should be turn on and charge_method value should be 3

secure3d
object

nullable To use default settings of the customer don't send this object, or if you would like to active or disable for this specific transaction

allowed_issuers
array of strings
allowed_issuers
string
string
Headers
Responses

Updated 11 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago