Dela via


Hämta begäran om betalningsexport efter ID

Hämtar status för en befintlig köad exportbegäran.

REST-begäran

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

Parametrar för begäran

Name I Krävs Typ Description
requestId Söka i data Sant GUID Exportera begärande-ID

Begärandehuvud

Name Krävs Typ Description
Auktorisering Ja Sträng Ägartoken för auktorisering.
ms-correlationid Nej Sträng En intern spårning av förfrågningar. Varje begäran genererar en ny spårare (GUID).
ms-requestid Nej Sträng ID för begärande-idempotens.

Begärandetext

Ej tillämpligt.

Svarsnyttolast

Name Beskrivning
200 Accepterade Begäran har accepterats.

Baserat på begäran kan API returnera annan standardstatus som anges i Standard API-svarsstatusar:

Name Beskrivning
400 Felaktig begäran Det saknades eller var felaktiga data.
401 – Ej behörig Anroparen är inte autentiserad och måste autentisera med partner-API-tjänsten innan det första anropet.
403 – Förbjuden Anroparen har inte behörighet att göra begäran.
500 internt serverfel API:et eller något av dess beroenden kan inte uppfylla begäran. Försök igen senare.
404 – Hittades inte Resursen är inte tillgänglig med indataparametrar.
429 Hastighetsbegränsning För många begäranden av samma typ. Försök efter en stund.

API-svarsnyttolasten returnerar följande attribut:

Name Valfritt Description
Värde falskt I följande tabell finns möjliga värden och åtgärder.

Möjliga värden och åtgärder

Värde Klientåtgärd
requestId Begärande-ID för exportbegäran
requestDateTime Initieringsdatum för exportbegäran
requestPath Frågesökväg för exportbegäran.
requestQueryString Filter som används som en del av exportbegäran.
blobLocation Blobresurs med token när exportfilen är klar
Status Status för exportåtgärd. Se följande lista över möjliga värden för status.

Möjliga värden för status

  • I kö: Exportåtgärden har inte startats
  • Bearbetning: Exportåtgärden pågår
  • Misslyckades: Exportåtgärden misslyckades efter återförsök och försök att köa en ny begäran
  • Slutförd: Exportåtgärden har slutförts och exportfilen är klar för nedladdning.