Skip to main content
GET
/
payouts
List payouts
curl --request GET \
  --url https://api.affonso.io/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "affiliate_id": "<string>",
      "affiliate_name": "<string>",
      "affiliate_email": "<string>",
      "amount": 123,
      "currency": "<string>",
      "status": "pending",
      "payment_method": "<string>",
      "payment_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_prev_page": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Query Parameters

page
integer
default:1
limit
integer
default:50
Required range: x <= 200
status
enum<string>

Filter by payout status

Available options:
pending,
processing,
completed,
failed,
cancelled
affiliateId
string

Filter by affiliate ID

sort
string
Example:

"createdAt:desc"

dateFrom
string<date-time>
dateTo
string<date-time>

Response

List of payouts

success
boolean
data
object[]
pagination
object