Request for making a recurrent payment

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

  • string – string;
  • array – data array;
  • object – data object;
  • data – date;
  • boolean – boolean (logical) data type;
  • int. (integer) – integer data type;
  • amount – a numeric data type (amount).

Request parameters:

Parameter Type Mandatory Description Example

merchantUsername

string

Yes

Partner identifier received when registering in RBS.

petrovich

merchantPassword

string

Yes

Partner password received when registering in RBS.

!@QWERTY

transactionNumber

string Yes

A unique transaction number on the partner's side is required to maintain idempotence of transactions.

7654321DS

source

string Yes The data object of the transfer source, for which binding only can be specified.

binding

string Yes Binding identifier. 87414E0F13AB4542AA9D10E81F74A6E3

preAuth

string No

Parameter that defines the necessity of a pre-authorization (putting the amount on hold on the customer's account until its debiting). The following values are available:

  • true – the parameter is enabled, a payment is processed with a pre-authorization (the amount on the customer's account is put on hold until the debiting);
  • false – the parameter is disabled (the amount is debited immediately).

If the parameter is not specified in the request, the debiting occurs immediately; if it is specified, you must send a separate request for completion.

true

amount

object Yes

Data object about the amount of payment.

transactionAmount

amount

Yes

Payment amount in minor currency units (61.00 rubles = 6100).

6100

transactionFee

amount

No

The amount of the commission for payment in minor currency units (1.00 rubles = 100).

200

currency

string Yes Payment currency. 643

loyaltyPointsAmount

amount

No

Amount of «Spasibo» bonuses (in units of bonuses).

59

Request format: 

POST /api/payment/recurrent HTTP/1.1
Host: web.rbsdev.com/sbersafe
Content-Type: application/json
Accept: application/json; version=1.0
Content-Length: <content-lenght>
{
  "merchantUsername":"<merchantUsername>",
  "merchantPassword":"<merchantPassword>",
  "transactionNumber":"<transactionNumber>",
  "source":{
     "binding":"<binding>"
   },
  "preAuth":<true|false>,
  "amount":{
     "transactionAmount":<transactionAmount>,
     "transactionFee":<transactionFee>,
     "currency":"<currency>",
     "loyaltyPointsAmount":"<loyaltyPointsAmount>"
   }
}

Response parameters:

Parameter Type Mandatory Description Example

mdOrder

string Yes

Order number in the payment gateway. Unique within the payment gateway.

906bf262-bd53-4ac7-983c-07127954681b

transactionNumber

string Yes

A unique transaction number on the partner's side is required to maintain idempotence of transactions.

7654321DS

requestId

string Yes

Request identifier.

gbhjnkme-rdcfgv-hbjnkm-7689ui-okp3ew

status

string Yes

Indication of the status of the request processing result

SUCCESS

Response format: 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-lenght>
Cache-Control: no-store
    
{
  "mdOrder":"<mdOrder>",
  "transactionNumber":"<transactionNumber>",
  "requestId":"<requestId>",
  "status": "<status>"
}