Request for order payment refund

The method used for making a refund is autoRefund.do. The request contains the total amount of the refund, consisting of the amount in money and the amount of points.

In case of full refund, the funds and bonus points are refunded in the same amounts as in payment. In case of a partial refund, the amounts are distributed according to the proportion of money and points upon payment.

The request will end with an error if the funds have not been debited for this order. Multiple refunds are available, but not exceeding the initial amount debited.

This operation can be performed provided that the merchant has the corresponding permissions in the system.

In this document, the following data type conventions are used when describing request and response parameters:

  • A<n> – a sequence of Latin letters of length <n>;
  • A..<n> – a sequence of Latin letters with a length not exceeding <n>;
  • N<n> – a sequence of digits of length <n>;
  • N..<n> – a sequence of digits with a length not exceeding <n>;
  • AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
  • AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
  • ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
  • ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
  • UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.

Request parameters:

Name Type Mandatory Description

userName

AN..30

Yes Login issued to the Store upon integration with the Payment Gateway.

password

AN..30

Yes Password issued to the Store upon integration with the Payment Gateway.

orderId

ANS36

Yes

Identifier of the order in the payment system. It is unique within the system. Missing if order registration failed due to an error detailed in ErrorCode.

compositeRefundAmount

N..20

Yes

Refund amount, consisting of the amount in money and the amount of points. The amount can be equal to or less than the order remaining amount.

language

A2

Yes

Language in the ISO 639-1 encoding. If the language is not specified, the default language defined in the store settings is used.

Response parameters:

Name Type Mandatory Description

errorCode

ANS..3

No

Error code.

.

errorMessage

AN..512

No

Error description in the language passed in the language parameter in the request.

.

operations block

pcId

AN..512

No

Loyalty processing transaction identifier.

.

operation

AN..512

Yes

Operation type, the following values are possible:

  • PAYMENT;
  • AWARD;
  • REVERSE;
  • REFUND_PAYMENT;
  • REFUND_AWARD.

.

transactionId

AN..512

No

The identifier of the transaction in the payment gateway.

.

amount

N..12

No Amount in points.

successful

AN..512

Yes

A feature of the success of the operation, the following values are possible:

  • true (successful);
  • false (unsuccessful).

.

Request example: 

https://3dsec.sberbank.ru/payment/rest/autoRefund.do?userName=login&password=password&orderId=62945d2e-3da5-42cf-b9c1-d456227ab51a&compositeRefundAmount=100000

Response example: 

{"operations":[{"pcId":2699144,"operation":"REFUND_PAYMENT","amount":1960,"successful":true,"transactionId":"1652"}, 
 {"pcId":2699145,"operation":"REFUND_AWARD","amount":98040,"successful":true,"transactionId":"1653"}],"errorCode":"0"}