Получение данных платежа по идентификатору (v2)

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

подсказка

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

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

GET

https://public-api.rustore.ru/public/v2/purchase/{invoiceId}

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
`Public-Token`	string	Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации.	Да	header	N/A
`invoiceId`	number	Как получить `invoiceId`, см. документацию по SDK платежей.	Да	query	`1234`

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

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
`code`	string	Код ответа.	Да	body	• `ОК`; • `ERROR`; • `BAD_REQUEST`; • `NOT_FOUND`.
`message`	string	Расшифровка кода ответа.	Нет, может вернуться `NULL`	body	`Jwe token is expired`
`body`	object	Тело ответа	Нет	body	N/A
`timestamp`	string	Время ответа.	Да	body	`2023-08-02T10:11:04.655684723+03:00`

`body`

Атрибут	Тип	Описание	Обязательность	Пример
`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	Статус счёта.	Да	Статусы платежей, которые должны входить в список. `CREATED` - создан; `EXECUTED` - запущен процесс оплаты; `CONFIRMED` — финальный статус успешного платежа, денежные средства списаны с покупателя; `CANCELLED` - отменён пользователем до запуска оплаты; `REJECTED` - отказ при платеже (недостаточно средств, невалидный CVC или другие причины); `EXPIRED` - истекло время на оплату; `PAID` - для покупки потребляемых товаров, средства успешно захолдированы, покупка ожидает подтверждения со стороны разработчика; `REVERSED` - для покупки потребляемых товаров: не поступило запроса на подтверждение холда, холд отменён, деньги возвращены покупателю; `REFUNDED` - средства по счёту возвращены покупателю. `REFUNDING` - инициирован возврат, запрос отправлен в эквайер.
`developerPayload`	string	Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки в SDK.	Нет, может вернуться `NULL`	N/A
`appId`	number	Код приложения (см. подробнее документацию SDK).	Да	`3399750`
`ownerCode`	number	Код владельца приложения.	Да	`4384191`
`paymentInfo`	object	Информация о платеже.	Нет, если не выбран платёжный инструмент (счёт в статусе `CREATED`)	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":
    {
        "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"
    },
    "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"
}

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

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

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

Получение данных платежа по идентификатору (v2)

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

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

body​

paymentInfo​

order​

Пример успешного ответа​

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

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