Page History
...
Parameter | Mandatory field | Adopted values | Default value | Description |
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) | |
testMode | Yes | 0 1 | 0 | Mode (0 – operation mode, |
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. |
meanType_Id | No | 1 – VISA | All values sampling by default | Sampling by types of payment means |
operationState | No | N – created, | All values sampling by default | Sampling by operation states. Use upper case only. |
operationType | No | A – payment; | All values sampling by default | Sampling by operation types. Use upper case only. |
startDay | No | dd | By default: minus three hours from the current time at the moment of sampling | Sampling start date (GMT) |
startMonth | No | mm | ||
startYear | No | yyyy | ||
startHour | No | hh | ||
startMin | No | mm | ||
endDay | No | dd | By default: current time at the moment of sampling | Sampling end date (GMT) |
endMonth | No | mm | ||
endYear | No | yyyy | ||
endHour | No | hh | ||
endMin | No | mm | ||
dateTimeMode | No | 0 – by order date; | 0 | Date type - target date for data sampling |
zipFlag | No | "0" – browser | 0 | Format of the results output |
| Note |
|---|
All request parameters are automatically validated. The validation rules are given in the table The validation rules for input parameters . |
Based on the values of the request parameters the replay information is selected and formatted.
For example, only successful payment operations by VISA cards can be received as the request result.
An example of HTTP POST results request returning the information on the completed payment operations by VISA cards in the test mode from 07:00 till 11:00 (GMT) 06.07.2016 in XML format:
| Code Block | ||
|---|---|---|
| ||
<FORM ACTION="https://<SERVER-NAME>/resultbydate/resultbydate.cfm" method="POST"> <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="testMode" VALUE="1"> <INPUT TYPE="hidden" NAME="language" VALUE="EN"> <INPUT TYPE="hidden" NAME="meanType_ID" VALUE="1"> <INPUT TYPE="hidden" NAME="operationState" VALUE="S"> <INPUT TYPE="hidden" NAME="operationType" VALUE="A"> <INPUT TYPE="hidden" NAME="startDay" VALUE="06"> <INPUT TYPE="hidden" NAME="startMonth" VALUE="07"> <INPUT TYPE="hidden" NAME="startYear" VALUE="2016"> <INPUT TYPE="hidden" NAME="startHour" VALUE="07"> <INPUT TYPE="hidden" NAME="startMin" VALUE="00"> <INPUT TYPE="hidden" NAME="endDay" VALUE="06"> <INPUT TYPE="hidden" NAME="endMonth" VALUE="07"> <INPUT TYPE="hidden" NAME="endYear" VALUE="2016"> <INPUT TYPE="hidden" NAME="endHour" VALUE="11"> <INPUT TYPE="hidden" NAME="endMin" VALUE="00"> <INPUT TYPE="hidden" NAME="format" VALUE="3"> <INPUT TYPE="Submit"></FORM> |
List of response parameters:
Parameter | Value |
ordernumber | Order number |
billnumber | Extended format of billnumber |
testmode | Test mode |
ordercomment | Comment |
orderamount | Original amount of order |
ordercurrency | Original currency of order |
amount | Operation amount |
currency | Operation currency |
rate | Currency rate |
lastname | Payer's last name |
firstname | Payer's first name |
middlename | Payer's middle name |
Payer's e-mail | |
clientip | Transactor's IP-address |
ipaddress | Payer's IP-address |
meantype_id | Payment means ID |
meantypename | Type of payment means |
meansubtype | Payment means subtype |
meannumber | Number of payment means |
cardholder | Payment means holder |
issuebank | Name of issue bank |
bankcountry | Country of issue bank |
orderdate | Date of order |
orderstate | Order state |
responsecode | Response code |
message | Message |
customermessage | Result message for a customer |
recommendation | Recommendations |
approvalcode | Authorization code |
protocolname | Protocol |
processingname | Processing |
operationtype | Operation type |
operationdate | Operation date and time (GMT) |
authresult | 3Ds authorization result (Y – success, N - fail, A - Attempt, U – unknown) |
authrequired | The card involvement in 3Ds check result (1 – involved, 0 – not involved, -1 – unknown, null – error appear during involvement check) |
slipno | Financial transaction identifier |
packetdate | Request issue date |
checkvalue | uppercase(md5(uppercase(md5(SALT) + md5(Х)))), where SALT – secret word; Х – result of the following parameters string concatenation: merchant_id, ordernumber, orderamount, ordercurrency, orderstate (without delimiters), + means string concatenation. |
Card expired date |
| Warning |
|---|
Attention! The testmode value of response has to be checked. If the payment was made in test mode ( testmode = 1), then the shipment of goods or providing of services for the current request is not required. |
...