URL for HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfm.
URL for SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm
If the merchant makes use of the THANK YOU from Sberbank Bonus Program and there can be two successful payment operations (by card and by points) in the order, as well as a point accrual operation, we recommend to use the web service https://<SERVER-NAME>/cancel/wscancel.cfm for cancellations. |
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 | |
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 | No* | Number, 15 digits (with '.' delimiter) | Authorization amount | Refund amount |
Currency | No* | 3 characters | Authorization currency code | Cancellation and refund currency code. Only the authorization currency code can be used |
CancelReason | No | 1 – Declined by shop | 1 | 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 |
* The 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.
The parameter billnumber can be passed either in ordinary format (when there was only one successful payment on this order) or in extended format in the confirmation. While using the extended format it is required to provide the exact number of the successful authorization operation (in some cases it can be not a first operation in the order, 5111111000965142.2 for example).
Cancel or refund is successful when the returned response code of cancel operation is AS000 (operation completed successfully), both codes firstcode and secondcode are equal to 0, status of the order is Canceled or PartialCanceled.
Unsuccessful cancel operation has the returned response code set to values AS100-AS998. If a request for a refund or cancel can not be processed then the query will return non-zero values in firstcode and secondcode.
Parameters Amount and Currency should be missed and billnumber (in short/standard format) should be passed for the full amount cancellation of order that were paid by card and by bonus points. The service should be called individually for each payment operation (passing the extended format of billnumber) for the partial amount cancellation of order that were paid by card and by bonus points. For this, the parameter bullnumber of the wscancel call should be provided in extended mode for the corresponding card operation (5111111000965142.1 for example) in one call, and parameter Amount should be set to the necessary amount that should be refunded to the card. In another call the payment by bonus points can be partly canceled. For this, the billnumber should be provided in extended mode for the corresponding bonus points payment operation (5111111000965142.2 for example). Amount should be set to the quantity of points that shoulbe refunded on the customer bonus account. If during the payment some bonus points accruals were done then the related quantity of bonus points canceled automatically (you don't need to the cancel accrual operation of the order). Amount of the bonus points accruals cancellation is calculated automatically for both cancel operations (card, and points refunds) individually. |
Type of transaction (on-line cancellation, refund, financial transaction cancellation, partial cancellation) will be determined by IPS Assist automatically depending on the amount (full or partial cancellation), processing, type of card, availability of a financial transaction for parental authorization, and refund reason.
If enterprise uses cheque in the order payment then only cheque items cancellation is possible. The canceled cheque items should be passed in ChequeItem property. The cheque usage in the orders is described in details in the section Payment With Cheque.
Interface for HTTP POST - format (cancel)
An example of HTTP POST request for the payment cancellation by bankcard:
<FORM ACTION="https://<SERVER-NAME>/cancel/cancel.cfm" method="POST"> <INPUT TYPE="hidden" NAME="BillNumber" VALUE="511111100000001"> <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="amount"> <INPUT TYPE="hidden" NAME="Currency" VALUE="Currency"> <INPUT TYPE="hidden" NAME="ClientIP" VALUE="IP-address"> <INPUT TYPE="hidden" NAME="Language" VALUE="Language of result output"> <INPUT TYPE="hidden" NAME="Format" VALUE="Result output format"> <INPUT TYPE="Submit"></FORM> |