Инструменты страницы

Запрос списка проведённых операций

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

  • string – строка;
  • array - массив данных;
  • object - объект данных;
  • data - дата;
  • boolean - булевый (логический) тип данных;
  • int. (integer) - целочисленный тип данных;
  • amount - числовой тип данных (сумма).

Параметры запроса:

Параметр Тип Описание Пример

dateFrom

date

Дата начала периода.

07.09.2017 17:43:57.768

dateTo

date

Дата конца периода.

07.09.2017 17:43:57.768

responseType

string

Тип запрашиваемой информации. Возможные значения:

  • payment - операции оплаты;
  • transfer - операции переводов;
  • vcard - операции выпуска карт;
  • loyalty - операции с баллами «Спасибо»;
  • change - операции изменения.
payment,transfer

local

boolean

Указание на запрос операций в рамках только текущего приложения, возможны следующие значения:

  • true (истина);
  • false (ложь).
true

Формат запроса:

POST /api/transactions/ HTTP/1.1

Host: 3dsec.sberbank.ru/sbersafe

Content-Type: application/json

Authorization: <accessToken>

Accept: application/json; version=1.0

Content-Length: <content-lenght>

 

{

  "dateFrom":"<dateFrom>",

  "dateTo":"<dateTo>",

  "responseType":"<responseType>",

  "local":<true|false>

}

Параметры ответа:

Параметр Тип Описание Пример

transactions

array

Массив данных о проведённых операциях.

mdOrder

string

Номер заказа в платёжном шлюзе. Уникален в пределах платёжного шлюза.

C2BC84C12AD6438DAA0D87517C7AE187

transactionNumber

string

Уникальный номер транзакции на стороне партнёра, необходим для поддержания идемпотентности транзакций.

7654321DS

transactionDate

date

Дата проведения транзакции.

07.09.2017 17:43:57.768

transactionType

string

Тип транзакции, возможны следующие значения:

  • PURCHASE;
  • TRANSFER.
PURCHASE

transactionWay

string

Способ оплаты.

Apple Pay

amount

object

Объект данных о сумме оплаты.

transactionAmount

amount

Сумма оплаты в минорных единицах валюты (61.00 рублей = 6100).

6100

currency

string Валюта оплаты. 643

partner

object

Объект данных о месте совершения операции.

merchantLogin

string

Идентификатор партнёра, полученный при регистрации в платёжном шлюзе.

spasibo_mp

merchantInfo

string

Человекочитаемое описание партнёра инициатора операции.

Мобильное приложение «Спасибо»

requestId

string

Идентификатор запроса

gbhjnkme-rdcfgv-hbjnkm-7689ui-okp3ew

status

string

Указание на статус результата обработки запроса

SUCCESS

Формат ответа:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-lenght>
Cache-Control: no-store
 
{
  "transactions": [
      {
        "mdOrder": "<uuid>",
        "transactionNumber": "<transactionNumber>",
        "transactionDate":"<transactionDate>",
        "transactionType":"<transactionType>",
        "transactionWay":"<transactionWay>",
        "amount":{
           "transactionAmount":"<transactionAmount>",
           "currency":"<currency>"
           }
        "partner":{
           "merchantLogin":"<merchantLogin>",
           "merchantInfo":"<merchantInfo>"
           }
      },
      {
        "mdOrder": "<uuid>",
        "transactionNumber": "<transactionNumber>",
        "transactionDate":"<transactionDate>",
        "transactionType":"<transactionType>",
        "transactionWay":"<transactionWay>",
        "amount":{
           "transactionAmount":"<transactionAmount>",
           "currency":"<currency>"
           }
        "partner":{
           "merchantLogin":"<merchantLogin>",
           "merchantInfo":"<merchantInfo>"
           }
      }
   ],
  "requestId":"<requestId>",
  "status": "<status>"
}