Получение запроса на экспорт платежей по идентификатору

Получает статус существующего запроса на экспорт, находящегося в очереди.

Запрос REST

GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}

Параметры запроса

Имя	В	Обязательно	Тип	Описание
идентификатор запроса	Запрос	Верно	Guid	Идентификатор запроса экспорта

Заголовок запроса

Имя	Обязательно	Тип	Описание
Авторизация	Да	Струна	Токен носителя авторизации.
ms-correlationid	Нет	Струна	Внутреннее средство отслеживания запросов. Каждый запрос создает новый трекер (GUID).
ms-requestid	Нет	Струна	Идентификатор идемпотентности запроса.

Текст запроса

N/A.

Полезная нагрузка ответа

Имя	Описание
200 Принято	Запрос был принят.

На основе запроса API может возвращать другое стандартное состояние, указанное в состояниях ответа API уровня "Стандартный":

Имя	Описание
400 Недопустимый запрос	Были пропущены или неверные данные.
401 Несанкционированный доступ	Вызывающий не прошёл аутентификацию и должен аутентифицироваться в службе API партнёра перед первым вызовом.
403 Запрещено	Звонящий не авторизован для выполнения запроса.
Ошибка внутреннего сервера 500	API или одна из его зависимостей не может выполнить запрос. Повторите попытку позже.
404 Не найдено	Ресурс недоступен с входными параметрами.
Ограничение скорости 429	Слишком много запросов одного типа. Попробуйте через некоторое время.

Ответное сообщение API возвращает следующие атрибуты:

Имя	Необязательный	Описание
Ценность	ложный	В следующей таблице приведены возможные значения и действия.

возможные значения и действия

Ценность	Действие клиента
идентификатор запроса	Идентификатор запроса на экспорт
времяЗапроса	Дата начала запроса на экспорт
путь запроса	Путь запросов на экспорт.
requestQueryString	Фильтр используется в рамках запроса на экспорт.
BLOBLocation	Ресурс BLOB с токеном доступен, когда файл экспорта готов.
Статус	Состояние операции экспорта. См. следующий список возможных значений для состояния.

Возможные значения для состояния

• в очереди: но операция экспорта не запущена
• обработка: выполняется операция экспорта
• Ошибка: операция экспорта завершилась неудачей после повторных попыток, попробуйте поставить в очередь новый запрос.
• завершено: операция экспорта завершена, а файл экспорта готов к скачиванию.