Создание запроса на экспорт платежей

Отправьте POST-запрос на конечную точку API, чтобы поставить в очередь новый запрос на экспорт платежей.

Запрос REST

Метод	URI запроса
POST	https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

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

Имя	В	Обязательно	Тип	Описание
$фильтр	Запрос	Нет	Струна	Несмотря на то что это необязательный фильтр, мы настоятельно рекомендуем использовать фильтры для повышения производительности и ограничения данных экспорта вместо экспорта последних трех лет данных. В следующей таблице приведен полный набор параметров $filter.
формат файла	Запрос	Нет	Струна	Поддерживаемые значения — .csv/.tsv. По умолчанию будет использовано значение .csv, если не указано иное.

Имя	Описание	Тип	Формат
programName	Фильтруйте по одной или нескольким программам, в которые вы зарегистрированы. Примеры значений: "CSP Косвенный Поставщик", "CSP 2T Косвенный Поставщик", "CSP Прямой Платежный Партнер", "CSP 1T Прямой Партнер", "CSP Косвенный Реселлер", "CSP 2T Косвенный Реселлер"	Струна	{baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

Пример фильтра платежей с несколькими параметрами запроса

“?$filter=payoutStatusUpdateTS le 2019-09-25T23:11:55.647Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq '000000000000')”

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

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

Дополнительные сведения см. в заголовках Центра партнеров REST.

Основная часть запроса

N/A

Ответ API

HTTP/1.1 202 Accepted

Ответ API возвращает полезную нагрузку со следующими атрибутами.

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

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

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

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

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

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/payments",
            "requestQueryString": "paymentDate ge 2023-03-01 and paymentDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

API возвращает состояние HTTP 202.

Имя	Описание
202 Принято	Запрос принимается. Проверьте URL-адрес GET-запроса для получения статуса запроса.

В зависимости от запроса API может возвращать другие стандартные состояния:

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