Udostępnij za pośrednictwem

Pobierz żądanie eksportu płatności na podstawie identyfikatora

  • Artykuł

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

Żądanie REST

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

Parametry żądania

Nazwa W Wymagane Typ Opis
identyfikator_żądania Zapytanie Prawda Guid Identyfikator żądania eksportu

Nagłówek żądania

Nazwa Wymagane Typ Opis
Autoryzacja Tak Struna Token uwierzytelniający Bearer.
ms-correlationid Nie Struna Wewnętrzny monitor żądań. Każde żądanie generuje nowy tracker (GUID).
ms-requestid Nie Struna Identyfikator idempotentności żądania.

Treść żądania

N/A.

Ładunek odpowiedzi

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

Na podstawie żądania API może zwrócić inny standardowy status wymieniony w standardowych statusach odpowiedzi API.

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 Obiekt wywołujący nie ma autoryzacji do składania żą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.

Ł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ę.

Możliwe wartości i akcje

Wartość Akcja klienta
identyfikator żądania Identyfikator żądania eksportu
requestDateTime Data/godzina rozpoczęcia żądania eksportu
ścieżka żądania Ścieżka zapytania dotyczącego eksportu.
ciąg zapytania (requestQueryString) Filtr używany jako część żądania eksportu.
BlobLocation Zasób 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.