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

Статья
12/19/2023

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

Запрос REST

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

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

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

Имя	Описание	Тип	Формат
programName	Фильтруйте по одной или нескольким программам, в которые вы зарегистрированы. Примеры значений : "Косвенный поставщик CSP", "CSP 2T Косвенный поставщик", "CSP Direct Bill Partner", "CSP 1T Direct Partner", "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')”

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

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

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

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

Н/П

Ответ API

HTTP/1.1 202 Accepted

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

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

Значение	Действие клиента
requestId	Идентификатор запроса на экспорт
requestDateTime	Дата начала запроса на экспорт
requestPath	Путь запроса к запросу на экспорт.
requestQueryString	Фильтр используется в рамках запроса на экспорт.
BLOBLocation	Ресурс 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 Internal Server Error (внутренняя ошибка сервера).	API или одна из его зависимостей не может выполнить запрос. Повторите попытку позже.
404 Не найдено	Ресурс недоступен с входными параметрами.
Ограничение скорости 429	Слишком много запросов одного типа. Попробуйте через некоторое время.

Поделиться через