Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Mandatory field

Adopted values

Default value

Description

Merchant_ID

Yes

Number


The enterprise identifier in IPS Assist

Login

Yes

8-20 characters


Login in IPS Assist (Latin letters, digits and symbol _)

Password

Yes

8-20 characters


Password in IPS Assist (Latin letters and digits)

OrderNumber

Yes

128 characters


Order number in the merchant payments system

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

OrderComment

No

4000 characters


Comment.

Delay

No

0 – one-stage operation
1 – double-stage operation

0

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

Note
titleAttention!

If you want to use the twodouble-stage payment mechanism, you should first consult with the support service staff (support@assist.ru).

Language

No

RU – Russian,
EN – English

Language of legal entity/enterprise

Language of authorized pages

ClientIP

No

Maximum of 15 digits, 4 delimiters «.»


IP-address of the customer. 

TokenType

No

1 – Apple Pay;
2 – Google Pay;
3 – Samsung Pay;
5 – Assist;
6 - Mir Pay.

1

Payment Token Type Identifier

Note

5 - payment token Assist is used for CIT COF operations

PaymentToken

Yes

JSON


For token types 1-3 and 6 - provider payment token (Apple Pay, Google Pay, Samsung Pay, Mir Pay).

For Assist payment token (token type 5) - {"Token": "<UUID>", "CustomerNumber": "<CustomerNumber>"}

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.

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.

isConvert

No

0 – do not convert to the base currency
1 - do not convert to the base currency if possible
2 – always convert to the base currency

1

Currency conversion indicator

Format

No

4 – SOAP
5 – JSON

5

Results format.

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.

Warning

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 –recurring payment
0 – standard payment

0

Recurring payment indicator

RecurringMinAmount

No/Yes

Number, 15 digits, two digits after the delimiter (delimiter '.')


Minimum payment amount for recurring payments
Mandatory when RecurringIndicator = 1

RecurringMaxAmount

No/Yes

Number, 15 digits, two digits after the delimiter (delimiter '.')


Maximum payment amount for recurring payments
Mandatory when RecurringIndicator = 1

RecurringPeriod

No/Yes

10 digits number


Recurring interval in days
Mandatory when RecurringIndicator = 1

RecurringMaxDate

No/Yes

Date in string representation DD.MM.YYYY


Finish date of recurring payments
Mandatory when RecurringIndicator = 1

Chequeitems

No/Yes1

String in JSON-format


Cheque items according to the document “Payment with cheque”.

GenerateReceipt

No

0 or 1

1

Permission to generate of a fiscal receipt. If the value of parameter is 0, the generation of a fiscal receipt is prohibited for this order.

Tax

No

10 characters

Parameter is determined by the “Default tax rate” option of the merchant and used in the mode without transfer of the cheque items (the entire amount must be paid with one rate).

Tax rate identifier

ReceiptLine

No

128 characters

Parameter is determined by the “Default text of cheque item” option of the merchant and used in the mode without transfer of the cheque items.

Text description of the cheque item, if the cheque has one single item.

FPMode

No

Number

Parameter is determined by the “Default payment method” option of the merchant and used in the mode without transfer of the cheque items.

The payment method.

TaxationSystem

No/Yes2

Number

From the merchant’s or CRE settings

The taxation system.

...