ym88659208ym87991671
Запрос реестра операций | Документация для разработчиков

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

Обновлено 29 ноября 2024
POST
/registry

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

Request

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\+()\*]*$

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

  • ]
  • ]
Loading...
Loading...
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.