Skapa exportbegäran för betalningar

Artikel
11/13/2024

Skicka en POST-begäran till API-slutpunkten för att köa en ny exportbegäran för betalningar.

REST-begäran

Metod	URI för förfrågan
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Parametrar för begäran

Name	Om	Obligatoriskt	Type	Beskrivning
$filter	Fråga	Nej	String	Även om det är ett valfritt filter rekommenderar vi starkt att du använder filter för snabbare prestanda och begränsar dina exportdata i stället för att exportera de senaste tre årens data. I följande tabell finns en fullständig uppsättning $filter alternativ.
fileFormat	Fråga	Nej	String	Värden som stöds är .csv/.tsv. Standardvärdet är .csv om inget värde anges.

Name	beskrivning	Typ	Format
programName	Filtrera efter ett eller flera program som du är registrerad i. Exempelvärden – "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’`

Exempel på betalningsfilter med flera begärandeparametrar

“?$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')”

Begärandehuvud

Namn	Obligatoriskt	Type	Beskrivning
Auktorisering	Ja	String	Auktoriseringsbäraretoken.
ms-correlationid	Nej	String	En intern spårning av begäranden. Varje begäran genererar en ny spårare (GUID).
ms-requestid	Nej	String	Begärande-ID:t för idempotens.

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

Ej tillämpligt

API-svar

HTTP/1.1 202 Accepted

API-svarsnyttolasten returnerar följande attribut:

Name	Valfritt	beskrivning
Värde	falskt	Se följande tabell för 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	Exportera åtgärdsstatus. 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, 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.

Exempelsvar:

{
    "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
}

API returnerar HTTP-status 202.

Name	beskrivning
202 Accepterad	Begäran godkänns. Fråga GET-begärande-URL:en om status för begäran.

Beroende på begäran kan API:et returnera andra standardstatusar:

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 någon gång.

Dela via