Tworzenie żądania eksportu płatności

Artykuł
11/13/2024

Prześlij żądanie POST do punktu końcowego interfejsu API w celu kolejkowania nowego żądania eksportu dla płatności.

Żądanie REST

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

Parametry żądania

Nazwisko	Za	Wymagania	Type	Opis
$filter	Query	Nie.	String	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.
fileFormat	Query	Nie.	String	Obsługiwane wartości to .csv/.tsv. Wartość domyślna to .csv, jeśli nie podano żadnej wartości.

Nazwa/nazwisko	opis	Type	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 CSP 1T Direct Partner", "Odsprzedawca pośredni CSP 2T", "Odsprzedawca pośredni CSP 2T"	String	{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

Nazwisko	Wymagania	Type	Opis
Autoryzacja	Tak	String	Token elementu nośnego autoryzacji.
ms-correlationid	Nie.	String	Wewnętrzny monitor żądań. Każde żądanie generuje nowy tracker (GUID).
ms-requestid	Nie.	String	Identyfikator idempotentności żądania.

Aby dowiedzieć się więcej, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Nie dotyczy

Odpowiedź interfejsu API

HTTP/1.1 202 Accepted

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

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

Wartość	Akcja klienta
requestId	Identyfikator żądania eksportu
requestDateTime	Data/godzina rozpoczęcia żądania eksportu
requestPath	Ścieżka zapytania żądania eksportu.
requestQueryString	Filtr używany jako część żądania eksportu.
BlobLocation	Zasób obiektu blob z tokenem, gdy plik eksportu 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/nazwisko	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/nazwisko	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	Obiekt wywołujący nie ma autoryzacji do składania żądania.
500 Wewnętrzny błąd serwera	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.

Udostępnij za pośrednictwem