Tworzenie żądania eksportu płatności

Prześlij żądanie POST do punktu końcowego interfejsu API, aby umieścić w kolejce nowe żądanie wyeksportowania płatności.

Żądanie REST

Metoda	Żądanie URI
POST	https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

Parametry żądania

Nazwa	W	Wymagane	Typ	Opis
$filter	Zapytanie	Nie	Struna	Mimo że jest to opcjonalny filtr, zdecydowanie zalecamy używanie filtrów w celu zwiększenia wydajności i ograniczenia danych eksportu zamiast eksportowania danych z ostatnich trzech lat. Zobacz poniższą tabelę, aby zapoznać się z pełnym zestawem opcji $filter.
format pliku	Zapytanie	Nie	Struna	Obsługiwane wartości to .csv/.tsv. Wartość domyślna to .csv, jeśli nie podano żadnej wartości.

Nazwa	Opis	Typ	Format
programName	Filtruj według co najmniej jednego zarejestrowanego programu. Przykładowe wartości — "Dostawca pośredni CSP", "Dostawca pośredni CSP 2T", "Partner bezpośrednich rozliczeń CSP", "Partner bezpośredni CSP 1T", "Odsprzedawca pośredni CSP", "Odsprzedawca pośredni CSP 2T"	Struna	{baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

Przykładowe filtry płatności z wieloma parametrami żądania

“?$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')”

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Autoryzacja	Tak	Struna	Token elementu nośnego autoryzacji.
ms-correlationid	Nie	Struna	Wewnętrzny monitor żądań. Każde żądanie generuje nowy tracker (GUID).
ms-requestid	Nie	Struna	Identyfikator idempotencji żądania.

Aby dowiedzieć się więcej, zobacz nagłówki REST Centrum Partnerów.

Treść żądania

N/A

Odpowiedź interfejsu API

HTTP/1.1 202 Accepted

Ładunek odpowiedzi interfejsu API zwraca następujące atrybuty:

Nazwa	Fakultatywny	Opis
Wartość	fałszywy	Aby uzyskać możliwe wartości i akcje, zobacz poniższą tabelę.

Wartość	Akcja klienta
Identyfikator żądania	Identyfikator żądania eksportu
data i czas żądania	Data/godzina rozpoczęcia żądania eksportu
ścieżka żądania	Ścieżka zapytania żądania eksportu.
requestQueryString	Filtr używany jako część żądania eksportu.
BlobLocation	Zasób blob z tokenem, gdy plik eksportowy jest gotowy
Stan	Stan operacji eksportowania. Zapoznaj się z poniższą listą możliwych wartości stanu.

Możliwe wartości stanu

• W kolejce: operacja eksportowania nie została uruchomiona
• Przetwarzanie: operacja eksportowania jest w toku
• Niepowodzenie: operacja eksportowania nie powiodła się po ponownych próbach, spróbuj umieścić w kolejce nowe żądanie
• Ukończono: operacja eksportowania została ukończona, a plik eksportu jest gotowy do pobrania.

Przykładowa odpowiedź:

{
    "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
}

Interfejs API zwraca stan HTTP 202.

Nazwa	Opis
Zaakceptowano 202	Żądanie jest akceptowane. Wykonaj zapytanie dotyczące adresu URL żądania GET, aby uzyskać stan żądania.

W zależności od żądania interfejs API może zwrócić inne standardowe stany:

Nazwa	Opis
400 Nieprawidłowe żądanie	Brak lub niepoprawne dane.
401 Brak autoryzacji	Obiekt wywołujący nie jest uwierzytelniany i musi uwierzytelniać się w usłudze interfejsu API partnera przed wykonaniem pierwszego wywołania.
403 Zabronione	Dzwoniący nie ma uprawnień do złożenia żądania.
Błąd wewnętrzny serwera 500	Interfejs API lub jeden z jego zależności nie może spełnić żądania. Spróbuj ponownie później.
404 Nie znaleziono	Zasób jest niedostępny z parametrami wejściowymi.
429 Ograniczanie szybkości	Zbyt wiele żądań tego samego typu. Spróbuj po pewnym czasie.