Page History
...
Name | Manda- | Accepted values | Default value | Description | ||||
Merchant_ID | Yes | Number | Merchant identification number in IPS Assist | |||||
Login | Yes | String | Service Login | |||||
Password | Yes | String | Password | |||||
OrderNumber | Yes/No | 128 symbols | Order number (order identification on the merchant side) | |||||
OrderAmount | Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Payment amount (ex.: 10.34) | |||||
OrderCurrency | No | 3 symbols | Default currency of enterprise or merchant | Order currency code (for OrderAmount value) Ex.: RUB, USD, EUR and so on. | ||||
OrderComment | No | 4000 symbols | Order comment | |||||
Delay | No | 0 – one stage payment, | 0 | Flag for selection of one or two payment stages | ||||
Language | No | RU – Russian | Enterprise or merchant language | Language of payment pages | ||||
ClientIP | No/Yes | IP-address of customer. The parameter is mandatory for the 3-D Secure protocol version 2. | ||||||
Cardtype | No | 1 – VISA | Card type | |||||
Cardnumber | Yes | Card number | ||||||
Cardholder | No* | 70 letters (no digits). Space as delimiter | Card-holder | |||||
Expiremonth | Yes | 1-12 | Card expiration month | |||||
Expireyear | Yes | Year in YYYY format | Card expiration year | |||||
Cvc2 | Yes | CVC2 code | ||||||
Lastname | No* | 70 letters (no digits) | Customer second name | |||||
Firstname | No* | 70 letters (no digits) | Customer first name | |||||
Middlename | No | 70 letters (no digits) | Customer middle name | |||||
No* | 128 symbols | E-mail of customer | ||||||
Address | No | 256 symbols | Customer address | |||||
HomePhone | No | 64 symbols | Customer home phone | |||||
WorkPhone | No | 20 symbols | Customer work phone | |||||
MobilePhone | No | 20 symbols | Customer mobile phone | |||||
Fax | No | 20 symbols | Customer fax number | |||||
Country | No | 3 symbols | Customer's country code | |||||
State | No | 3 symbols | Customer's region code | |||||
City | No | 70 symbols | Customer's city | |||||
Zip | No | 25 symbols | Customer's postal index | |||||
isConvert | No | 0 – don't convert to the base currency | 1 | Currency conversion indicator | ||||
Format | No | 1 – CSV | 1 | Results format. If the request is sent in SOAP format, then the response will also be in SOAP, in other cases in accordance with the passed format value. | ||||
Signature | No | String | The string is joined according to determined rules. 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.
| |||||
RecurringIndicator | No | 1 –recurring 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 | 3 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 | |||||
CustomerNumber | No | 32 symbols | Merchant's internal customer identification | |||||
SaveCard | No | 1 - the card is stored to this customer number; | 0 | This parameter permits to store the card to this client number for subsequent payments, if the current payment is successful. If this card for this client number already has been saved before, the parameter is ignored. | ||||
| Disable3DS | No | 0 - perform 3D-Secure authorization according to the merchant settings; 1 - fulfill payment without 3-D Secure. | 0 | Flag of disabling 3-D Secure.
| ||||
| Type | No | cardpayment – customer pays by card; | cardpayment | Type of payment chosen by the customer when paying for the order (by card or via Faster Payments System). | ||||
| Account | No | 30 symbols | Recipient ID (paid phone number) |
...
- If there is the issuing bank URL threeDSMethodURL (unit 7), the merchant generates hidden HTML iFrame on the payment page (unit 9) and sends a POST request with one parameter threeDSMethodData to the received address threeDSMethodURL, and then calls the get3dsecver2 service (unit 10).
- If there is the issuing bank URL threeDSMethodURL (units 7, 9, 10), without the additional interaction with the card holder (unit 8) - Frictionless Flow (F), IPS Assist immediately executes a transaction in processing or completes the operation with an error. In response to a call to the get3dsecver2 service, the merchant will receive the payment status (unit 6).
- If there is the issuing bank URL threeDSMethodURL (units 7, 9, 10), and the additional interaction with the card holder is necessary (unit 8), the merchant generates hidden HTML iFrame on the payment page and sends an HTTP POST request for the card holder verification to the specified challengeurl URL (unit 11). This iFrame displays the issuer's bank ACS page and the customer enters a one-time password received from the bank. This is the Challenge Flow (C) scenario.
- If there is the issuing bank URL threeDSMethodURL (units 7, 9, 10), the additional interaction with the card holder is necessary (unit 8) and with decoupled authentication, the merchant must keep the order in the In Process state and wait for the final payment status (within the lifetime of the order). This is the Decoupled Authentication (D) scenario.
- If there is not the issuing bank URL threeDSMethodURL and when the additional interaction with the card holder is not required - Frictionless Flow (F), the transaction will be processed immediately and the payment process will be completed (unit 6). The merchant will receive the authentication result and payment status immediately in response to the call to the silentpay service.
- If there is not the issuing bank URL threeDSMethodURL and the additional interaction with the card holder is necessary (unit 8), but with no issuing bank URL threeDSMethodURL, the enterprise should generate an HTML iFrame object on the payment page and send an HTTP POST request for the card holder verification to the specified challengeurl URL (unit 11). This iFrame displays the issuer's bank ACS page and the customer enters a one-time password received from the bank.
- If there is not the issuing bank URL threeDSMethodURL and the additional interaction with the card holder is necessary (unit 8) under the Decoupled Authentication scenario (D), the merchant must keep the order in the In Process state and wait for the final payment status (within the lifetime of the order).
In those work scenarios that require the generation of a hidden HTML iFrame, at step 7 in the threedsdata unit, the merchant will receive the necessary threeDSMethodData and threeDSMethodURL parameters for generating a POST request (unit 9). The result of sending the request can be positive (HTTP code 200), negative (any other HTTP code), or the request sending timeout value will be exceeded (set to 10 seconds). After receiving the HTTP code or the timeout has expired, a request must be sent to the get3dsecver2 service (unit 10) to continue the authentication process.
get3dserver2 – web service of the 3D-Secure authentication continuation
...