Partner payouts - Get payments export request by Id

Returns the payments export request details corresponding to the paymentsRequestId provided.

GET https://api.partnercenter.microsoft.com/v{version}/payouts/payments/{paymentsRequestId}

URI Parameters

Name In Required Type Description
paymentsRequestId
path True

string

Payments export request Id

version
path True

string

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
200 OK

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

OK

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.

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