Получение списка платежей за выбранную дату
Метод позволяет получить список счетов по идентификатору приложения.
подсказка
Если не знаете с чего начать, прочтите инструкцию в сценариях использования.
Параметры взаимодействия
GET
https://public-api.rustore.ru/public/applications/{appId}/invoices
| Атрибут | Тип | Описание | Обязательность | Расположение | Пример |
|---|---|---|---|---|---|
Public-Token | string | Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации. | Да | header | N/A |
appId | number | Код приложения (см. подробнее документацию SDK). | Да | path | 3399750 |
invoiceStatuses | array | Статусы платежей, которые должны входить в список.
| Да | query | created |
invoiceDate | string | Дата, за которую нужно получить список в формате ГГГГ-ММ-ДД | Да | query | 2024-10-23 |
pageNumber | number | Номер страницы со списком платежей, начиная с 0. Если не задан, устанавливается равным 0. | Нет | query | 1 |
pageSize | number | Количество элементов на странице. Если не задано, возвращается 20 элементов. | Нет | query | 20 |
Параметры ответа
| Атрибут | Тип | Описание | Обязательность | Расположение | Пример |
|---|---|---|---|---|---|
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{}
| Атрибут | Тип | Описание | Пример |
|---|---|---|---|
content[] | array | Содержимое ответа. | N/A |
pageNumber | number | Номер страницы | 2 |
pageSize | number | Число записей на странице. | 20 |
totalElements | number | Общее число платежей, соответствующее критериям, заданным в запросе. | 14 |
totalPages | number | Общее число страниц по ответу на запрос. | 8 |
content[]
| Атрибут | Тип | Описание | Обязательность | Пример |
|---|---|---|---|---|
invoiceId | string | Номер (идентификатор) счёта. | Да | 12345 |
invoiceDate | string | Дата создания счёта. | Да | 2020-04-29T08:18:03+03:00 |
refundDate | string | Дата возврата средств по счету. Возвращает значение, только для платежей со статусом REFUNDED. | Нет, может вернуться NULL | 2020-04-29T08:18:03+03:00 |
invoiceStatus | string | Статус счёта. | Да | Статусы платежей, которые должны входить в список.
|
developerPayload | string | Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки в SDK. | Нет, может вернуться NULL | N/A |
appId | number | Код приложения. | Да | 3399750 |
ownerCode | number | Код владельца приложения. | Да | 4384191 |
paymentInfo{} | object | Информация о платеже. | Нет, если не выбран платёжный инструмент (счёт в статусе CREATED) | N/A |
order{} | object | Информация о заказе. | Да | N/A |
purchaseId | string | Уникальный uuid идентификатор покупки. | Да | 38746279-3eae-4a41-b10c-f0bd7b36042b |
paymentInfo{}
| Атрибут | Тип | Описание | Обязательность | Пример |
|---|---|---|---|---|
paymentDate | string | Дата и время оплаты счёта. | Нет | 2024-10-24T14:31:33+03:00 |
maskedPan | string | Маскированный номер карты. | Нет | **1111 |
paymentSystem | string | Платёжная система. | Нет | Visa |
paymentWay | string | Способ оплаты. | Нет | SberPay |
paymentWayCode | string | Идентификатор способа оплаты. | Нет | SberPay |
bankName | string | Наименование банка-эмитента. | Нет | Sberbank |
order{}
| Атрибут | Тип | Описание | Обязательность | Пример |
|---|---|---|---|---|
orderId | string | Уникальный идентификатор заказа. | Да | d290f1ee-6c54-4b01-90e6-d701748f0851 |
orderNumber | string | Номер заказа. | Нет | 145 |
visualName | string | Наименование операции. | Да | Покупка цифрового контента |
amountCreate | integer | Сумма при создании заказа в минимальных единицах валюты (в копейках). | Да | 10000 |
amountCurrent | number | Сумма заказа с учетом скидок в минимальных единицах валюты (в копейках). | Да | 9000 |
currency | string | Код валюты. | Да | RUB |
itemCode | string | Код продукта, указанный в консоли при создании продукта. | Да | 1day |
description | string | Описание заказа. | Да | Покупка в приложении Маша и медведь 100 кристаллов |
language | string | Язык описания. | Да | ru-RU |
Пример успешного ответа
{
"code": "OK",
"message": "null",
"body": {
"content": [
{
"invoiceId": "2850",
"invoiceDate": "2023-07-18T14:31:33+03:00",
"refundDate": null,
"invoiceStatus": "confirmed",
"developerPayload": null,
"appId": "3399750",
"ownerCode": "4384191",
"paymentInfo": {
"paymentDate": "2024-10-24T14:31:33+03:00",
"maskedPan": "XX1111",
"paymentSystem": "Visa",
"paymentWay": "Оплата сохранённой картой",
"paymentWayCode": "CARD_BINDING",
"bankName": "Sberbank"
},
"order": {
"orderId": "a090a93c-ca06-493d-a90a-ce2bac722358",
"orderNumber": "311",
"visualName": "Покупка в приложении Маша и медведь 100 кристаллов",
"amountCreate": 10000,
"amountCurrent": 9000,
"currency": "RUB",
"itemCode": "1day",
"description": "1day",
"language": "ru-RU",
},
"purchaseId": "38746279-3eae-4a41-b10c-f0bd7b36042b"
}
],
"pageNumber": 1,
"pageSize": 20,
"totalElements": 20,
"totalPages": 1
},
"timestamp": "2024-10-22T23:39:23.557Z"
}
Пример ответа с ошибкой
{
"code": "ERROR",
"message": "Jwe token is expired",
"body": {},
"timestamp": "2024-10-22T23:39:23.560Z"
}
Валидация запроса
При получении запроса проверяется токен авторизации, полученный методом получения токена авторизации:
- владелец и/или приложение не должны быть заблокированы;
- токен должен быть действительным;
- код приложения
appIdсоответствует владельцу, получившему токен авторизации.