If the merchant requires not only the information about the order status (approved, cancelled, payment confirmation in process), but also a detailed information about the operations (payment, payment approval, return or cancellation) executed with regards to this order, the merchant can use Web service to receive the results of the operations under a given order number.
To receive the payment result by order number, send a request to IPS Assist server via HTTP POST, SOAP method (in UTF-8 coding) or in JSON format (swagger description: https://docs.belassist.by/swagger/).
The request URL for receiving the payment result with a list of operations within the order:
https://<SERVER-NAME>/orderresult/orderresult.cfm.
The order search using Web service can be performed only for the specified time period. The default sampling end date is taken to be the current date, while the default sampling start date is the current date, minus three days.
List of request parameters
Parameter | Mandatory field | Adopted values | Default value | Description |
Ordernumber | Yes | String, 128 characters | Order number | |
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) | |
StartYear | No | Year in "2011" format | Minus three days from the current date | Sampling start date (GMT) |
StartMonth | No | 1-12 | Minus three days from the current date | |
StartDay | No | 1-31 | Minus three days from the current date | |
StartHour | No | 0-23 | Minus three days from the current date | |
StartMin | No | 0-59 | Minus three days from the current date | |
EndYear | No | Year in "2011" format | Current year | Sampling end date (GMT) |
EndMonth | No | 1-12 | Current month | |
EndDay | No | 1-31 | Current day | |
EndHour | No | 0-23 | Current hour | |
EndMin | No | 0-59 | Current minute | |
Language | No | RU EN | EN | Language of the results output |
Format | Yes/No | 3 – XML | 3 | Format of the results output. Passed only for a request in POST format (by default, the response will be returned in XML format). For other formats, the response is returned in the same format in which the request was made. |
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:
<FORM ACTION="https://<SERVER-NAME>/orderresult/orderresult.cfm" METHOD="POST"> <INPUT TYPE="HIDDEN" NAME="Ordernumber" VALUE="1001-01"> <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="Startyear" VALUE="2011"> <INPUT TYPE="HIDDEN" NAME="Startmonth" VALUE="04"> <INPUT TYPE="HIDDEN" NAME="Startday" VALUE="01"> <INPUT TYPE="HIDDEN" NAME="Starthour" VALUE="00"> <INPUT TYPE="HIDDEN" NAME="Startmin" VALUE="00"> <INPUT TYPE="HIDDEN" NAME="Endyear" VALUE="2011"> <INPUT TYPE="HIDDEN" NAME="Endmonth" VALUE="04"> <INPUT TYPE="HIDDEN" NAME="Endday" VALUE="02"> <INPUT TYPE="HIDDEN" NAME="Endhour" VALUE="00"> <INPUT TYPE="HIDDEN" NAME="Endmin" VALUE="00"> <INPUT TYPE="HIDDEN" NAME="Format" VALUE="3"> <INPUT TYPE="HIDDEN" NAME="Language" VALUE="EN"> <INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Execute"> </FORM>
List of response parameters:
Parameter | Value |
Order parameters | |
billnumber | Unique order number in IPS Assist |
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 |
orderstate | Order status |
errorcode2 | |
packetdate | Request issue date |
signature | 1) For signature type MD5 - empty; 2) For PGP type – an X value, signed by IPS Assist secret key and converted into BASE64 string. |
checkvalue | 1) For PGP type – empty; 2) For MD5 type – 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. |
Operation parameters | |
billnumber | Extended format of billnumber |
operationtype | Operation type |
operationstate | Operation status |
amount | Operation amount |
currency | Currency of operation |
ipaddress | Payer's IP-address |
clientip | Transactor'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 |
message | Operation result message |
customermessage | Result message for a customer |
recommendation | Recommendation |
approvalcode | Authorization code |
protocolname | Protocol |
processingname | Processing |
operationdate | Operation date and time (GMT) |
authresult | 3Ds authorization result (Y – success, N - fail, A - Attempt, U – unknown, R – rejection, C –not completed for any reason, E - error) |
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 |
errorcode2 | |
externalrefundid1 | External refund ID |
3DSecure parameters | |
version | 3DSecure protocol version |
alphaauthresult | 3Ds authorization result (Y – success, N - fail, A - Attempt, U – unable to authenticate, R – rejection, C –not completed for any reason, E - error, ) |
challenge | Interaction with the cardholder (C – yes, F – no) |
eci | Electronic Commerce Indicator (5 – full authentication, 6 – authentication attempt, 7 – without authentication) |
1The parameter is sent only if it was sent in the cancellation request using the wscancel service and the results output format is JSON or XML.
2To transfer this parameter, please, contact the support service (support@belassist.by).