List Payouts

GET 
/affiliate-manager/:locationId/payouts

Retrieve the list of payouts for a location.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

status Payout Status

Payout Status

Available optionspendingapprovedpaiddeniedcanceledpayment_failed

inFlight boolean

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.

query string

query

affiliateId string

Affiliate Id

campaignId string

Campaign Id

skip number

Number of records to skip for pagination

Default value:0

limit number

Maximum number of records to return

Default value:10

start string

Filter payouts on or after this date (ISO 8601)

end string

Filter payouts on or before this date (ISO 8601)

application/json

Successful response

application/json

Schema

Schema

payoutsobject[]required

Payout list

metaobject

Pagination metadata

Example (auto)

{
  "payouts": [
    {
      "_id": "69c0ee71c501d6b731110028",
      "locationId": "Lx1EI6YIgQYMQi0ytFXv",
      "affiliateId": "6792254b535e27b9ab02be63",
      "campaignId": "695e70357e5c8d108c41d160",
      "currency": "USD",
      "amount": 700,
      "status": "pending",
      "payoutMonth": "2026-06-01T00:00:00.000Z",
      "dueAt": "2026-06-29T00:00:00.000Z",
      "paidMethod": "manual",
      "deleted": false,
      "createdAt": "2026-03-23T07:40:33.034Z",
      "updatedAt": "2026-03-23T09:18:03.320Z",
      "affiliate": {
        "_id": "6792254b535e27b9ab02be63",
        "firstName": "John",
        "lastName": "Deo",
        "phone": "+915979490952",
        "deleted": false,
        "locationId": "Lx1EI6YIgQYMQi0ytFXv",
        "active": true,
        "createdAt": "2025-01-23T11:17:31.157Z",
        "contactId": "3gLOpQH8ESSPpHW3JUAn"
      },
      "campaign": "New Invite Flow",
      "affiliateName": "John Deo",
      "affiliateEmail": "[email protected]",
      "payoutMethod": "PAYPAL"
    }
  ],
  "meta": {
    "count": 42
  }
}