Udostępnij za pośrednictwem

Pobieranie żądania eksportu płatności według identyfikatora

  • Artykuł

Pobiera stan istniejącego żądania eksportu w kolejce.

Żądanie REST

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

Parametry żądania

Nazwa W Wymagany Typ Opis
requestId Zapytanie Prawda Guid (identyfikator GUID) Identyfikator żądania eksportu

Nagłówek żądania

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

Treść żądania

Nie dotyczy.

Ładunek odpowiedzi

Nazwa Opis
Zaakceptowano 200 Żądanie zostało zaakceptowane.

Na podstawie żądania interfejs API może zwrócić inny stan standardowy wymieniony w stanach odpowiedzi interfejsu API w warstwie Standardowa:

Nazwa Opis
400 Nieprawidłowe żądanie Brak lub nieprawidłowe 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 wykonania żądania.
500 Wewnętrzny błąd serwera Interfejs API lub jedna 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.

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

Nazwa Opcjonalne Opis
Wartość fałsz W poniższej tabeli przedstawiono możliwe wartości i akcje.

Możliwe wartości i akcje

Wartość Akcja klienta
requestId Identyfikator żądania eksportu
requestDateTime Data/godzina rozpoczęcia żądania eksportu
requestPath Ścieżka zapytania żądania eksportu.
requestQueryString Filtr używany w ramach żądania eksportu.
blobLocation Zasób obiektu blob z tokenem, gdy plik eksportu jest gotowy
Stan Stan operacji eksportowania. Zobacz 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.