Exportaanvraag voor betaling ophalen op id

  • Artikel

Hiermee wordt de status van een bestaande exportaanvraag in de wachtrij opgehaald.

REST-aanvraag

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

Aanvraagparameters

Naam In Vereist Type Beschrijving
requestId Query’s uitvoeren Waar Guid Exportaanvraag-id

Aanvraagheader

Naam Vereist Type Description
Autorisatie Ja Tekenreeks Autorisatie Bearer-token.
ms-correlationid Nee Tekenreeks Een interne aanvraagtracker. Elke aanvraag genereert een nieuwe tracker (GUID).
ms-requestid Nee Tekenreeks De idempotentie-id van de aanvraag.

Aanvraagbody

N.v.t.

Nettolading van antwoord

Naam Beschrijving
200 Geaccepteerd De aanvraag is geaccepteerd.

Op basis van aanvraag kan API andere standaardstatussen retourneren die worden vermeld in Standaard-API-antwoordstatussen:

Naam Beschrijving
400 Ongeldige aanvraag Er ontbreken of onjuiste gegevens.
401 Onbevoegd De aanroeper is niet geverifieerd en moet zich verifiëren bij de API-service van de partner voordat de eerste aanroep wordt uitgevoerd.
403 Verboden De aanroeper is niet gemachtigd om de aanvraag te doen.
500 Interne serverfout De API of een van de afhankelijkheden kan niet voldoen aan de aanvraag. Probeer het later opnieuw.
404 Niet gevonden Resource niet beschikbaar met invoerparameters.
429 Snelheidsbeperking Te veel aanvragen van hetzelfde type. Probeer het na een tijdje.

De nettolading van het API-antwoord retourneert de volgende kenmerken:

Naam Optioneel Description
Waarde onjuist Zie de volgende tabel voor mogelijke waarden en acties.

Mogelijke waarden en acties

Waarde Clientactie
requestId Aanvraag-id van de exportaanvraag
requestDateTime Begindatum van de exportaanvraag
requestPath Querypad van de exportaanvraag.
requestQueryString Filter dat wordt gebruikt als onderdeel van de exportaanvraag.
blobLocation Blob-resource met token wanneer het exportbestand gereed is
Status Status van exportbewerking. Zie de volgende lijst met mogelijke waarden voor de status.

Mogelijke waarden voor status

  • In de wachtrij: de exportbewerking is niet gestart
  • Verwerking: de exportbewerking wordt uitgevoerd
  • Mislukt: de exportbewerking is mislukt na nieuwe pogingen. Probeer een nieuwe aanvraag in de wachtrij te plaatsen
  • Voltooid: de exportbewerking is voltooid en het exportbestand is klaar om te worden gedownload.