Partner payouts - Creates a new payments export request

  • Reference
Service:
Partner Center Rest
API Version:
1.0

This API allows to create a new payments export request. We recommend to use $filter param for every request. Please see below on the usage of the filters and all the filters available in the export page interface (UX) are also available through this API, providing flexibility and consistency in filtering data.

POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments
With optional parameters: 
POST https://api.partnercenter.microsoft.com/v{version}/payouts/payments?$filter={$filter}&enrollmentParticipantId={enrollmentParticipantId}&paymentId={paymentId}&payoutStatusUpdateTS={payoutStatusUpdateTS}&paymentAmount={paymentAmount}&payoutOrderType={payoutOrderType}&Multiple filters={Multiple filters}

URI Parameters

Name In Required Type Description
version
 path True

string

$filter
 query

string

The $filter query param is an optional parameter for creating a export operation. However, we highly recommend to use $filter for better performance and faster availability of the export report. Below are some of the key attribute filters that can be used as part of export operation
enrollmentParticipantId
 query

int

Enrolled MPN Id filter for a export request. Usage: {baseUrl}/payouts/payments?$filter=enrollmentParticipantId=12345
Multiple filters
 query

string

Here is a sample query with multiple filters for a export request. Usage: {baseUrl}/payouts/payments?$filter=payoutStatusUpdateTS ge 2023-01-01 and payoutStatusUpdateTS le 2023-05-31 and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq 'xxxxxxx')
paymentAmount
 query

double

Payment amount to filter the payments for a export request. Usage: {baseUrl}/payouts/payments?$filter=paymentAmount ge 2000 and paymentAmount le 5000
paymentId
 query

int

PaymentId filter for a export request. Usage: {baseUrl}/payouts/payments?$filter=paymentId=123456
payoutOrderType
 query

string

Payout order type (Rebate, coop, Fee, Sell) to filter the payments for a export request. Usage: {baseUrl}/payouts/payments?$filter=?$filter=payoutOrderType='REBATE'
payoutStatusUpdateTS
 query

string

Payout status date to filter the payments for a export request. Usage: {baseUrl}/payouts/transactionhistory?$filter=payoutStatusUpdateTS ge 2023-03-01 and payoutStatusUpdateTS le 2023-04-12

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token
Client-Request-ID

string

ID of request provided by user

Responses

Name Type Description
202 Accepted

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

The request was successfully accepted for processing.

Headers

Request-ID: string
400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.
401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.
403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.
404 Not Found

The resource is not found.
429 Too Many Requests

Too many requests.
500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this.

Definitions

Microsoft.Partner.Service.PartnerPayout.Contracts.V1.Export

Name Type Description
blobLocation

string

processingStartDateTime

string

requestDateTime

string

requestId

string

requestPath

string

requestQueryString

string

status enum:
  • Completed
  • Failed
  • Processing
  • Queued