Получение данных платежа по идентификатору
Метод позволяет получить информацию о платеже по invoiceId
покупки.
подсказка
Если не знаете с чего начать, прочтите инструкцию в сценариях использования.
Параметры взаимодействия
Для реальных платежей:
GET
https://public-api.rustore.ru/public/purchase
предупреждение
Для тестовых платежей используйте отдельный метод:
GET
https://public-api.rustore.ru/public/sandbox/purchase
Для работы с тестовыми платежами и подписками вам понадобится новый ключ, при создании которого нужно указать методы для тестирования.
Атрибут | Тип | Описание | Обязательность | Расположение | Пример |
---|---|---|---|---|---|
| string | Jwe-токен авторизации в Public API Rustore. | Да | header | N/A |
| number | Как получить | Да | query |
|
Параметры ответа
Атрибут | Тип | Описание | Обязательность | Расположение | Пример |
---|---|---|---|---|---|
code | string | Код ответа. | Да | body | • ОК ;• ERROR ;• BAD_REQUEST ;• NOT_FOUND . |
message | string | Расшифровка кода ответа. | Нет | body | Jwe token is expired |
body{} | object | Тело ответа | Нет | body | N/A |
timestamp | string | Время ответа. | Да | body | 2023-08-02T10:11:04.655684723+03:00 |
body{}
Атрибут | Тип | Описание | Пример |
---|---|---|---|
error {} | object | Расшифровка ошибки. | N/A |
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 | Информация о счёте. | N/A |
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 | Информация о платеже. | N/A |
payment_methods{} | object | Платежные инструменты. | N/A |
body.error {}
Атрибут | Тип | Описание | Пример |
---|---|---|---|
user_message | string | Текст ошибки. | Счёт подтверждён |
error_description | object | Описание ошибки. | N/A |
error_code | number | Числовой код ошибки. | 0 |
body.invoice {}
Атрибут | Тип | Описание | Пример |
---|---|---|---|
purchaser{} | object | Информация о покупателе. | N/A |
delivery_info{} | object | Информация для доставки. | N/A |
invoice_params[] | array | Дополнительные параметры заказа. | N/A |
order{} | object | Информация о заказе. | N/A |
body.invoice.purchaser {}
Атрибут | Тип | Описание | Пример |
---|---|---|---|
email | string | Email покупателя. | qq@dd.eof |
phone | string | Номер телефона | 9123456789 |
contact | string | Предпочитаемый вид связи. | email |
body.invoice.delivery_info {}
Атрибут | Тип | Описание | Пример |
---|---|---|---|
address{} | object | Адрес. | N/A |
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 | Состав заказа. | N/A |
body.invoice.order.order_bundle []
Атрибут | Тип | Описание | Пример |
---|---|---|---|
position_id | number | Уникальный идентификатор товарной позиции. | 1 |
name | string | Наименование или описание товарной позиции. | Кристаллы |
item_params[] | array | Дополнительные параметры заказа. | N/A |
quantity{} | object | Описание общего количества товарных позиций. | N/A |
item_amount | number |