You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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 merchant payments system

Delay

No

0 – one-stage operation

1 – double-stage operation

0

Attribute of a bankcard authorization for the double-stage operation mode.

Language

No

RU – Russian,

EN – English

Language of legal entity/enterprise

Language of authorized pages

OrderComment

No

256 characters


Comment.

OrderAmount

Yes

Number, 15 digits (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 (For currency codes refer to Table 5.8 of the Annex).

Lastname

No

70 characters


Customer's last name.

Firstname

No

70 characters


Customer's first name.

Middlename

No

70 characters


Customer's middle name.

Email

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 section 2.2. 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 – pay 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)

YMPayment

No

1 – use YandexMoney payment system,

0 – without using YandexMoney

1

A customer can perform his/her payment using YandexMoney payment system, if parameter value 1 has been sent, or the parameter is missing (and YandexMoney payments are enable for the enterprise)

WMPayment

No

1 – use WebMoney payment system,

0 – without using WebMoney

1

A customer can perform his/her payment using WebMoney payment system, if parameter value 1 has been sent, or the parameter is missing (and WebMoney payments are enable for the enterprise)

QIWIPayment

No

1 – use QIWI payment system,

0 – without using QIWI

1

A customer can perform his/her payment using QIWI payment system, if parameter value 1 has been sent, or the parameter is missing (and QIWI payments are enable for the enterprise)

QIWIMtsPayment

No

1; 0

1

Payment with mobile phone money (MTS)

QIWIMegafonPayment

No

1; 0

1

Payment with mobile phone money (Megafon)

QIWIBeelinePayment

No

1; 0

1

Payment with mobile phone money (Beeline)

QIWITele2Payment

No

1; 0

1

Payment with mobile phone money (Tele2)

Signature

No

String


The string is joined from the following order parameters:

Merchant_ID;OrderNumber;OrderAmount;OrderCurrency

with semicolon as delimiter.

Then the MD5 hash prepared from this string. Hash is signed by private RSA key of the merchant. Key length - 1024. Received bit sequence is a signature. Signature is transferred BASE64 coded string.

Checkvalue

No

String


Request validation code. The string has to be generated as follows: uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х – result of the following parameters string concatenation: merchant_id, ordernumber, orderamount, ordercurrency with semicolon as delimiter, + means string concatenation.

Note. If the merchant uses request validation code without delimiters, please, contact the support team support@assist.ru

MobileDevice

No

0 – use merchant's settings;

1 –standard pages;

2 - pages for mobile devices.

0

Payment pages type (standard or for mobile devices). If no values passed for this parameter in the request then default merchant setting is used (standard pages). In order to switch to the device auto detection mode, please, contact the support team support@assist.ru.

RecurringIndicator

No

1 – recurrent payment

0 – nonrecurrent payment

0

Recurring payment indicator

RecurringMinAmount

No/Yes

Number, 15 digits


Min amount of recurrent payments.

Mandatory if RecurringIndicator = 1

RecurringMaxAmount

No/Yes

Number, 15 digits


Max Amount of recurrent payments.

Mandatory if RecurringIndicator = 1

RecurringPeriod

No/Yes

Number, 10 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

GooglePayPayment

No

1; 0

0

Payment via GooglePay attribute (=1)

ApplePayPayment

No

1; 0

0

Payment via ApplePay attribute (=1)

SamsungPayPayment

No

1; 0

0

Payment via SamsungPay attribute (=1)

FastPayPayment

No

1; 0

0

Permission to pay via Faster Payment System (=1)