В главное меню

Получение списка платежных инструментов


Введение

Данный метод позволяет получить информацию обо всех платежных инструментов в электронном кошельке.

Входные параметры

Заголовок запроса

POST
Endpoint: /service/ewallet/bindings HTTP/1.1
Content-Type: application/json
Request-Id: {значение}

<Основные параметры>

Основные параметры

Поле

Тип

Обяз.

Описание

Request-IdguidдаИдентификатор конкретного запроса

Requestor-Name

string

нет

Наименование сервиса.

  • Для веба - домен, на котором запущен виджет.
  • Для SDK - идентификатор приложения.
  • Для API - имя вызывающей системы.
Requestor-Typestringнет

Тип витрины.

  • API
  • Web Widget
  • Web Page
  • SDK Apple
  • SDK Android
Requestor-VersionstringнетВерсия виджета/sdk

Тело запроса

Поле

Тип

Обязат.

Описание

ssoTokenId

base64

одно из двух

Идентификатор токена системы МТС.Логин

ssoCookie

base64

одно из двух

Идентификатор сессии пользователя МТС Логин (значение куки MTSWebSSO)

Обязательность ssoTokenId и ssoCookie полей:

Должен быть передан один из двух параметров. Если переданы оба, то идентификация будет выполнена по параметру ssoTokenId.

Выходные параметры

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

Поле

Тип

Обязат.

Описание

payerData

object

нет

Набор данных с параметрами плательщика

paymentTools

object

нет

Блок с информацией по ПИ

Описание структуры payerData

Поле

Тип

Обяз.

Описание

profileobjectнетНабор данных профиля пользователя

Описание структуры profile

Поле

Тип

Обяз.

Описание

phone

string[11]

да

Номер телефона авторизованного покупателя

titlestringдаНаименование профиля
subTitlestringдаДоп информация профиля
imagestringнетURL аватара профиля, с расширением (.jpeg, .png)
balanceamountнетБаланс счета
typestring (enum)да

Тип профиля

  • MOBILE - Мобильная связь
  • FIX - Фиксированная связь
  • VIRTUAL - Виртуальный номер
  • LBSV - Региональный интернет и телевидение
  • MGTS - МГТС (интернет и телевидение Москва и частично МО)
  • IOT - IOT-номер
  • GS - Госуслуги
  • UNKNOWN

Описание структуры paymentTools

Поле

Тип

Обяз.

Описание

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

canDelete

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

title

stringнетНаименование платежного инструмента. Поле mnemonic в платежном инструменте МТС Деньги
subTitlestringнетДополнительное наименование платежного инструмента. Поле userCardMnemonic в платежном инструменте МТС Деньги
mnemonicstring [100]нетМнемоническое имя ПИ, заданное пользователем

type

typeEnum

да

Тип платежного инструмента

complexTypestringда

Тип платежного инструмента

complexType

Описание

mtsBankCardПривязанная карта МТС банка

mtsDengiBankCard

Привязанная карта банка МТС Деньги (виртуальная)
boundCardПривязанная банковская карта стороннего банка (не МТС Банк)
mtsChargingОплата с лицевого счета через систему ChargingEP
mtsMobileCommerceДенежные средства на лицевом счете абонента МТС
extMobileCommerceОплата с лицевого счета через систему StreamPayments
emoneyAccountДенежные средства в кошельке МТС Деньги
applePayТокенизированная карта в системе Apple Pay
googlePayТокенизированная карта в системе Google Pay
samsungPayТокенизированная карта в системе Samsung Pay
sbpTokenПривязанный счет системы быстрых платежей
newCardНепривязанная банковская карта
ewalletBindingНеизвестный инструмент кошелька. 
orderint32даПорядковый номер для сортировки, по умолчанию 999

imageUrl

stringнет

Ссылка на изображение платежного инструмента

ewalletBinding

objectдаОплата со счета электронного кошелька МТС Деньги

cardInfo

object

нет

Блок с информацией по ПИ, специфичные для карты

Описание структуры cardInfo

Поле

Тип

Обяз.

Описание

expiryYearint32нетГод срока действия карты
expiryMonthint32нетМесяц срока действия карты
maskedPanstringнетМаскированный номер карты

Описание структуры ewalletBinding

Рекомендуем не использовать

Поле

Тип

Обяз.

Описание

bindingId

string

да

Идентификатор счета/токена

bindingTypestringдасписок типов, если "bindingType": "GENERAL_CARD", его заменяем на "BOUND_CARD".
cardTypestringнетТип карты, если ПИ имеет тип карты
userCardMnemonicstringнетСоставное имя карты: тип карты + 4 последние цифры
userIdstringнетУникальный идентификатор пользователя в ПЦ ЭК

Примеры

Заголовок запроса

POST
Endpoint: /service/ewallet/bindings HTTP/1.1
Content-Type: application/json
Request-Id: 83fc026e-ce7f-4f8f-a73a-d093da1726b1

Тело запроса

{
  "ssoCookie": "00d2a25f-bdd7-49a2-9444-0c167bcac67b....."
}
{
  "ssoTokenId": "00d2a25f-bdd7-49a2-9444-0c167bcac67b....."
}

Заголовок ответа

Content-Type: application/json; charset=utf-8
http-code: 200
http-status: OK

Тело ответа

{
  "payerData": {
    "profile": {
      "phone": "79455312312",
      "title": "Иванов Иван",
      "subTitle": "+7 945 531-23-12",
      "image": "https://static.mts.ru/upload-sso/avatar/31dc7940-c8ee-4665-a3e1-9ea0ff01be2e.jpeg",
      "type": "mobile"
    }
  },
  "paymentTools": [
    {
      "id": "27Yw9cFxj27JrUxcQbNGMZL9Y6gt8vfqrffKje1KuckY1NG",
      "title": "Phone 79181230012",
      "mnemonic": "Phone 79181230012",
      "complexType": "mtsMobileCommerce",
      "imageUrl":"http://localhost/mtsaccount/",
      "type": "eWalletBinding",
      "canDelete": false,
      "eWalletBinding": {
        "bindingId": "123B9B1A448647EC8993DE8F0233E001",
        "bindingType": "MTS_ACCOUNT",
        "userId": "00013221231"
      },
      "order": 0
    },
    {
      "id": "27Yvt3JFp7eVA1zTxAMuVmTy466aVV5DfotSLThgJyX4ELB",
      "title": "5***8146",
      "subTitle": "MASTERCARD *8146",
      "mnemonic": "5***8146",
      "canDelete": true,
      "cardInfo": {
        "expiryYear": 2023,
        "expiryMonth": 5,
        "maskedPan": "1231*****45456"
      },
      "complexType": "boundCard",
      "type": "eWalletBinding",
      "eWalletBinding": {
        "bindingId": "12782FDFFD2F4FDDB1D23BAB23B0504D",
        "bindingType": "BOUND_CARD",
        "cardType": "MASTERCARD",
        "userCardMnemonic": "MASTERCARD *8146",
        "userId": "00013221231"
      },
      "order": 5
    },
    {
      "id": "27Yw1oVg719zgX4Z2MPDAiN3Nna9qB2udGoK8dueTCj4uks",
      "title": "Мой кошелек",
      "mnemonic": "Мой кошелек",
      "canDelete": false,
      "complexType": "ewalletBinding",
      "imageUrl":"http://localhost/mtsaccount/",
      "type": "eWalletBinding",
      "eWalletBinding": {
        "bindingId": "12AC768B610F41A1836DCC24638585E1",
        "bindingType": "EMONEY_ACCOUNT",
        "userId": "00013221231"
      },
      "order": 6
    }
  ]
}

Возможные коды шибок

code

message

userMessage

00199998

Validation error

Не пройдена валидация данных

00199999

An unexpected error has occurred

Непредвиденная ошибка

00100002

WEBSSO: Authentication is not taken placeWEBSSO: Аутентификация не пройдена