Метод получения данных платежа по токену покупки

Метод позволяет получить информацию о платеже по токену покупки.

Параметры взаимодействия

GET https://public-api.rustore.ru/public/purchase/{purchaseToken}

Атрибут	Тип	Описание	Обязательность	Расположение	Пример заполнения
Public-Token	string	Токен доступа к Public API Rustore	Да	header
purchaseToken	string	Как получить токен покупки	Да	path	111.123

Параметры ответа

Атрибут	Тип	Описание	Обязательность	Расположение	Пример заполнения
code	number	Код ответа	Да	body	ОК, ERROR, BAD_REQUEST, NOT_FOUND
message	date	Расшифровка кода ответа	Нет	body
timestamp	string	Время ответа	Да	body
body{}	object	Тело ответа	Нет	body

body{}

Атрибут	Тип	Описание	Пример заполнения
error {}	object	Расшифровка ошибки
invoice_id	string	Номер счета	12345
invoice_date	string	Дата создания счета	2020-04-29T08:18:03+03
invoice_status	string	Статус счета	created — создан; executed — пользователь выбрал способ оплаты, платёж исполняется; cancelled — отменён пользователем; paid — средства зарезервированы, счёт ожидает подтверждения (только для покупки потребляемых продуктов); confirmed — оплата прошла успешно; reversed, refunded — средства по счёту возвращены покупателю.
invoice {}	object	Информация о счете
image	string	Ссылка на картинку	https://i-love-png.com/images/grim-reaper-icon.png
application_code	string	Код приложения	com.MashaAndTheBear.HairSalon
application_name	string	Наименование приложения	Салон красоты «Маша и медведь»
owner_code	string	Код владельца приложения	com.MashaAndTheBear
owner_name	string	Наименование владельца приложения	Маша и медведь
payment_info {}	object	Информация о платеже
payment_methods{}	object	Платежные инструменты

body.error {}

Атрибут	Тип	Описание	Пример заполнения
user_message	string	Текст ошибки
error_description	object	Описание ошибки
error_code	number	Числовой код ошибки	0

body.invoice {}

Атрибут	Тип	Описание	Пример заполнения
purchaser{}	object	Информация о покупателе
`delivery_info{}`	object	Информация для доставки
invoice_params[]	array	Дополнительные параметры заказа
order{}	object	Информация о заказе

body.invoice.purchaser {}

Атрибут	Тип	Описание	Пример заполнения
email	string	Email покупателя	qq@dd.eof
phone	string	Номер телефона	9123456789
contact	string	Предпочитаемый вид связи	email

body.invoice.delivery_info {}

Атрибут	Тип	Описание	Пример заполнения
address{}	object	Адрес
delivery_type	string	Способ доставки	courier
description	string	Дополнительная информация	Перезвонить за 1,5 часа

body.invoice.delivery_info.address {}

Атрибут	Тип	Описание	Пример заполнения
country	string	Идентификатор страны	RU
city	string	Город	Москва
address	string	Адрес	ул. Вавилова, 19, офис 1

body.invoice.invoice_params []

Атрибут	Тип	Описание	Пример заполнения
key	string	Название параметра	packageName
value	string	Значение параметра	com.MashaAndTheBear.HairSalon

body.invoice.order {}

Атрибут	Тип	Описание	Пример заполнения
order_id	string	Уникальный идентификатор заказа	d290f1ee-6c54-4b01-90e6-d701748f0851
order_number	string	Номер заказа	145
order_date	string	Дата заказа	2020-04-29T08:17:03+03
service_id	string	Идентификатор сервиса	223
amount	number	Сумма заказа в минимальных единицах валюты (в копейках)	11836
currency	string	Код валюты	RUB
purpose	string	Краткое назначение платежа	Покупка в игре «Маша и Медведь, салон красоты Чародейка»
description	string	Описание заказа	Покупка внутриигрового контента в игре «Маша и Медведь, салон красоты Чародейка»
language	string	Язык	ru-RU
expiration_date	string	Дата и время окончания жизни счёта	2022-10-11T14:05:44.741Z
tax_system	number	Система налогообложения	0
trade_name	string	Торговое наименование организации	Romashka
visual_name	string	Наименование операции	Покупка/продление подписки
org_name	string	Наименование организации	ООО Ромашка
org_inn	string	ИНН организации	1234567890
visual_amount	string	Сумма	1 500,45 ₽
order_bundle []	array	Состав заказа

body.invoice.order.order_bundle []

Атрибут	Тип	Описание	Пример заполнения
position_id	number	Уникальный идентификатор товарной позиции	1
name	string	Наименование или описание товарной позиции	Кристаллы
item_params[]	array	Дополнительные параметры заказа
quantity{}	object	Описание общего количества товарных позиций
item_amount	number	Сумма стоимости всех товарных позиций в минимальных единицах валюты (в копейках)	11836
currency	string	Код валюты	RUB
item_code	string	Номер (идентификатор) товарной позиции	com.MashaAndTheBear.HairSalon.crystal100
item_price	number	Стоимость одной товарной позиции в минимальных единицах валюты (в копейках)	11836
discount_type	string	Тип скидки на товарную позицию	percent
discount_value	float	Значение скидки на товарную позицию	5.25
interest_type	string	Тип агентской комиссии за продажу товара	agentPercent
interest_value	float	Значение агентской комиссии за продажу товара	15.105
tax_type	number	Ставка НДС	6
tax_sum	number	Сумма налога в минимальных единицах валюты (в копейках)	2367
image	string	Ссылка на картинку	https://i-love-png.com/images/grim-reaper-icon.png

body.invoice.order.order_bundle.item_params []

Атрибут	Тип	Описание	Пример заполнения
key	string	Название параметра	packageName
value	string	Значение параметра	com.MashaAndTheBear.HairSalon

body.invoice.order.order_bundle.quantity {}

Атрибут	Тип	Описание	Пример заполнения
value	float	Значение	1.05
measure	string	Единица измерения	кг

body.payment_info {}

Атрибут	Тип	Описание	Пример заполнения
payment_date	number	Дата и время оплаты счета	2022-10-11T14:05:44.741Z
payment_id	string	Уникальный идентификатор платежа	d290f1ee-6c54-4b01-90e6-d701748f0851
payment_params{}	object	Дополнительные параметры платежа
device_info{}	object	Информация об устройстве
loyalty_info{}	object	Информация о программе лояльности
card_id	string	Уникальный идентификатор банковской карты	ad454ffg-6c54-4b01-90e6-d701748f0851
name	string	Алиас карты	Главная
paysys_code	string		RBS-shortname
masked_pan	string	Маскированный номер карты	**1111
expiry_date	string	Дата окончания действия карты	201912
cardholder	string	Имя держателя карты	Ivan Petrov
payment_system	string	Платежная система	Visa
payment_system_image	string	Ссылка на логотип платёжной системы	https://smartmarkettestift.online.sberbank.ru/icons/logo_visa.png
image	string	Ссылка на логотип карты	https://smartmarkettestift.online.sberbank.ru/icons/sberbank_mastercard_league_legends.jpeg
paysys	string	Наименование платёжного оператора	RBS
paysys_image	string	Ссылка на логотип платёжного оператора	https://www.sberbank.ru/common/img/uploaded/redirected/s_m_business/acquiring/assets/images/intro@2x.png
payment_way	string	Способ оплаты	SberPay
payment_way_code	string	Идентификатор способа оплаты	SberPay
payment_way_logo	string	Ссылка на логотип способа оплаты	https://cdn1.telegram.one/i/f7640dada78306b1c993e04001b8738d/828b1eb30921659e22e53a9edc92c4c4/24e01830d213d75deb99c22b9cd91ddd
bank_info{}	object	Информация о банке

body.payment_info.payment_params {}

Атрибут	Тип	Описание	Пример заполнения
key	string	Название параметра	googlePurchaseToken
value	string	Значение параметра	ameinkbophchljaejnocadib

body.payment_info.device_info {}

Атрибут	Тип	Описание	Пример заполнения
device_platform_type	string	Платформа устройства	iOS
device_platform_version	string	Версия ОС платформы	13.6.1
device_model	string	Модель устройства	iPhone 7
device_manufacturer	string	Производитель	Apple
device_id	string	Серийный номер устройства	83c3f257-46d8-41fe-951b-f79d04e288c2
surface	string		RuStore
surface_version	string	Версия ПО	11.5.0

body.payment_info.loyalty_info {}

Атрибут	Тип	Описание	Пример заполнения
service_code	string	Код бонусной программы	sbrf_spasibo
service_name	string	Наименование бонусной программы	Сбербанк Спасибо
change_rate	number	Коэффициент обмена баллов на рубли	1
payment_bonus	number	Сумма бонусных баллов, использованная при оплате счёта, в копейках	19800
award_bonus	number	Сумма средств, использованных для начисления баллов при оплате заказа. Указывается в минимальных единицах (в копейках)	21850
image	string	Ссылка на картинку	https://i-love-png.com/images/grim-reaper-icon.png

body.payment_info.bank_info{}

Атрибут	Тип	Описание	Пример заполнения
bank_name	string	Название банка-эмитента	ПАО Сбербанк
bank_country_code	string	Код страны банка-эмитента	RU
bank_country_name	string	Наименование страны банка-эмитента	Россия
bank_image	string	Ссылка на логотип банка	https://emoji.slack-edge.com/TKK9DHNCV/sber/ad2df81a6cd9812d.png

body.payment_methods {}

Атрибут	Тип	Описание	Пример заполнения
user_message	string	Сообщение пользователю (необязательное)	Для подключения подписки сохраните банковскую карту в мобильном приложении
methods[]	array	Варианты оплаты

body.payment_methods.methods []

Атрибут	Тип	Описание	Пример заполнения
method	string	Код	QR
action	string	Название	Оплатить по QR-коду

Пример ответа:

{
    "code": "OK",
    "message": null,
    "body": {
        "invoice_id": "2850",
        "invoice_date": "2023-07-18T14:31:33+03",
        "invoice_status": "confirmed",
        "application_code": "3399750",
        "application_name": "Маша и медведь",
        "owner_code": "4384191",
        "owner_name": "ООО \"Нарана\"",
        "payment_info": {
            "payment_date": "2023-07-18T14:31:42+03",
            "payment_id": "1736",
            "payment_params": null,
            "loyalty_info": null,
            "card_id": "193",
            "paysys_code": "RBS-shortname",
            "masked_pan": "XX1111",
            "expiry_date": "202412",
            "payment_system": "Visa",
            "payment_system_image": "https://smartmarket.online.sberbank.ru/image/visa.png",
            "paysys_image": null,
            "payment_way": "Оплата сохраненной картой",
            "payment_way_code": "CARD_BINDING",
            "payment_way_logo": "https://static.tildacdn.com/tild6236-3530-4235-b966-326630656238/___14_-removebg-prev.png",
            "bank_info": {
                "bank_name": "Sberbank",
                "bank_country_code": "SU",
                "bank_country_name": null,
                "bank_image": null
            },
            "device_info": null,
            "name": null,
            "cardholder": "CARDHOLDER NAME",
            "image": null,
            "paysys": "RBS"
        },
        "payment_methods": null,
        "error": {
            "user_message": "Счет подтвержден",
            "error_description": "",
            "error_code": 0
        },
        "invoice": {
            "delivery_info": {
                "delivery_type": null,
                "address": {
                    "country": null,
                    "city": null,
                    "address": null
                },
                "description": null
            },
            "invoice_params": [
                {
                    "key": "inapp_serviceparam_message_about_loyalty",
                    "value": "Оплатить подписку сейчас можно бонусами, а продлить её — только за рубли."
                },
                {
                    "key": "inapp_serviceparam_action_name",
                    "value": "Подключить подписку"
                },
                {
                    "key": "inapp_serviceparam_features",
                    "value": "VERIFY"
                },
                {
                    "key": "period_type",
                    "value": "DAY"
                },
                {
                    "key": "period_duration",
                    "value": "1"
                },
                {
                    "key": "current_period",
                    "value": "STANDARD"
                },
                {
                    "key": "payment_type",
                    "value": "INITIAL"
                }
            ],
            "purchaser": {
                "email": null,
                "phone": null,
                "contact": null
            },
            "order": {
                "order_id": "a090a93c-ca06-493d-a90a-ce2bac722358",
                "order_number": "311",
                "order_date": "2023-07-18T14:31:33+03",
                "service_id": "4720",
                "expiration_date": "2023-07-18T14:51:33+03",
                "tax_system": null,
                "trade_name": null,
                "visual_name": "Покупка/Продление подписки",
                "org_name": "ООО Супер ООО",
                "org_inn": "4419198349",
                "visual_amount": "1 ₽",
                "order_bundle": [
                    {
                        "position_id": 1,
                        "item_params": [
                            {
                                "key": "_auto_itemAttributes_agent_info.type",
                                "value": "7"
                            },
                            {
                                "key": "_auto_itemAttributes_supplier_info.name",
                                "value": "ООО \"Нарана\""
                            },
                            {
                                "key": "_auto_itemAttributes_supplier_info.inn",
                                "value": "4419198349"
                            }
                        ],
                        "item_amount": 100,
                        "item_code": "1day",
                        "item_price": 100,
                        "discount_type": null,
                        "discount_value": null,
                        "interest_type": null,
                        "interest_value": null,
                        "tax_type": 6,
                        "tax_sum": null,
                        "name": "Оплата за покупку подписки \"1day\". Провайдер: \"Покупка/Продление подписки\"",
                        "quantity": {
                            "value": 1,
                            "measure": "шт"
                        },
                        "currency": "RUB",
                        "image": ""
                    }
                ],
                "amount": 100,
                "currency": "RUB",
                "purpose": "1day",
                "description": "1day",
                "language": "ru-RU"
            }
        },
        "image": ""
    },
    "timestamp": "2023-08-02T10:11:04.655684723+03:00"
}

Валидация запроса

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

владелец и/или приложение не должны быть заблокированы;
токен должен быть действительным;
код приложения application_code соответствует владельцу, получившему токен авторизации.

Обновлено 7 августа 2023 г.