Skapa exportbegäran för betalningar

Artikel
03/07/2025

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

REST-begäran

Metod	Begärd URI
POST	`https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv`

Parametrar för begäran

Namn	I	Krävs	Typ	Beskrivning
$filter	Fråga	Nej	Sträng	Ä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.
filformat	Fråga	Nej	Sträng	Värden som stöds är .csv/.tsv. Standardvärdet är .csv om inget värde anges.

Namn	Beskrivning	Typ	Format
programName	Filtrera efter ett eller flera program som du är registrerad i. Exempelvärden – "CSP Indirekt Leverantör", "CSP 2T Indirekt Leverantör", "CSP Direktfaktureringspartner", "CSP 1T Direktpartner", "CSP Indirekt Återförsäljare", "CSP 2T Indirekt Återförsäljare"	Sträng	{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	Krävs	Typ	Beskrivning
Tillstånd	Ja	Sträng	Auktoriseringsbäraretoken.
ms-correlationid	Nej	Sträng	Ett internt spårningssystem för begäranden. Varje begäran genererar en ny spårare (GUID).
ms-requestid	Nej	Sträng	Begärande-ID:t för idempotens.

Mer information finns i REST-huvuden i Partnercenter.

Begäranens innehåll

Ej tillämpligt

API-svar

HTTP/1.1 202 Accepted

API-svarsnyttolasten returnerar följande attribut:

Namn	Valfri	Beskrivning
Värde	falsk	Se följande tabell för möjliga värden och åtgärder.

Värde	Klientåtgärd
begäranId	Begärande-ID för exportbegäran
förfrågningsDatumTid	Initieringsdatum för exportbegäran
Förfrågningsväg	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 exportoperation. 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 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.

Namn	Beskrivning
202 Accepterad	Begäran godkänns. Kontrollera GET-förfrågnings-URL:en för begärans status.

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

Namn	Beskrivning
400 Felaktig begäran	Det saknades eller var felaktiga data.
401 Ej auktoriserad	Anroparen är inte autentiserad och måste autentisera med partner-API-tjänsten innan det första anropet.
403 Förbjudet	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 igen om en stund.

Dela via