List of the authorized request parameters
URL of the authorization request is https://<SERVER-NAME>/pay/order.cfm
The full list of the authorized request parameters is given in table below:
Parameter | Mandatory field | Adopted values | Default value | Description |
Merchant_ID | Yes | Number | The enterprise identifier in IPS Assist | |
OrderNumber | Yes | 128 characters | Order number in the enterprise payments system | |
Delay | No | 0 – one-stage operation 1 – double-stage operation | 0 | Attribute of a bankcard authorization for the double-stage operation |
Language | No | RU – Russian, EN – English | Language of legal entity/enterprise | Language of authorization pages |
OrderComment | No | 4000 characters | Comment | |
OrderAmount | Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Payment amount, in original currency (e.g., 10.34) | |
OrderCurrency | No | 3 characters | Currency of legal entity/enterprise | Code of currency of the OrderAmount. |
Lastname | No | 70 characters | Customer's last name | |
Firstname | No | 70 characters | Customer's first name | |
Middlename | No | 70 characters | Customer's middle name | |
No | 128 characters | Customer's e-mail | ||
Address | No | 256 characters | Customer's address | |
HomePhone | No | 64 characters | Customer's home phone number | |
WorkPhone | No | 20 characters | Customer's work phone number | |
MobilePhone | No | 20 characters | Customer's mobile phone number | |
Fax | No | 20 characters | Customer's fax number | |
Country | No | 3 characters | Customer's country | |
State | No | 3 characters | Customer's region | |
City | No | 70 characters | Customer's city | |
Zip | No | 25 characters | Customer's post zip code | |
URL_RETURN | No | 256 characters | Page URL, to where a customer should return after performing his/her payment in the system (option "Go to the shop page" should be enabled in merchant's settings in Personal account). It is recommended to use HTTPS protocol for secure communication.
| |
URL_RETURN_OK | No | 256 characters | URL_RETURN parameter value, or, if none, return URL parameter after successful authorization, specified in Personal account | Page URL, to where a customer should return after successful performing his/her payment in IPS Assist (option "Go to the shop page" should be enabled in merchant's settings in Personal account). It is recommended to use HTTPS protocol for secure communication. |
URL_RETURN_NO | No | 256 characters | URL_RETURN parameter value, or, if none, return URL specified in Personal account | Page URL, to where a customer should return if the payment is not performed in IPS Assist or payment is still in progress (current payment status "In Progress"), see details. The option "Go to the shop using return URL" should be enabled in merchant's settings in Personal account. It is recommended to use HTTPS protocol for secure communication. |
CardPayment | No | 1 – payment with using bankcard; 0 – without using bankcard | 1 | A customer can perform his/her payment using bankcard, if parameter value 1 has been sent, or the parameter is missing (and bankcard payments are enable for the enterprise). |
ERIPPayment | No | 1 – payment with using ERIP; 0 – without using ERIP | 1 | A customer can perform his/her payment using ERIP, if parameter value 1 has been sent, or the parameter is missing (and ERIP payments are enable for the enterprise). |
MobiconPayment | No | 1 – use Mobicon payment system, 0 – without using Mobicon | 1 | A customer can perform his/her payment using Mobicon payment system, if parameter value 1 has been sent, or the parameter is missing (and Mobicon payments are enable for the enterprise) |
ApplePayPayment | No | 1; 0 | 0 | Payment via ApplePay attribute (=1) |
SamsungPayPayment | No | 1; 0 | 0 | Payment via SamsungPay attribute (=1) |
Signature | No* | String | The string is joined according the determined rules. Then the MD5 hash is prepared from this string. Hash is signed by private RSA key of the merchant. Key length is 1024. Received bit sequence is a signature. Signature is transferred as BASE64 coded string. Attention! The parameter is necessary in order to protect the transmitted data from the possibility of their substitution by intruders. You should also enable the setting for check value or signature in the Personal account. | |
Checkvalue | No* | String | Request validation code. The string has to be generated as follows: uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х – the string joined according the determined rules. Note. If the merchant uses request validation code without delimiters, please, contact the support team support@assist.ru. Attention! The parameter is necessary in order to protect the transmitted data from the possibility of their substitution by intruders. You should also enable the setting for check value or signature in the Personal account. | |
RecurringIndicator | No | 1 – recurrent payment 0 – nonrecurrent payment | 0 | Recurring payment indicator. |
RecurringMinAmount | No/Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Min amount of recurrent payments. Mandatory if RecurringIndicator = 1 | |
RecurringMaxAmount | No/Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Max Amount of recurrent payments. Mandatory if RecurringIndicator = 1 | |
RecurringPeriod | No/Yes | Number, 3 digits | Frequency of recurrent payments in days. Mandatory if RecurringIndicator = 1 | |
RecurringMaxDate | No/Yes | Date as string in DD.MM.YYYY format | The end date of recurrent payments. Mandatory if RecurringIndicator = 1 |