Exportanforderung für Zahlungen erstellen

Artikel
11/13/2024

Senden Sie eine POST-Anforderung an den API-Endpunkt, um eine neue Exportanforderung für Zahlungen in die Warteschlange zu stellen.

REST-Anforderung

Methode	Anforderungs-URI
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Anforderungsparameter

Name	Geben Sie in	Erforderlich	Type	Beschreibung
$filter	Abfrage	Nein	String	Obwohl es sich um einen optionalen Filter handelt, empfehlen wir dringend, Filter für eine schnellere Leistung zu verwenden und Ihre Exportdaten zu beschränken, anstatt die letzten drei Jahre der Daten zu exportieren. Eine vollständige Reihe von $filter Optionen finden Sie in der folgenden Tabelle.
fileFormat	Abfrage	Nein	String	Unterstützte Werte sind CSV/.tsv. Standardwert ist CSV, wenn kein Wert angegeben wird.

Name	Description	Typ	Format
programName	Filtern Sie nach einem oder mehreren Programmen, für die Sie registriert sind. Beispielwerte : "CSP Indirect Provider", "CSP 2T Indirect Provider", "CSP Direct Bill Partner", "CSP 1T Direct Partner", "CSP Indirect Reseller", "CSP 2T Indirect Reseller"	String	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Beispielzahlungsfilter mit mehreren Anforderungsparametern

“?$filter=payoutStatusUpdateTS le 2019-09-25T23:11:55.647Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq '000000000000')”

Anforderungsheader

Name	Erforderlich	Type	BESCHREIBUNG
Authorization	Ja	String	Autorisierungs-Bearertoken.
ms-correlationid	Nein	String	Eine interne Anforderungsverfolgung. Jede Anforderung generiert einen neuen Tracker (GUID).
ms-requestid	Nein	String	Die Anforderungs-Idempotency-ID.

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

N/V

API-Antwort

HTTP/1.1 202 Accepted

Die API-Antwortnutzlast gibt die folgenden Attribute zurück:

Name	Optional	Beschreibung
Wert	false	Mögliche Werte und Aktionen finden Sie in der folgenden Tabelle.

Wert	Clientaktion
requestId	Anforderungs-ID der Exportanforderung
requestDateTime	Initiierungsdatum der Exportanforderung
requestPath	Abfragepfad der Exportanforderung.
requestQueryString	Filter, der als Teil der Exportanforderung verwendet wird.
blobLocation	Blob-Ressource mit Token, wenn die Exportdatei bereit ist
Status	Exportvorgangsstatus. Weitere Informationen finden Sie in der folgenden Liste möglicher Werte für den Status.

Mögliche Werte für den Status

In die Warteschlange gestellt: Der Exportvorgang wurde nicht gestartet.
Verarbeitung: Der Exportvorgang wird ausgeführt.
Fehler: Fehler beim Exportvorgang nach Wiederholungen, versuchen Sie, eine neue Anforderung in die Warteschlange zu stellen.
Abgeschlossen: Der Exportvorgang wurde abgeschlossen, und die Exportdatei kann heruntergeladen werden.

Beispielantwort:

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/payments",
            "requestQueryString": "paymentDate ge 2023-03-01 and paymentDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

DIE API gibt DEN HTTP-Status 202 zurück.

Name	Beschreibung
202 – Akzeptiert	Die Anforderung wird akzeptiert. Fragen Sie die GET-Anforderungs-URL für den Anforderungsstatus ab.

Je nach Anforderung kann die API andere Standardstatus zurückgeben:

Name	Beschreibung
400 – ungültige Anforderung	Es fehlen 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 Anrufer ist nicht berechtigt, 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 Seite nicht gefunden	Ressource mit Eingabeparametern nicht verfügbar.
429 Satzbegrenzung	Zu viele Anforderungen desselben Typs. Versuchen Sie es nach einiger Zeit.

Freigeben über