Информация о платежном токене

Введение

Данный метод позволяет получить:

результат активации платежного токена (его статус)
или просто текущий статус токена, который давно в работе

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

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

GET
Endpoint: https://sandbox.pay.mts.ru/private/v1/payments/token/info?extClientId={extClientId}&paymentTokenId={paymentTokenId} HTTP/1.1
Content-Type: application/json
<Основные параметры>

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

Поле	Тип	Обяз.	Описание
Request-Id	guid	да	Идентификатор конкретного запроса
Requestor-Name	string	нет	Наименование сервиса. Для веба - домен, на котором запущен виджет. Для SDK - идентификатор приложения. Для API - имя вызывающей системы.
Requestor-Type	string	нет	Тип витрины. API Web Widget Web Page SDK Apple SDK Android
Requestor-Version	string	нет	Версия виджета/sdk

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

Поле	Тип	Обяз.	Описание
paymentTokenId	guid	да	Идентификатор токена в ПШ
extClientId	string[256]	да	Идентификатор пользователя в системе Мерчанта

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

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

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

Тело ответа

Поле	Тип	Обяз.	Описание
status	string	да	TokensStatus
paymentData	object	нет	Набор данных для оплаты
lifeTimeInfo	object	да	Информация о датах создания/изменения токена
lastErrorCode	string	нет	Код ошибки, полученной по последней, неуспешной операции

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

Поле	Тип	Обяз.	Описание
сreatedAt	dateTime	да	Дата и время создания записи, генерируется при вставке
disabledAt	dateTime	нет	Дата и время деактивации токена
blockedUntil	dateTime	нет	Дата и время, до которых заблокированы следующие попытки оплаты токеном (исключением являются оплаты с холдированием/двухфазные)

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

Поле	Тип	Обяз.	Описание
serviceId	int64	нет	ID сервиса
eWalletUserId	guid	нет	Уникальный идентификатор пользователя в ПЦ ЭК, обязательный для paymentTool c ewalletBinding
extClientId	string[256]	да	Идентификатор пользователя в системе Мерчанта
phone	string[15]	нет	Номер мобильного телефона Клиента в международном формате MSISDN
paymentTool	object	да	Структура с данными по источнику оплаты
serviceParams{}	object	да	Набор пар "параметр":"значение", описывающих реквизиты платежа (специфичных для каждого поставщика)
loyalty	object	нет	Данные о программе лояльности, которая была использована в платеже

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

Поле	Тип	Обяз.	Описание	Пример
ewalletBinding	object	нет	Оплата с электронного кошелька ПЦ	"ewalletBinding": { "bindingId": "1147849C95D145B196878C93922C3FFF", "title": "MasterCard 8146", "bindingType": "BOUND_CARD", "card": { "type": "MIR", "maskedPan": "224410*****1804", "expiryYear": 7, "expiryMonth": 2023 }
chargingEP	object	нет	Структура с параметрами оплаты, через сервис EP.Charging	"chargingEp": { "phone": "79685310245", "maskedPhone": "7968**45", "serviceCode": "151D", "title": "mtsCharging" }
internalBinding	object	нет	Объект с данными карты привязанной в хранилище МТС Pay	"internalBinding": { "internalBindingId": "d4d186d9-8483-485b-bc8f-62019cfcee7f" }
sbpToken	object	нет	Оплата через сервис быстрых платежей, сервис Invocing	"sbpToken": { "accountNumber": "123456789", "sbpTokenId": "364f974d-55fb-4ecb-ac3c-82115df8e22c" }
extMobileCommerce	object	нет	Оплата ЛС внешней мобильной коммерции	"extMobileCommerce": { "phone": "79999999999" }
sberPay	object	нет	Оплата через приложение сбера	"sberPay": { "card": { "id": 0, "type": "string", "maskedPan": "string", "expiryMonth": 0, "expiryYear": 0, "extBankName": "string" } }

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

Поле	Тип	Обяз.	Описание
bindingId	string	да	Идентификатор счета/токена
title	string	нет	Наименование платежного инструмента (для витрин)
bindingType	string	нет	Тип платежного инструмента кошелька МТС Деньги
maskedPhone	string	нет	Маскированный номер телефона для вывода на витрины. Доступно для для bindingType = MTS_ACCOUNT
card	object	нет	Структура данных карты (для bindingType = BOUND_CARD, GENERAL_CARD) Необязательный, т.к. по старым данным - может отсутствовать.

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

Поле	Тип	Обяз.	Описание
id	int64	нет (обязателен для инфо по токену	Идентификатор карты обязательно для для type =mtsBankCard, boundCard, mtsDengiBankCard необязательный для internalBindingId
type	string	да	Тип платежной системы (VISA, MASTERCARD, MAESTRO, MIR, CUP и др.)
maskedPan	string	да	Маскированный номер карты
expiryMonth	int32[2]	да	Месяц действия карты (MM)
expiryYear	int32[4]	да	Год действия карты (YYYY)
extBankName	string	нет	Банк-эмитент карты

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

Поле	Тип	Обяз.	Описание
phone	string	да	Номер телефона
maskedPhone	string	нет	Маскированный номер телефона для вывода на витрины. Необязательный, т.к. по старым данным - может отсутствовать.
serviceCode	string[30]	да	Код продукта в системе Foris, за который производится оплата
title	string	нет	Наименование платежного инструмента (для витрин)

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

Поле	Тип	Обяз.	Описание
internalBindingId	guid	да	Идентификатор карты во внутреннем хранилище
title	string	нет	Наименование платежного инструмента (для витрин)
card	object	да	Структура данных карты

Описание структуры internalBinding.card

Поле	Тип	Обяз.	Описание
id	int64	нет (обязателен для инфо по токену	Идентификатор карты обязательно для для type =mtsBankCard, boundCard, mtsDengiBankCard необязательный для internalBindingId
type	string	да	Тип платежной системы (VISA, MASTERCARD, MAESTRO, MIR, CUP и др.)
maskedPan	string	да	Маскированный номер карты
expiryMonth	int32[2]	да	Месяц действия карты (MM)
expiryYear	int32[4]	да	Год действия карты (YYYY)
extBankName	string	нет	Банк-эмитент карты

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

Поле	Тип	Обяз.	Описание
accountNumber	string	да	Номер счет
id	int64	да	Идентификатор токена СБП

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

Поле	Тип	Обяз.	Описание
phone	msisdn	да	Номер телефона (MSISND)

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

Поле	Тип	Обяз.	Описание
card	object	нет	Структура данных карты .

Описание структуры sberPay.card

Поле	Тип	Обяз.	Описание
id	int64	нет	Идентификатор карты
type	string	да	Тип платежной системы (VISA, MASTERCARD, MAESTRO, MIR, CUP и др.)
maskedPan	string	да	Маскированный номер карты
expiryMonth	int32[2]	да	Месяц действия карты (MM)
expiryYear	int32[4]	да	Год действия карты (YYYY)
extBankName	string	нет	Банк-эмитент карты

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

Поле	Тип	Обяз.	Описание
type	string (enum)	да	Тип программы лояльности. Пока тип только один - МТС Cashback MtsCashback
withdrawalEnable	boolean	да	Признак выбора возможности списания. Если accruingEventCode передан, то тут обязательно false Одновременно withdrawalEnable=true и заполненный accruingEventCode не может быть.
accruingEventCode	string	Условно	Идентификатор услуги для начисления баллов. Согласованный идентификатор Мерчантом и сервисом системы лояльности

Поле

Тип

Обяз.

Описание

type

string (enum)

да

Тип программы лояльности. Пока тип только один - МТС Cashback

MtsCashback

withdrawalEnable

boolean

да

Признак выбора возможности списания. Если accruingEventCode передан, то тут обязательно false

Одновременно withdrawalEnable=true и заполненный accruingEventCode не может быть.

accruingEventCode

string

Условно

Идентификатор услуги для начисления баллов. Согласованный идентификатор Мерчантом и сервисом системы лояльности

Пример

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

GET https://sandbox.pay.mts.ru/private/v1/payments/token/info?extClientId=chelovekNeviDimka669&paymentTokenId=8b3c3f9b-5a93-4a17-80c9-3da5cc495b27 HTTP/1.1
Host:
Request-Id: 599e4b42-e7ef-4e1b-80fb-cc59119c0dce

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

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

Тело ответа

{
  "status": "creating"
}

Платёжный токен активирован	Платёжный токен активирован с данными карты	Платёжный токен активирован с ЛС	Платёжный токен активирован chargingEp
{ "status": "active", "paymentData": { "serviceId": 5560, "description": "test", "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c", "eWalletUserId": "0000123123233", "phone": "79160026188", "paymentTool": { "ewalletBinding": { "bindingId": "1147849C95D145B196878C93922C3FFF", "title": "MasterCard *8146", "bindingType": "BOUND_CARD" } }, "serviceParams": { "NUMBER": "79160026188", "payerEmail": "tests12345@mts.ru", "id1": "108882256562" }, "loyalty": { "type": "MtsCashback", "accruingEventCode": "114f974d-23fb-4ecb-ac3c-82115df8e55c", "repaymentRatio": 0.3 } } }	{ "status": "active", "paymentData": { "serviceId": 5560, "description": "test", "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c", "eWalletUserId": "0000123123233", "phone": "79160026188", "paymentTool": { "ewalletBinding": { "bindingId": "1147849C95D145B196878C93922C3FFF", "title": "MIR 1804", "bindingType": "BOUND_CARD", "card": { "type": "MIR", "maskedPan": "224410*****1804", "expiryYear": 7, "expiryMonth": 2023 } } }, "serviceParams": { "NUMBER": "79160026188", "payerEmail": "tests12345@mts.ru", "id1": "108882256562" }, "loyalty": { "type": "MTSCashBack", "withdrawalEnable": true } } }	{ "status": "active", "paymentData": { "serviceId": 5560, "description": "test", "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c", "eWalletUserId": "0000123123233", "phone": "79160026188", "paymentTool": { "ewalletBinding": { "bindingId": "1147849C95D145B196878C93922C3FFF", "title": "Лицевой счет", "maskedPhone": "7968**78", "bindingType": "MTS_ACCOUNT" } }, "serviceParams": { "NUMBER": "79160026188", "payerEmail": "tests12345@mts.ru", "id1": "108882256562" }, "loyalty": { "type": "MTSCashBack", "withdrawalEnable": true } } }	{ "status": "active", "paymentData": { "serviceId": 5560, "description": "test", "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c", "eWalletUserId": "0000123123233", "phone": "79160026188", "paymentTool": { "chargingEp": { "phone": "79685310245", "maskedPhone": "7968**45", "serviceCode": "151D", "title": "mtsCharging" } }, "serviceParams": { "NUMBER": "79160026188", "payerEmail": "tests12345@mts.ru", "id1": "108882256562" }, "loyalty": { "type": "MTSCashBack", "withdrawalEnable": true } } }

Платёжный токен активирован

Платёжный токен активирован с данными карты

Платёжный токен активирован с ЛС

Платёжный токен активирован chargingEp

{
  "status": "active",
  "paymentData": {
    "serviceId": 5560,
    "description": "test",
    "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c",
    "eWalletUserId": "0000123123233",
    "phone": "79160026188",
    "paymentTool": {
      "ewalletBinding": {
        "bindingId": "1147849C95D145B196878C93922C3FFF",
      	"title": "MasterCard *8146",
       	"bindingType": "BOUND_CARD"       
	  }
    },
    "serviceParams": {
      "NUMBER": "79160026188",
      "payerEmail": "tests12345@mts.ru",
      "id1": "108882256562"
    },
    "loyalty": {
      "type": "MtsCashback",
      "accruingEventCode": "114f974d-23fb-4ecb-ac3c-82115df8e55c",
      "repaymentRatio": 0.3
    }
  }
}

{
  "status": "active",
  "paymentData": {
    "serviceId": 5560,
    "description": "test",
    "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c",
    "eWalletUserId": "0000123123233",
    "phone": "79160026188",
    "paymentTool": {
      "ewalletBinding": {
        "bindingId": "1147849C95D145B196878C93922C3FFF",
        "title": "MIR *1804",
        "bindingType": "BOUND_CARD",
        "card": {
          "type": "MIR",
          "maskedPan": "224410******1804",
          "expiryYear": 7,
          "expiryMonth": 2023
        }
      }
    },
    "serviceParams": {
      "NUMBER": "79160026188",
      "payerEmail": "tests12345@mts.ru",
      "id1": "108882256562"
    },
    "loyalty": {
      "type": "MTSCashBack",
      "withdrawalEnable": true
    }
  }
}

{
  "status": "active",
  "paymentData": {
    "serviceId": 5560,
    "description": "test",
    "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c",
    "eWalletUserId": "0000123123233",
    "phone": "79160026188",
    "paymentTool": {
      "ewalletBinding": {
        "bindingId": "1147849C95D145B196878C93922C3FFF",
        "title": "Лицевой счет",
        "maskedPhone": "7968**78",
        "bindingType": "MTS_ACCOUNT"
      }
    },
    "serviceParams": {
      "NUMBER": "79160026188",
      "payerEmail": "tests12345@mts.ru",
      "id1": "108882256562"
    },
    "loyalty": {
      "type": "MTSCashBack",
      "withdrawalEnable": true
    }
  }
}

{
  "status": "active",
  "paymentData": {
    "serviceId": 5560,
    "description": "test",
    "extClientId": "364f974d-55fb-4ecb-ac3c-82115df8e22c",
    "eWalletUserId": "0000123123233",
    "phone": "79160026188",
    "paymentTool": {
      "chargingEp": {
        "phone": "79685310245",
        "maskedPhone": "7968**45",
        "serviceCode": "151D",
        "title": "mtsCharging"
      }
    },
    "serviceParams": {
      "NUMBER": "79160026188",
      "payerEmail": "tests12345@mts.ru",
      "id1": "108882256562"
    },
    "loyalty": {
      "type": "MTSCashBack",
      "withdrawalEnable": true
    }
  }
}

TokensStatus

значение	описание	тип
creating	Токен в процессе создания	технический
active	Токен активный	основной
declined	Токена отклонен (в процессе создания возникли проблемы)	основной
disabled	Токен отключен	основной
blocked	Токен временно заблокирован	основной

bindingType

Код	Описание
MTS_ACCOUNT	Денежные средства на лицевом счете абонента МТС. Аванс за услуги связи
BOUND_CARD	Привязанная банковская карта стороннего банка (не МТС Банк) Может быть картой МТС Банка в том случае, если пользователь не осуществил в системе МТС Паспорт привязку профиля МТС к своему профилю в МТС Банке
ANONYMOUS_CARD	Непривязанная банковская карта. Этот код типа платежного инструмента возвращается в ответе сервиса getPaymentTerms, если для расчета комиссии был передан номер карты
EMONEY_ACCOUNT	Электронные Денежные Средства (ЭДС) в системе Электронный кошелек
GENERAL_CARD	Карта МТС банка, без разделения на кредитную/дебетовую
EXTERNALLY_TOKENIZED_CARD	Карта, токенизированная в сторонней системе (VTS/MDES)
BANK_ACCOUNT	Счет в МТС банке

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

code	message	userMessage
00299998	Validation error	Не пройдена валидация данных
00299999	An unexpected error has occurred	Непредвиденная ошибка
07000002	Payment token {0} not found	В процессе проведения операции произошла ошибка. Обратитесь в службу поддержки.