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

Введение

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

Payments Status

Значение в ответе GET API	Значение в Notifications	Описание
waitingForProceed	-	Ожидается информация об устройстве
waitingForConfirmation	-	Ожидает подтверждение операции от пользователя
waitingForProviderResult(всё ещё можно получить при запросе статуса)	INPROGRESS(больше не отправляем, вместо него сразу шлём EXECUTED или REJECTED)	Ожидает результат оплаты в системе провайдера
executed	EXECUTED	Платеж успешно проведен
rejected	REJECTED	Отказан на этапе выполнения
authorized	AUTHORIZED	Холдирование успешно проведено
cancelled	CANCELLED	Платеж/холдирование было отменено
-	REFUNDED	Возврат денежных средств, частичный или полный
error	-	Ошибка во время обработки
processing	-	Принят на обработку Все статусы начинающиеся с Process***

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

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

GET
Endpoint: https://sandbox.pay.mts.ru/private/v1/payments/{id} HTTP/1.1
<Основные параметры>

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

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

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

Поле	Тип	Обяз.	Описание
id	int64	да	ID Платежа

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

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

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

Тело ответа

Поле	Тип	Обяз.	Описание
id	int64	да	Идентификатор платежа
createdAt	dateTime	да	Дата и время создания записи в сервисе
operationDate	dateTime	нет	Дата и время операции
status	statusEnum	да	Статус платежа (PaymentsStatus) processing inProgress waitingForProceed waitingForConfirmation cancelled rejected executed authorized cancelled
serviceId	int64	да	Идентификатор сервиса
amount	amount	да	Сумма платежа
currency	string	да	Валюта
serviceParams{}	object	да	Набор пар "параметр":"значение", описывающих реквизиты платежа (специфичных для каждого поставщика)
description	string	нет	Описание
processing	object	нет	Данные полученные от процессинговой системы
paymentToolInfo	object	нет	Информация с выбранным способом оплаты
amountInfo	object	нет	Полная информация о сумме оплаты
errorData	object	нет	Данные о ошибке при обработке запроса
refunds	arrays	да	Дочерние операции с типом Refund
loyalty	object	нет	Данные о программе лояльности, которая была использована в платеже

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

Поле		Тип	Обяз.	Описание
id		string	нет	Идентификатор операции в процессинговой системе
rrn		string	нет	RRN Банка
approvalCode		string	нет	Код авторизации
data		object	нет	Набор пар "параметр": "значение" передаваемая от сервиса процессинга
	сpa	srting	нет	Параметр оплаты внешней мобильной коммерции (метод тарификации) MC тарификация прошла через мобильную коммерцию SN тарификация прошла через CPA ИДС только extMobileCommerce (!)

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

Поле	Тип	Обяз.	Описание
initialAmount	amount	нет	Исходная сумма, представленная к оплате
totalAmount	amount	нет	Сумма операции с применённой комиссией
commission	amount	нет	Комиссия в рублях. Число с фиксированной точкой, две цифры после точки. Может быть отрицательной (скидка)

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

Поле	Тип	Обяз.	Описание
type	string	да	Тип способа оплаты MtsBankCard BoundCard MtsCharging MtsMobileCommerce EMoneyAccount ExtMobileCommerce Sbp NewCard InternalBinding Bnpl SbpToken SberPay
card	object	нет	Информация по карте пользователя

Поле

Тип

Обяз.

Описание

type

string

да

Тип способа оплаты

MtsBankCard
BoundCard
MtsCharging
MtsMobileCommerce
EMoneyAccount
ExtMobileCommerce
Sbp
NewCard
InternalBinding
Bnpl
SbpToken
SberPay

card

object

нет

Информация по карте пользователя

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

Поле	Тип	Обяз.	Описание
bank	string	нет	Банк-эмитент карты
type	Enum VISA MASTERCARD MAESTRO MIR CUP UNKNOWN	нет	Платёжная система карты
isSocialCard	boolean	нет	Признак того, является ли карты социальной
maskedPan	string	нет	Маскированный номер карты (334455******6677)
expiryMonth	int32[2]	нет	Месяц действия карты (MM)
expiryYear	int32[4]	нет	Год действия карты (YYYY)

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

Поле	Тип	Обяз.	Описание
code	string	нет	Код ошибки (первые три цифры - код сервиса (034), последние пять - код ошибки (00002))
message	string	да	Техническое сообщение не показываем
userMessage	string	нет	Сообщение для пользователя
isFatal	boolean	нет	Признак что дальнейшая работа не возможна
isPublic	boolean	нет	Признак что информация из поля message может быть транслирована пользователю

Описание массива refunds

Поле	Тип	Обяз.	Описание
id	int64	да	Идентификатор операции возврата
status	string	да	Статус операции
amount	amount	да	Сумма возврата
loyalty	object	нет	информация о возвращаемых бонусах в рамках конкретной транзакции

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

Поле	Тип	Обяз.	Описание
amount	int	нет	сумма возвращенных бонусов в рамках конкретной транзакции

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

Поле	Тип	Обяз.	Описание
type	string (enum)	да	Тип программы лояльности. Пока тип только один - МТС Cashback mtsCashBack
amount	int	да	Сумма баллов программы лояльности пользователя, использованная для оплаты

Описание статусов операций refunds

значение в ответе GET API	описание
processing	Операция выполняется(все статусы кроме 2,90,80)
executed	Операция успешно выполнена
rejected	Отказано на этапе выполнения
waitingForProviderResult	Платеж в процессе выполнения на стороне процессинговой системы

Примеры

Запрос

Заголовок

GET /payments/32343 HTTP/1.1
Host:
<Основные параметры> (пример в описании)

Ответ

Заголовок

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

Тело

{
  "createdAt": "2020-12-04T12:39:03.103Z",
  "operationDate": "2020-12-04T12:42:03.103Z",
  "id": 0,
  "status": "New",
  "serviceId": 0,
  "currency": "string",
  "amount": 0,
  "processing": {
    "id": "13782300811",
    "rrn": "228416787387",
    "approvalCode": "816622"
  },
  "serviceParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "description": "string",
  "errorData": {
    "code": "02099998",
    "message": "'Amount' must be greater than '0'.",
    "userMessage": "Поле не может быть 0",
    "isFatal": false,
    "isPublic": false
  },
   "paymentToolInfo": {
        "type": "boundCard",
        "card": {
            "type": "MASTERCARD",
            "maskedPan": "524602******0911",
            "expiryMonth": 5,
            "expiryYear": 2028
        }
    }
  "refunds": [
    {
      "id": 1,
      "status": "New",
      "amount": 10
    },
    {
      "id": 2,
      "status": "New",
      "amount": 5
    }
  ]
}

{
  "createdAt": "2020-12-04T12:39:03.103Z",
  "operationDate": "2020-12-04T12:42:03.103Z",
  "id": 0,
  "status": "New",
  "serviceId": 0,
  "currency": "string",
  "amount": 0,
  "processing": {
    "id": "13782300811",
    "rrn": "228416787387",
    "approvalCode": "816622"
  },
  "serviceParams": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "description": "string",
  "paymentToolInfo": {
    "type": "newcard",
    "card": {
        "bank": "MTS_Bank",   
        "type": "MIR",
        "isSocialCard": false
    }
  },
  "amountInfo": {
    "initialAmount": 100,
    "totalAmount": 103,
    "commission": 3.0
  },
  "errorData": {
    "code": "02099998",
    "message": "'Amount' must be greater than '0'.",
    "userMessage": "Поле не может быть 0",
    "isFatal": false,
    "isPublic": false
  },
  "refunds": [
    {
      "id": 1,
      "status": "New",
      "amount": 10
    },
    {
      "id": 2,
      "status": "New",
      "amount": 5
    }
  ]
}

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

code	message	userMessage
00299998	Validation error	Не пройдена валидация данных
00299999	An unexpected error has occurred	Непредвиденная ошибка