Exportaanvraag voor betalingen maken

Artikel
03/11/2025

Dien een POST-aanvraag in bij het API-eindpunt om een nieuwe exportaanvraag voor betalingen in de wachtrij te plaatsen.

REST-aanvraag

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

Aanvraagparameters

Naam	In	Verplicht	Type	Beschrijving
$filters	Vraag	Nee	Snaar	Hoewel het een optioneel filter is, raden we u ten zeerste aan filters te gebruiken voor snellere prestaties en het beperken van uw exportgegevens in plaats van de laatste drie jaar aan gegevens te exporteren. Zie de volgende tabel voor een volledige set $filter opties.
bestandsformaat	Vraag	Nee	Snaar	Ondersteunde waarden zijn .csv/.tsv. Standaard ingesteld op .csv als er geen waarde wordt opgegeven.

Naam	Beschrijving	Type	Formaat
programName	Filter op een of meer programma's waarin u bent ingeschreven. Voorbeeldwaarden: 'CSP Indirecte Leverancier', 'CSP 2T Indirecte Leverancier', 'CSP Directe Factureringspartner', 'CSP 1T Directe Partner', 'CSP Indirecte Wederverkoper', 'CSP 2T Indirecte Wederverkoper'	Snaar	{baseUrl}`/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’`

Voorbeeld van een betalingsfilter met meerdere aanvraagparameters

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

Header voor aanvraag

Naam	Vereist	Type	Beschrijving
Machtiging	Ja	Snaar	Autorisatie Bearer-token.
ms-correlationid	Nee	Snaar	Een interne aanvraagtracker. Elke aanvraag genereert een nieuwe tracker (GUID).
ms-requestid	Nee	Snaar	Het idempotentie-ID van de aanvraag.

Voor meer informatie, zie REST-headers van het Partnercentrum.

Aanvraaginhoud

N.V.T

API-antwoord

HTTP/1.1 202 Accepted

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

Naam	Facultatief	Beschrijving
Waarde	vals	Zie de volgende tabel voor mogelijke waarden en acties.

Waarde	Clientactie
verzoekId	Aanvraag-id van de exportaanvraag
aanvraagDatumTijd	Begindatum van de exportaanvraag
aanvraagpad	Zoekpad 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 nog niet gestart
verwerking: de exportbewerking wordt uitgevoerd
mislukt: de exportbewerking is mislukt na nieuwe pogingen en probeer een nieuwe aanvraag in de wachtrij te plaatsen
voltooide: de exportbewerking is voltooid en het exportbestand kan worden gedownload.

Voorbeeldantwoord:

{
    "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 retourneert HTTP-status 202.

Naam	Beschrijving
202 Geaccepteerd	De aanvraag wordt geaccepteerd. Voer een query uit op de GET-aanvraag-URL voor de aanvraagstatus.

Afhankelijk van de aanvraag kan de API andere standaardstatussen retourneren:

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

Delen via