Payment Page invocation parameters
This section lists all the parameters that can be used in requests for opening Payment Page. Each parameter record contains parameter name, type, and description as well as the information whether the parameter is required.
There are three sorts of parameters depending on whether they required in the requests:
- strictly required—parameter is always required
- optional—parameter is optional
- required conditionally—parameter is required depending on the situation. See the parameter description for details.
| Parameter | Description |
|---|---|
|
account_token |
The token of the bank card that will be used to perform a payment. In this case, on the generated payment page the bank card is preselected with the bank card details filled in. Restriction: Available in the Purchase and Card Verify modes.
For details, see Payments by using tokens |
addendum_data |
This parameter contains all the booking itinerary data such as booking number, check-in and check-out dates, and hotel guest name and is applicable only to payments in travel industry. The value of this parameter is obtained by converting addendum data into a single string by using the Base64 algorithm. For more information on how to calculate the addendum_data value, see Addendum with itinerary data in Payment Page |
|
baseUrl |
Basic Payment Page address. Required if the basic Payment Page domain differs from the libraries domain (by default https://paymentpage.rocketpay.kz). |
|
best_before |
Date and time when the payment period expires. After the payment expiration date the customer is redirected to a page with the message that the time of possibility to proceed the payment is expired. Parameter is passed in the following format: YYYY-MM-DDThh:mm:ss±hh:mm.Example: |
billing_address |
Street of the customer billing address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
billing_city |
City of the customer billing address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
billing_country |
Country of the customer billing address, in ISO 3166-1 alpha-2 format. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
billing_postal |
Postcode of the customer billing address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
billing_region |
Region or state of the customer billing address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
billing_region_code |
State, province, or region code in the ISO 3166-2 format. Example: If you specify this parameter, you need also to specify and populate the Example: |
card_holder |
Name of the cardholder as specified on the card. When the parameter is passed, the value is displayed and editable on the payment form. Example: |
card_operation_type |
Type of payment performed via payment card. The following options are available:
For more information, see Purchase processing with Payment Page and Authorization hold. Example: |
checkout_script |
This parameter allows you to choose whether to make a payment or to verify card by its token using an encryption script without entering CVV/CVC/CID. For more information, see Card data encryption script. Example: |
close_on_missclick |
This parameter specifies the action of the widget (opened in the modal window) when a customer clicks outside of the widget area. Possible values:
For more information, see Opening checkout page in a modal window. Example: |
css_modal_wrap |
An additional CSS class for a modal window. For more information, see Opening checkout page in a modal window. Example: |
customer_address |
Customer address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_birthplace |
Customer place of birth. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_city |
City of the customer address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_country |
Country of the customer address in ISO 3166-1 alpha-2 format. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_day_of_birth |
Customer date of birth in the DD-MM-YYYY format. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_email |
Customer email. Example: johndoe@example.com |
|
customer_first_name |
Customer first name. Example: |
|
customer_id |
Unique ID of the customer in your project. Example: |
|
customer_last_name |
Customer last name. Example: |
customer_middle_name |
Customer middle name. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_phone |
Customer phone number. Must include the country code and contain from 4 to 24 digits without punctuation or special characters. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_ssn |
The last 4 digits of the social security number in the USA. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_state |
State or region of the customer address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
customer_street |
Street of the customer address. Example: |
customer_zip |
Postcode of the customer address. Contact you account manager at Rocketpay to check whether this parameter is required. Example: |
debt_account |
The recipient's account number for debiting funds from the customer's card in order to repay the debt. Latin letters and numbers are allowed, the maximum length is 10 characters. Example: |
descriptor |
Information which identifies the merchant that performs the operation. The maximum length is 13. It is possible to use letters of the Latin alphabet, digits, and the following symbols: # $ * ( ) - _ = + " ; : ? \ / , . ` ' ^Example: |
force_acs_new_window |
The forced display mode with the ACS page opening in a new window despite the settings in Payment Page
Example: |
force_payment_method_subtype |
The bank card type that is opened to customers by default if force_payment_method=card without an option to select another type. Also applies to the saved cards display. For available options see Supported payment cards.
Example: |
identify_doc_number |
Number of a customer identity document. Example: |
|
identify_doc_type |
Type of a customer identity document, whose number is passed in the identify_doc_number parameter. Example: |
language_code |
The language in which the payment page will be opened to the customer in ISO 639-1 alpha-2 format. By default, it is determined by the customer IP address. Example: |
|
merchant_callback_url |
Use this parameter to specify the URL to which the payment platform will send callbacks related to the payment specified in the request. Example:
http://example.com/callback |
|
merchant_success_callback_url |
The URL which the payment platform will use to send the final callback to you if the payment is successfully completed. |
|
merchant_decline_callback_url |
The URL which the payment platform will use to send the final callback to you if the payment is declined. |
merchant_data |
The parameter for specifying extended information about the purchase in progress (for example, details of the services provided). Data can be passed in any form, for instance, as a JSON object encoded using the Base64 scheme. |
merchant_fail_enabled |
The parameter responsible for the possibility of returning customers to the project after a failed payment. For more information, see Options for returning customers to project after payment. Example: |
merchant_fail_redirect_mode |
Mode for opening the project page to which a customer is returned after a failed payment. For more information, see Options for returning customers to project after payment. Example: |
merchant_fail_url |
The project page URL to which a customer is returned after a failed payment by clicking on the return button. For more information, see Options for returning customers to project after payment. Example: |
merchant_return_enabled |
The parameter responsible for the possibility of returning customers to the project at any payment step by clicking on the return button. For more information, see Options for returning customers to project after payment. Example: |
merchant_return_redirect_mode |
Mode for opening the project page to which a customer is returned at any payment step by clicking on the return button. For more information, see Options for returning customers to project after payment. Example: |
merchant_return_url |
The project page URL to which a customer is returned at any payment step by clicking on the return button. For more information, see Options for returning customers to project after payment. Example: |
merchant_success_enabled |
The parameter responsible for the possibility of returning customers to the project after a succeeded payment. For more information, see Options for returning customers to project after payment. Example: |
merchant_success_redirect_mode |
Mode for opening the project page to which a customer is returned after a succeeded payment. For more information, see Options for returning customers to project after payment. Example: |
merchant_success_url |
The project page URL to which a customer is returned after a successful payment by clicking on the return button. For more information, see Options for returning customers to project after payment. Example: |
|
mode |
Payment Page mode. Possible values:
Example: |
|
payment_amount |
Payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes. In Purchase and Card Tokenize mode, some restrictions apply to the value of this parameter:
In the Card Verify mode, the only acceptable value is Example: |
|
payment_currency |
Payment currency in ISO 4217 alpha-3 format. Example: |
|
payment_description |
Payment description. Note: This parameter is optional, but it is strongly recommended to use it in you requests.
Example: |
payment_extra_param |
The parameter that contains extra payment processing settings. For more information regarding this option, you may apply to your Key Account Manager. |
|
payment_id |
Unique ID of the payment in your project. Example: |
|
project_id |
Unique ID of your project in the Payment Page system. Example: |
receipt_data |
A string containing the coded data to send electronic sales receipt to a customer. The data is collected into a JSON object and encoded into Base64. For more information, see Sending receipts to customer |
recurring |
A string containing coded registration and COF payment parameters. The data is collected into a JSON object and encoded by using URL encoding. The structure of the JSON object is given in API, the scheme recurringinfo. For more information, see COF purchase registration |
recurring_register |
Parameter that indicates whether this payment should be registered as recurring. Example: |
redirect |
A parameter that enables opening of the generated payment page in a separate tab. The following options are available:
For more information, see Opening Payment Page in a separate browser tab. Example: |
redirect_fail_mode |
The mode for customer redirection when the payment failed. The following options are available:
Example: |
|
redirect_fail_url |
The URL of the page in your project to which the customer is redirected when the payment failed. Redirection occurs automatically without additional actions from customers. If the blank_page mode is used, the page with the result is displayed on a separate tab, in other modes – is not displayed. Example: |
|
redirect_on_mobile |
This parameter allows you to open the payment page in a separate tab on mobile devices only. Possible values:
For more information, see Opening Payment Page by using a Command. Example: |
redirect_success_mode |
The mode for customer redirection after a successful payment. Possible values:
Example: |
redirect_success_url |
The URL of the page in your project to which the customer is redirected after a successful payment. Redirection occurs automatically without additional actions from customers. If the blank_page mode is used, the page with the result is displayed on a separate tab, in other modes – is not displayed. Example: |
redirect_return_url |
The URL of the page in your project to which the customer is redirected from payment page on external provider site at any step before the payment is completed by clicking the return button. For more information about this functionality, refer to the Rocketpay Key Account Manager. Example: |
redirect_tokenize_mode |
The mode for customer redirection once a token is generated in the Card Tokenize mode The following options are available:
Example: |
redirect_tokenize_url |
The URL of the page in your project to which the customer is redirected after a successful token generation in the Card Tokenize mode |
region_code |
The customer country in ISO 3166-1 alpha-2 format. By default the region is determined by the IP address of the customer. Example: |
signature |
The signature to be passed in the request to open the payment page. For more information, see Signature generation and verification. |
target_element |
The element in which the iframe of the payment page is embedded in the web page of your project. For more information, see Opening Payment Page embedded in a web page. Example: |
terminal_id |
Unique ID of the Payment Page template which you want to run despite the regional and A/B test settings. Example: |