Sign in

v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Payment Pages

Generate Payment Link

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.

post/PaymentPages/generateLink

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

payment_page_uidstring required

UID of the Payment Page

charge_method0 | 1 | 2 | 3 | 4 | 5

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.
charge_default'credit-card' | 'bit' | 'multipass' | 'paypal'

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.

hide_other_charge_methodsboolean

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

language_codestring

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

amountnumber required

Amount of the page

non_voucher_minimum_amountinteger

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

currency_codestring required

Currency of the page

sendEmailApprovalboolean required

Send email for successful transaction

sendEmailFailureboolean required

Send email for failed transaction

expiry_datetimestring

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

refURL_successstring

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

refURL_failurestring

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

refURL_cancelstring

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

refURL_callbackstring

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

send_failure_callbackboolean

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

custom_invoice_namestring

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)

create_tokenboolean

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

initial_invoiceboolean

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)

invoice_languageboolean

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)

paying_vatboolean

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

hide_payments_fieldboolean

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

paymentsinteger

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

payments_creditboolean

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

payments_selectedinteger

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

payments_first_amountinteger

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

hide_identification_idboolean

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

send_customer_success_smsboolean

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

customer_failure_smsboolean

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

add_user_informationboolean

In case you would like to control the customer details form

allowed_cardsstring[]

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

allowed_binsstring[]

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

allowed_charge_methodsstring[]

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

more_infostring

nullable (Additional Information)

more_info_2string

nullable (Additional Information)

more_info_3string

nullable (Additional Information)

more_info_4string

nullable (Additional Information)

more_info_5string

nullable (Additional Information)

create_hashstring

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

show_more_infostring

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

support_track2boolean

nullable (Support track2 in payment pages)

close_docstring

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

allowed_issuersstring[]
invoice_integration_uidstring
cashier_uidstring

Example request

{
  "cashier_uid": "9c7d3766-3cce-46a2-8ca3-a50240c35ba2"
}

Response

200

Example response

{
  "results": {
    "status": "success",
    "description": "payment page link is been generated"
  },
  "data": {
    "page_request_uid": "f33f7a1f-5ea7-4857-992a-2da95b369f53",
    "payment_page_link": "https://paymentsdev.payplus.co.il/f33f7a1f-5ea7-4857-992a-2da95b369f53",
    "qr_code_image": "https://restapidev.payplus.co.il/api/payment-pages/payment-request/f33f7a1f-5ea7-4857-992a-2da95b369f53/qr-code"
  }
}