Web Service Description
URL for HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfm.
URL for SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm, parameters are passed by SOAP request, or in JSON format (swagger description https://docs.belassist.by/swagger/).
List of request parameters:
Parameter | Mandatory field | Adopted values | Default value | Description |
Billnumber | Yes | 15 or 16 digits; extended format | Unique number of payment corresponding to the order number in IPS Assist; extended payment number can be passed only if the cheque is not transferred in the order. | |
Merchant_ID | Yes | Number | The enterprise identifier in IPS Assist | |
Login | Yes | 8-20 character string | Login (Latin letters, digits and symbol _) | |
Password | Yes | 8-20 character string | Password (Latin letters and digits) | |
Amount | No1 | Number, 15 digits, two digits after the delimiter (delimiter '.') | Authorization amount | Refund amount |
Currency | No1 | 3 characters | Authorization currency code | Cancellation and refund currency code. Only the authorization currency code can be used |
CancelReason | No | 1 – Declined by shop | 2 | Reason of cancellation or refund |
Language | No | RU – Russian | RU | Language of the results output |
ClientIP | No | IP-address of the operator performing the cancellation/refund | ||
Format | No | 1 – CSV | Format of input data | Format of the results output. 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. |
Customer | No2 | Data structure | Customer options |
1The parameters Amount and Currency can be available or missing in the request only simultaneously. If the above parameters are missing, the full amount cancelation operation will be performed.
2The parameter is required only for canceling payments by ERIP.
The following customer parameters are passed in the structure:
Parameter | Mandatory field | Adopted values | Description |
bankcode | Yes | int | Suppositive number of the settlement participant assigned to the banks of the national payment system of the Republic of Belarus (beneficiary's bank). |
accountnumber | Yes | string(50) | The number of the personal account of the ERIP system customer (recipient). |
firstname | No | string(29) | The name of the ERIP system customer. |
lastname | No | string(29) | The surname of the ERIP system customer. |
secondname | No | string(29) | The second name of the ERIP system customer. |
All request parameters are automatically validated. The validation rules are given in the table "The validation rules for input parameters".
