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

consumerServicePaymentEvent

Обновлено 11 марта 2025
POST
/v1/servicePaymentEvent

consumerServicePaymentEvent

Запрос

Header Parameters

    RqUID
    string

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

    Example: 22224c8b-9102-40ba-bf54-278f84783831
    Authorization
    string

    Токен авторизации

    Example: Bearer adfewreqwrdsfadsfadsfdfasd

Body

required

    paymentOrderId
    string
    required

    Возможные значения: non-empty и <= 32 characters

    Идентификатор заказа продления срока действия подписки

    serviceCatalogType
    string
    required

    Возможные значения: [SBERBANK, ECOSYSTEM]

    Тип каталога услуги

    serviceExternalId
    string
    required

    Возможные значения: non-empty и <= 36 characters

    Внешний идентификатор услуги

    customerId
    uuid
    required

    Идентификатор потребителя

    clientKeyType
    string
    required

    Возможные значения: [SBER_ID, EPC_RB_ID, EPC_CB_ID, ERIB_ID, MDM_ID, DIALOG_ID, MOBILE_PHONE, EMAIL, ESIA_ID, SUB, CRM_ID, CRM_ID_NO_CLIENT]

    Тип внешнего идентификатора клиента

    clientKey
    string
    required

    Возможные значения: non-empty и <= 100 characters

    Внешний идентификатор клиента (Примечание: Допускается конвертация значения данного поля шлюзом интеграции при clientKeyType = SUB)

    packetId
    uuid
    required

    Идентификатор пакета услуг

    isBundle
    boolean

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

    subscriptionId
    uuid
    required

    Идентификатор подписки клиента на пакет услуг

    parentSubscriptionId
    uuid

    Идентификатор корневой подписки клиента владельца на пакет услуг

    paySystemType
    string
    required

    Возможные значения: [INTERNAL, NONE, EPS, RBS, SBER_PAY, PAYQR, GOOGLE_PAY, APPLE_PAY, KSH_KZ, SM_BY, OKKO_ANS, OKKO_SBER, OKKO_UKASSA, OKKO_UCS, OKKO_PSCB, OKKO_RSB, OKKO_SMS, OKKO_WALLET_ONE, ASSIST_RU, ASSIST_BY, ELCOM_D, ELCOM_W, CLC, ECOM, ECOM24, ELCOM_D24]

    Тип платежной системы

    paySystemTransactionId
    string
    required

    Возможные значения: non-empty и <= 36 characters

    Идентификатор транзакции в платежной системе

    paySystemAuthCode
    string

    Возможные значения: non-empty и <= 36 characters

    Код авторизации в платежной системе

    merchantId
    string

    Возможные значения: non-empty и <= 255 characters

    Идентификатор мерчанта (Обязателен для фискализации платежа и должен быть цифровым)

    terminalId
    string

    Возможные значения: non-empty и <= 255 characters

    Идентификатор терминала

    paymentDate
    string
    required

    Дата время платежа

    paymentBegins
    string
    required

    Дата время начала срока оплаченного периода действия пакета услуг

    paymentExpired
    string
    required

    Дата время окончания срока оплаченного периода действия пакета услуг

    amount
    number

    Сумма платежа (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    currency
    string

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

    Валюта платежа (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    isTrial
    boolean

    Признак действия триального периода (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    isSuspend
    boolean

    Признак нахождения подписки в спящем режима (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    isFrozen
    boolean

    Признак нахождения подписки в приостановленном режима (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    isAutomatic
    boolean

    Признак автоматического продления срока действия подписки (значение поля носит ознакомительный характер при исходящих запросах от ФПЭ и игнорируется при входящих в ФПЭ)

    mobilePhoneForFiscal
    string

    Возможные значения: non-empty и <= 50 characters

    Мобильный телефон клиента для использования в фискализации

    emailForFiscal
    string

    Возможные значения: non-empty и <= 50 characters

    Электронная почта клиента для использования в фискализации

    moneyAmountForFiscal
    number

    Часть суммы операции в реальных деньгах для принудительно-уточняющей фискализации (игнорируется при поступлении externalPayAmounts)

    loyaltyPointsAmountForFiscal
    number

    Часть суммы операции в баллах лояльности для принудительно-уточняющей фискализации (игнорируется при поступлении externalPayAmounts)

    agreements

    object[]

    Перечень клиентских согласий

  • Array [

    • id
    uuid
    required

    Идентификатор согласия

    url
    string

    Возможные значения: non-empty и <= 2048 characters

    Ссылка согласия

    version
    string

    Возможные значения: non-empty и <= 50 characters

    Версия согласия

    docHash

    object

    Параметры подписи или контрольной суммы документа

    hash
    string
    required

    Возможные значения: non-empty и <= 512 characters

    Подпись или контрольная сумма документа

    algorithm
    string

    Возможные значения: non-empty и <= 50 characters

    Тип алгоритма

    version
    string

    Возможные значения: non-empty и <= 50 characters

    Версия алгоритма

  • ]

    • externalPayAmounts

    object

    Расширенное представление сумм внешней операции в полной валюте

    currency
    string
    required

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

    Мнемоническое наименование валюты

    externalAmount

    object

    required

    Расширенное представление суммы внешней операции в полной валюте

    amount

    object

    required

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    amountDetails

    object

    Расширенное представление суммы операции, скидки и переиспользования в полной валюте

    realAmount

    object

    required

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    discountAmount

    object

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    reusedAmount

    object

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    externalBasketCells

    object[]

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

  • Array [

    • article
    string
    required

    Возможные значения: non-empty и <= 50 characters

    Артикул ячейки

    amount

    object

    required

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    amountDetails

    object

    Расширенное представление суммы операции, скидки и переиспользования в полной валюте

    realAmount

    object

    required

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    discountAmount

    object

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

    reusedAmount

    object

    Представление суммы операции в полной валюте

    money
    number
    required

    Часть суммы операции в реальных деньгах

    loyaltyPoints
    number
    required

    Часть суммы операции в баллах лояльности

  • ]

    • parameters

    object[]

    Перечень дополнительных параметров подписки (Примечание: Допускается обогащение списка параметров шлюзом интеграции)

  • Array [

    • uri
    string
    required

    Возможные значения: non-empty и <= 100 characters

    Мнемоническое наименование параметра из числа разрешенных администратором

    uriParam
    string

    Возможные значения: non-empty и <= 2048 characters

    Значение мнемонического параметра установленное администратором

  • ]

    • attachedOptions
    uuid[]

    Список идентификаторов подключаемых опциональных услуг

    detachedOptions
    uuid[]

    Список идентификаторов отключаемых опциональных услуг

    preferences

    object[]

    Параметры дополнительных преференций

  • Array [

    • promotionalCompanyId
    string
    required

    Возможные значения: non-empty и <= 36 characters

    Идентификатор акционной компании

    promotionalCompanyName
    string

    Возможные значения: non-empty и <= 200 characters

    Наименование акции преференции

    preferenceMode
    string
    required

    Возможные значения: [NONE, INHERITED]

    Режим преференции

    discountAmount
    number
    required

    Сумма скидки

    discountType
    string
    required

    Возможные значения: [NONE, FIXED, FIXED_SUMMABLE, REDUCED, REDUCED_SUMMABLE]

    Тип скидки

    dayBegin
    date
    required

    День начала действия преференции включительно

    dayEnd
    date
    required

    День завершения действия преференции включительно

    article
    string

    Возможные значения: non-empty и <= 50 characters

    Артикул ячейки корзины

  • ]

Ответы

OK

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