Запрос реестра операций

Обновлено 27 августа 2025

Партнер запрашивает реестр заказов с детализацией по операциям за указанный период.

Запрос

Header Parameters

RqUID

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Body

required

rqUid

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

rqTm

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

ДатаВремя формирования запроса

idQR

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]{1,36}$

IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ

startPeriod

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

Дата/время начала периода: дата создания заказа в АС Банка (ППРБ Ecom) по Мск.

endPeriod

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

Дата/время конца периода: дата создания заказа в АС Банка (ППРБ Ecom) по Мск.

registryType

string

required

Возможные значения: <= 20 characters, [QUANTITY, REGISTRY]

Тип реестра. Возможные значения: QUANTITY/REGISTRY. Где QUANTITY – агрегация по количеству операций, сумме. REGISTRY - детальный отчет по заказам

Ответы

200 OK

Schema

rqUid

string

required

Возможные значения: <= 32 characters, Value must match regular expression ^[0-9a-fA-F]{32}$

Уникальный идентификатор запроса

rqTm

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

ДатаВремя формирования запроса

tid

string

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

Уникальный идентификатор терминала

idQR

string

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]*$

IdQR устройства или tid Уникальный идентификатор терминала для СБП, на котором сформирован заказ

quantityData

object

Заполняется в случае, если в запросе RegistryType = QUANTITY

totalCount

integer

required

Возможные значения: >= 0 и <= 9999999999

Общее кол-во успешных операций

totalPaymentAmount

integer

required

Возможные значения: >= 0 и <= 999999999999999

Общая сумма покупок: сумма покупок (только успешные).

totalRefundAmount

integer

required

Возможные значения: >= 0 и <= 999999999999999

ID заказа в АС ППРБ.Карты (Сбербанк)

totalAmount

integer

required

Возможные значения: >= 0 и <= 999999999999999

Общая сумма покупок: сумма покупок за вычетом суммы возвратов и отмен (только успешные)

errorCode

string

required

Возможные значения: <= 6 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Код выполнения запроса

errorDescription

string

Возможные значения: <= 1024 characters, Value must match regular expression ^.*$

Описание ошибки выполнения запроса

registryData

object

Заполняется в случае, если в запросе RegistryType = REGISTRY

orderParams

object

Блок с перечнем заказов

orderParam

object[]

Possible values: <= 1000

Перечень заказов

Array [

orderId

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

ID заказа в АС ППРБ.Карты

partnerOrderNumber

string

required

Возможные значения: <= 36 characters, Value must match regular expression ^.*$

Номер заказа в АС Партнера

amount

integer

required

Возможные значения: >= 0 и <= 15 characters, <= 999999999999999

Сумма заказа в минимальных единицах Валюты

currency

string

required

Возможные значения: <= 3 characters, Value must match regular expression ^[0-9]{3}$

Валюта заказа, цифровой код по ISO 4217

orderCreateDate

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

ДатаВремя формирования заказа

orderState

string

required

Возможные значения: <= 20 characters, [PAID, CREATED, REVERSED, REFUNDED, REVOKED, DECLINED, CONFIRMED, ON_PAYMENT]

Статус заказа

orderOperationParams

object

Блок с перечнем операций, привязанных к данному заказу с детализацией по каждой операции

orderOperationParam

object[]

Possible values: <= 1000

Параметры операции. Отдаем информацию только по успешным операциям.

Array [

operationId

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Идентификатор операции в АС Банка(ППРБ Ecom)

operationDateTime

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$

ДатаВремя совершения операции

rrn

string

required

Возможные значения: <= 12 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

RRN операции

operationType

string

required

Возможные значения: <= 36 characters, [PAY, REVERSE, REFUND, SBP_PAY_ACKNOWL, SBP_ACK_ONUS, SBP_STATUS_OUT, SBP_CREDIT_IN_RQ, SBP_REFUND_IN_RQ]

Тип операции: PAY, REFUND, REVERSAL

operationSum

integer

required

Возможные значения: >= 0 и <= 15 characters, <= 999999999999999

Сумма операции в минимальных единицах Валюты

operationCurrency

string

required

Возможные значения: <= 3 characters, Value must match regular expression ^[0-9]{3}$

Валюта операции, цифровой код по ISO 4217

authCode

string

required

Возможные значения: <= 8 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Код авторизации

responseCode

string

required

Возможные значения: <= 2 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Код успешности авторизации

responseDesc

string

Возможные значения: <= 256 characters, Value must match regular expression ^.*$

Описание кода ответа

sbpOperationParams

object

Блок с перечнем параметров операции СБП. Передается только для операции оплаты через СБП (добавляется в API v3.0.0)

sbpOperationId

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9_\-\\]+$

Идентификатор операции в СБП

sbpPayerId

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[A-Za-z0-9_\-\s\+()\*]*$

Маскированный идентификатор плательщика

]

]

{
  "rqUid": "ac11cA1CEae1D1111dABf1fD1Bb0acAd",
  "rqTm": "2005-08-15T15:52:01Z",
  "tid": "20163714",
  "idQR": "20163714",
  "quantityData": {
    "totalCount": 1000,
    "totalPaymentAmount": 400000,
    "totalRefundAmount": 20000,
    "totalAmount": 380000
  },
  "errorCode": "000000",
  "errorDescription": "ErrorDescription",
  "registryData": "example"
}

Client Error 400 Bad Request (Запрос не корректен)'

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Client Error 401 Unauthorized (Приложение не авторизовано, либо некорректное значение client-id)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Forbidden

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Not Found

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Method Not Allowed (Ошибка API gateway, не найдены операци и, поддерживающие запрошенную http-команду)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Too Many Requests (Превышен лимит отправляемых запросов)

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Internal Server Error (Внутренняя ошибка сервера

Schema

httpCode

string

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

message

string

Возможные значения: <= 50 characters, Value must match regular expression ^.*$

Описание ошибки

moreInfo

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

Дополнительная информация

path

string

Возможные значения: <= 254 characters, Value must match regular expression ^.*$

вызываемый сервис

{
  "httpCode": "400",
  "message": "Error",
  "moreInfo": "Error",
  "path": "Error"
}

Service Unavailable (Операция не доступна)

Gateway Timeout

Loading...