Abrufen der Zahlungsexportanforderung nach ID
Ruft die status einer vorhandenen Exportanforderung in der Warteschlange ab.
REST-Anforderung
GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}
Anforderungsparameter
Name | Geben Sie in | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
requestId | Abfrage | True | Guid | Exportanforderungs-ID |
Anforderungsheader
Name | Erforderlich | Typ | BESCHREIBUNG |
---|---|---|---|
Authorization | Ja | String | Autorisierungs-Bearertoken. |
ms-correlationid | Nein | String | Eine interne Anforderungsnachverfolgung. Jede Anforderung generiert eine neue Nachverfolgung (GUID). |
ms-requestid | Nein | String | Die Idempotenz-ID der Anforderung. |
Anforderungstext
N/V.
Antwortnutzlast
Name | BESCHREIBUNG |
---|---|
200 Akzeptiert | Die Anforderung wurde akzeptiert. |
Basierend auf der Anforderung kann die API andere Standard-status zurückgeben, die unter Standard-API-Antwortstatus aufgeführt sind:
Name | BESCHREIBUNG |
---|---|
400 – Ungültige Anforderung | Es fehlten oder falsche Daten. |
401 – Nicht autorisiert | Der Aufrufer ist nicht authentifiziert und muss sich vor dem ersten Aufruf beim Partner-API-Dienst authentifizieren. |
403 Verboten | Der Aufrufer ist nicht autorisiert, die Anforderung zu stellen. |
500 Interner Serverfehler | Die API oder eine ihrer Abhängigkeiten kann die Anforderung nicht erfüllen. Versuchen Sie es später noch einmal. |
404 – Nicht gefunden | Ressource mit Eingabeparametern nicht verfügbar. |
429 Ratenbegrenzung | Zu viele Anforderungen desselben Typs. Versuchen Sie es nach einiger Zeit. |
Die API-Antwortnutzlast gibt die folgenden Attribute zurück:
Name | Optional | BESCHREIBUNG |
---|---|---|
Wert | false | In der folgenden Tabelle finden Sie mögliche Werte und Aktionen. |
Mögliche Werte und Aktionen
Wert | Clientaktion |
---|---|
requestId | Anforderungs-ID der Exportanforderung |
requestDateTime | Initiierung von datetime der Exportanforderung |
requestPath | Abfragepfad der Exportanforderung. |
requestQueryString | Filter, der als Teil der Exportanforderung verwendet wird. |
blobLocation | Blobressource mit Token, wenn die Exportdatei bereit ist |
Status | Exportvorgang status. Sehen Sie sich die folgende Liste der möglichen Werte für status an. |
Mögliche Werte für status
- In die Warteschlange: Der Exportvorgang wurde nicht gestartet.
- Verarbeitung: Der Exportvorgang wird ausgeführt.
- Fehler: Der Exportvorgang ist nach Wiederholungen fehlgeschlagen. Versuchen Sie, eine neue Anforderung in die Warteschlange zu stellen.
- Abgeschlossen: Der Exportvorgang wurde abgeschlossen, und die Exportdatei kann heruntergeladen werden.