webapi/Order - Получение информации по заказу

HTTP‑метод: POST, GET
URL: /webapi/Order/
Форма взаимодействия: Сервер-сервер
Формат тела запроса: application/x-www-form-urlencoded
Назначение: получение информации по конкретному заказу.

URL

URLPATH

https://b2p.wallet.kvell.group/webapi/Order/

/webapi/Order/

Структура запроса

Поле	Тип	Обяз.	Описание
`sector`	`str`	✔	Уникальный идентификатор учётной записи ТСП в ПЦ.
`id`	`int`	✔	Идентификатор заказа в ПЦ, полученный из `webapi/Register`.
`reference`	`str`	✔	Идентификатор заказа на стороне ТСП.
`signature`	`str`	✔	Цифровая подпись (`sector`, `id`, `reference`, `password`)
Необязательные параметры
`get_token`	`int`		Флаг возврата токена карты в ответе (`0` — нет, `1` — да).
`mode`	`int`		Режим ответа: `0` — полный XML, `1` — сокращённый (только `id`).

Валидация: либо order_id, либо client_id должно быть заполнено.

Структура ответа

Элемент	Тип	Описание
`id`	`int`	Идентификатор заказа в ПЦ.
`state`	`str`	Статус заказа
`inprogress`	`int`	Признак «выполняется ли ещё заказ» (0/1).
`date`	`datetime`	Дата и время регистрации заказа (`YYYY.MM.DD HH:MM:SS`).
`amount`	`int`	Сумма заказа в минимальных единицах валюты (для RUB — копейки).
`currency`	`int`	Код валюты (ISO 4217).
`email`	`str`	Email плательщика.
`phone`	`str`	Телефон плательщика.
`reference`	`str`	Внутренний идентификатор заказа на стороне ТСП.
`description`	`str`	Описание платежа.
`url`	`str`	URL возврата плательщика.
`operations`	`operations`	Список операций по заказу (см. ниже).
`signature`	`str`	Цифровая подпись ответа ПЦ.

Операции заказа

Элемент operations содержит:

Атрибут / Элемент	Тип	Описание
`number` (атрибут)	`int`	Количество операций.
`operation[]`	массив	Список основных параметров операций.

Каждая operation включает:

Элемент	Тип	Описание
`id`	`int`	Идентификатор операции в ПЦ
`date`	`datetime`	Дата и время совершения операции в ПЦ (`YYYY.MM.DD HH:MM:SS`).
`type`	`str`	Тип операции.
`state`	`str`	Статус операции
`reason_code`	`int`	Код ответа на операцию ПЦ
`message`	`str`	Краткое описание кода ответа на операцию ПЦ
`name`	`str`	Имя на банковской карте Плательщика
`pan`	`str`	Маскированный номер банковской карты Плательщика
`email`	`str`	Электронная почта Плательщика
`amount`	`int`	Сумма заказа в минимальных единицах валюты (для RUB — копейки).
`curency`	`int`	Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD).
`approval_code`	`str`	Код авторизации, полученный в Банке на данную операцию.

Пример ответов

Успех (200)Ошибка валидации (400)

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id>5587788</id>
    <state>REGISTERED</state>
    <inprogress>0</inprogress>
    <date>2024.01.28 00:23:19</date>
    <amount>111</amount>
    <currency>643</currency>
    <email>mail@somesite.com</email>
    <phone>79219999999</phone>
    <reference>12345ABC</reference>
    <description>notebook</description>
    <url>http://www.somesite.com/Accept.jsp</url>
    <operations number="1">
        <operation>
            <id>2685</id>
            <date>2012-09-06 10:19:54</date>
            <type>PURCHASE</type>
            <state>TIMEOUT</state>
            <reason_code>14</reason_code>
            <message>Timeout operation</message>
            <name>Mr card holder</name>
            <pan>676531******0129</pan>
            <email>mail@somesite.com</email>
            <amount>12000</amount>
            <currency>643</currency>
            <approval_code>739258</approval_code>
        </operation>
    </operations>
    <signature>Y2Y0ZjllMGI3NDc0YjhjYTU2Yzk1ZTg1NGMxMmI1MDQ=</signature>
</order>

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <description>Sector not found</description>
    <code>105</code>
</error>

Примечания

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