curl -X GET "https://api.affonso.io/v1/payouts?limit=10&status=pending" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "pay_abc123",
"affiliateId": "aff_456def",
"invoiceNumber": 1001,
"amount": 150.00,
"status": "pending",
"paymentMethod": "paypal",
"paymentReference": null,
"processedAt": null,
"managedPayout": true,
"affiliate": {
"name": "John Doe",
"email": "john@example.com"
},
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 15,
"totalPages": 2,
"hasNextPage": true,
"hasPrevPage": false
}
}
Payouts
List Payouts
Get a paginated list of all payouts with optional filtering
GET
/
v1
/
payouts
curl -X GET "https://api.affonso.io/v1/payouts?limit=10&status=pending" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "pay_abc123",
"affiliateId": "aff_456def",
"invoiceNumber": 1001,
"amount": 150.00,
"status": "pending",
"paymentMethod": "paypal",
"paymentReference": null,
"processedAt": null,
"managedPayout": true,
"affiliate": {
"name": "John Doe",
"email": "john@example.com"
},
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 15,
"totalPages": 2,
"hasNextPage": true,
"hasPrevPage": false
}
}
Query Parameters
integer
default:"1"
Page number for pagination. Must be a positive integer.
integer
default:"50"
Number of results per page. Maximum value is 200. Default is 50.
string
Filter payouts by status. Valid values:
pending, processing, completed, failed, cancelled.string
Filter payouts by affiliate ID. Only returns payouts for the specified affiliate.
string
Sort field and direction in the format
field:direction. Valid fields: createdAt, updatedAt, amount, processedAt. Valid directions: asc, desc. Example: createdAt:desc.string
Filter payouts created on or after this date. ISO 8601 date format (e.g.,
2024-01-01).string
Filter payouts created on or before this date. ISO 8601 date format (e.g.,
2024-12-31).Response
The response includes a paginated list of payouts and pagination metadata.boolean
Always
true for successful responsesarray
Array of payout objects.
Show Data Object Properties
Show Data Object Properties
string
Unique payout identifier
string
Affiliate ID
number
Invoice number
number
Payout amount
string
Payout status (lowercase):
pending, processing, completed, failed, cancelledstring | null
Payment method used
string | null
External payment reference
string | null
ISO 8601 timestamp when processed
boolean
Whether this is a managed payout
object | null
Affiliate information (name, email)
string
ISO 8601 creation timestamp
string
ISO 8601 last update timestamp
object
Pagination metadata object containing:
page(integer): Current page numberlimit(integer): Number of results per pagetotal(integer): Total number of payouts matching the filterstotalPages(integer): Total number of pageshasNextPage(boolean): Whether there is a next pagehasPrevPage(boolean): Whether there is a previous page
curl -X GET "https://api.affonso.io/v1/payouts?limit=10&status=pending" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": [
{
"id": "pay_abc123",
"affiliateId": "aff_456def",
"invoiceNumber": 1001,
"amount": 150.00,
"status": "pending",
"paymentMethod": "paypal",
"paymentReference": null,
"processedAt": null,
"managedPayout": true,
"affiliate": {
"name": "John Doe",
"email": "john@example.com"
},
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 15,
"totalPages": 2,
"hasNextPage": true,
"hasPrevPage": false
}
}
Was this page helpful?