Перейти к основному содержимому

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

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

подсказка

Если не знаете с чего начать, прочтите инструкцию в сценариях использования.

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

Для реальных платежей:

GET
https://public-api.rustore.ru/public/purchase/{purchaseToken}
предупреждение

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

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

Для работы с тестовыми платежами и подписками вам понадобится новый ключ, при создании которого нужно указать методы для тестирования.

АтрибутТипОписаниеОбязательностьРасположениеПример

Public-Token

string

Jwe-токен авторизации в Public API Rustore.
Как получить токен авторизации.

ДаheaderN/A

purchaseToken

примечание

purchaseToken = subscriptionToken из SDK для платежей in-app и подписок.

string

Как получить токен подписки, см. документацию по SDK платежей.

Даpath

111.123

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

АтрибутТипОписаниеОбязательностьРасположениеПример
codestringКод ответа.Даbody• ОК;
• ERROR;
• BAD_REQUEST;
• NOT_FOUND.
messagestringРасшифровка кода ответа.НетbodyJwe token is expired
body{}objectТело ответаНетbodyN/A
timestampstringВремя ответа.Даbody2023-08-02T10:11:04.655684723+03:00

body{}​

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

body.error {}​

АтрибутТипОписаниеПример
user_messagestringТекст ошибки.Счёт подтверждён
error_descriptionobjectОписание ошибки.N/A
error_codenumberЧисловой код ошибки.0

body.invoice {}​

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

body.invoice.purchaser {}​

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

body.invoice.delivery_info {}​

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

body.invoice.delivery_info.address {}​

АтрибутТипОписаниеПример
countrystringИдентификатор страны.RU
citystringГород.Москва
addressstringАдрес.ул. Вавилова, 19, офис 1

body.invoice.invoice_params []​

АтрибутТипОписаниеПример
keystringНазвание параметра.packageName
valuestringЗначение параметра.com.MashaAndTheBear.HairSalon

body.invoice.order {}​

АтрибутТипОписаниеПример
order_idstringУникальный идентификатор заказа.d290f1ee-6c54-4b01-90e6-d701748f0851
order_numberstringНомер заказа.145
order_datestringДата заказа.2020-04-29T08:17:03+03
service_idstringИдентификатор сервиса.223
amountnumberСумма заказа в минимальных единицах валюты (в копейках).11836
currencystringКод валюты.RUB
purposestringКраткое назначение платежа.Покупка в игре «Маша и Медведь, салон красоты Чародейка»
descriptionstringОписание заказа.Покупка внутриигрового контента в игре «Маша и Медведь, салон красоты Чародейка»
languagestringЯзык.ru-RU
expiration_datestringДата и время окончания жизни счёта.2022-10-11T14:05:44.741Z
tax_systemnumberСистема налогообложения.0
trade_namestringТорговое наименование организации.Romashka
visual_namestringНаименование операции.Покупка/продление подписки
org_namestringНаименование организации.ООО Ромашка
org_innstringИНН организации.1234567890
visual_amountstringСумма.1 500,45 ₽
order_bundle []arrayСостав заказа.N/A

body.invoice.order.order_bundle []​

АтрибутТипОписаниеПример
position_idnumberУникальный идентификатор товарной позиции.1
namestringНаименование или описание товарной позиции.Кристаллы
item_params[]arrayДополнительные параметры заказа.N/A
quantity{}objectОписание общего количества товарных позиций.N/A
item_amountnumberСумма стоимости всех товарных позиций в минимальных единицах валюты (в копейках).11836
currencystringКод валюты.RUB
item_codestringНомер (идентификатор) товарной позиции.com.MashaAndTheBear.HairSalon.crystal100
item_pricenumberСтоимость одной товарной позиции в минимальных единицах валюты (в копейках).11836
discount_typestringТип скидки на товарную позицию.percent
discount_valuefloatЗначение скидки на товарную позицию.5.25
interest_typestringТип агентской комиссии за продажу товараagentPercent
interest_valuefloatЗначение агентской комиссии за продажу товара.15.105
tax_typenumberСтавка НДС.6
tax_sumnumberСумма налога в минимальных единицах валюты (в копейках).2367
imagestringСсылка на картинку.https://i-love-png.com/images/grim-reaper-icon.png

body.invoice.order.order_bundle.item_params []​

АтрибутТипОписаниеПример
keystringНазвание параметра.packageName
valuestringЗначение параметра.com.MashaAndTheBear.HairSalon

body.invoice.order.order_bundle.quantity {}​

АтрибутТипОписаниеПример
valuefloatЗначение.1.05
measurestringЕдиница измерения.кг

body.payment_info {}​

АтрибутТипОписаниеПример
payment_datenumberДата и время оплаты счета.2022-10-11T14:05:44.741Z
payment_idstringУникальный идентификатор платежа.82022-123456
payment_params{}objectДополнительные параметры платежа.N/A
device_info{}objectИнформация об устройстве.N/A
loyalty_info{}objectИнформация о программе лояльности.N/A
card_idstringУникальный идентификатор банковской карты.ad454ffg-6c54-4b01-90e6-d701748f0851
namestringАлиас карты.Главная
paysys_codestringN/ARBS-shortname
masked_panstringМаскированный номер карты.**1111
expiry_datestringДата окончания действия карты.201912
cardholderstringИмя держателя карты.Ivan Petrov
payment_systemstringПлатежная система.Visa
payment_system_imagestringСсылка на логотип платёжной системы.https://smartmarkettestift.online.sberbank.ru/icons/logo_visa.png
imagestringСсылка на логотип карты.https://smartmarkettestift.online.sberbank.ru/icons/sberbank_mastercard_league_legends.jpeg
paysysstringНаименование платёжного оператора.RBS
paysys_imagestringСсылка на логотип платёжного оператора.https://www.sberbank.ru/common/img/uploaded/redirected/s_m_business/acquiring/assets/images/intro@2x.png
payment_waystringСпособ оплаты.SberPay
payment_way_codestringИдентификатор способа оплаты.SberPay
payment_way_logostringСсылка на логотип способа оплаты.https://cdn1.telegram.one/i/f7640dada78306b1c993e04001b8738d/828b1eb30921659e22e53a9edc92c4c4/24e01830d213d75deb99c22b9cd91ddd
bank_info{}objectИнформация о банке.N/A

body.payment_info.payment_params {}​

АтрибутТипОписаниеПример
keystringНазвание параметра.googlePurchaseToken
valuestringЗначение параметра.ameinkbophchljaejnocadib

body.payment_info.device_info {}​

АтрибутТипОписаниеПример
device_platform_typestringПлатформа устройства.Android
device_platform_versionstringВерсия ОС платформы.Android 13
device_modelstringМодель устройства.Samsung Galaxy A14
device_manufacturerstringПроизводитель.Samsung
device_idstringСерийный номер устройства.83c3f257-46d8-41fe-951b-f79d04e288c2
surfacestringN/ARuStore
surface_versionstringВерсия ПО.11.5.0

body.payment_info.loyalty_info {}​

АтрибутТипОписаниеПример
service_codestringКод бонусной программы.sbrf_spasibo
service_namestringНаименование бонусной программы.Сбербанк Спасибо
change_ratenumberКоэффициент обмена баллов на рубли.1
payment_bonusnumberСумма бонусных баллов, использованная при оплате счёта, в копейках.19800
award_bonusnumberСумма средств, использованных для начисления баллов при оплате заказа. Указывается в минимальных единицах валюты (в копейках).21850
imagestringСсылка на картинку.https://i-love-png.com/images/grim-reaper-icon.png

body.payment_info.bank_info {}​

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

body.payment_methods {}​

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

body.payment_methods.methods []​

АтрибутТипОписаниеПример
methodstringКод.QR
actionstringНазвание.Оплатить по 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": "82022-123456",
            "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"
}

Пример ответа с ошибкой​

{
    "code": "ERROR",
    "message": "Jwe token is expired",
    "body": null,
    "timestamp": "2024-01-21T13:51:59.654427798+03:00"
}

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

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

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