Skip to main content
PayoutsVersion: v3

List Payouts

GET/affiliate-manager/{locationId}/payouts

Retrieve the list of payouts for a location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Query Parameters

statusPayout Status

Payout Status

Available optionspendingapprovedpaiddeniedcanceledpayment_failed
inFlightboolean

Filter by whether a payment gateway is still working on the payout. true drives the Processing tab; false excludes in-flight rows from Approved and Paid. Omit for the previous behaviour of no filter.

Example:true
querystring

query

Example:john
affiliateIdstring

Affiliate Id

Example:65df04201e428a0c5ebb6572
campaignIdstring

Campaign Id

Example:65df04201e428a0c5ebb6573
skipnumber

Number of records to skip for pagination

Default:0
Example:1
limitnumber

Maximum number of records to return

Default:10
Example:10
startstring

Filter payouts on or after this date (ISO 8601)

Example:2022-12-01T00:00:00.000Z
endstring

Filter payouts on or before this date (ISO 8601)

Example:2022-12-31T23:59:59.999Z

Response

application/json

Successful response

payoutsobject[]required

Payout list

metaobject

Pagination metadata