Получение данных платежа по идентификатору
Метод позволяет получить информацию о платеже по invoiceId
покупки.
提示
Если не знаете с чего начать, прочтите инструкцию в сценариях использования.
Параметры взаимодействия
Для реальных платежей:
GET
https://public-api.rustore.ru/public/purchase
警告
Для тестовых платежей используйте отдельный метод:
GET
https://public-api.rustore.ru/public/sandbox/purchase
Для работы с тестовыми платежами и подписками вам понадобится новый ключ, при создании которого нужно указать методы для тестирования.
Атрибут | Тип | Описание | Обязательность | Расположение | Пример |
---|---|---|---|---|---|
Public-Token | string | Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации. | Да | header | N/A |
invoceId | number | Как получить invoceId , см. документацию по SDK платежей. | Да | 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 |