Page History
...
Parameter | Mandatory field | Adopted values | Default values | Description |
BillNumber | Yes | 15 or 16 characters | BillNumber of initial order | |
OrderNumber | Yes | 128 characters | New order number for this recurrent payment | |
Merchant_ID | Yes | Number | The enterprise identifier in IPS Assist | |
Login | Yes | 8-20 characters | Login (Latin letters, digits and symbol _) | |
Password | Yes | 8-20 characters | Password (Latin letters and digits) | |
Amount | Yes | Number, 15 digits, two digits after the delimiter (delimiter '.') | Recurring payment amount The value of recurring payment amount should be between the values of the min and max amounts of recurring payments transferred at the primary request for authorization of the initiating payment. | |
Currency | Yes | 3 characters | Recurring payment currency The currency of the recurring payment should be equal to the currency of the initiating one, otherwise the order closes with an error. | |
OrderComment | No | 4000 characters | Comment | |
Language | No | RU EN | EN | Language of the results output |
Format | No | 1 – CSV | 1 | Format of the results output. Passed only for a request in POST format (by default, the response will be returned in CSV format). For other formats, the response is returned in the same format in which the request was made. |
| Note |
|---|
All request parameters are automatically validated. The validation rules are given in the table "The validation rules for input parameters". |
Request example for HTTP POST format:
| Code Block | ||
|---|---|---|
| ||
<FORM ACTION="https://<SERVER-NAME>/recurrent/rp.cfm" METHOD="POST">
<INPUT TYPE="HIDDEN" NAME="BillNumber" VALUE="511111100000001.1">
<INPUT TYPE="HIDDEN" NAME="OrderNumber" VALUE="A1_R1">
<INPUT TYPE="HIDDEN" NAME="Merchant_ID" VALUE="Your Merchant_ID">
<INPUT TYPE="HIDDEN" NAME="Login" VALUE="Your login">
<INPUT TYPE="HIDDEN" NAME="Password" VALUE="Your password">
<INPUT TYPE="HIDDEN" NAME="Amount" VALUE="20">
<INPUT TYPE="HIDDEN" NAME="Currency" VALUE="BYN">
<INPUT TYPE="HIDDEN" NAME="Format" VALUE="3">
<INPUT TYPE="HIDDEN" NAME="Language" VALUE="EN">
<INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Buy">
</FORM> |
The list of response parameters:
Parameter | Value |
billnumber | Unique order number in IPS Assist (extended format) |
ordernumber | Order number |
testmode | Test mode |
ordercomment | Comment |
orderamount | Original amount of order |
ordercurrency | Original currency of order |
firstname | Payer's first name |
lastname | Payer's last name |
middlename | Payer's middle name |
Payer's e-mail | |
orderdate | Date of order (in GMT) |
orderstate | Order status |
packetdate | Request issue date (in GMT) |
signature | The X value without delimiters, signed with IPS Assist private key, encoded in BASE64, where X - billnumber,ordernumber,responsecode,orderamount,ordercurrency,meannumber,approvalcode,orderstate,packetdate |
operationtype | Operation type |
amount | Operation amount |
currency | Operation currency |
ipaddress | Payer's IP-address |
meantype_id | Type of payment means |
meansubtype | Payment means subtype |
meannumber | Number of payment means |
cardholder | Payment means holder |
cardexpirationdate | Card expired date |
issuebank | Name of issue bank |
bankcountry | Country of issue bank |
responsecode | Response code |
rate | Currency rate |
message | Operation result message |
customermessage | Result message for a customer |
recommendation | Recommendation |
approvalcode | Authorization code |
protocolname | Protocol |
processingname | Processing |
Six first and last four digits of the card number are returned as the field <meannumber> value here and after in all Web services; the remaining figures being hidden under * symbol.