curl -X GET "https://api.affonso.io/v1/payouts/pay_abc123" \
-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"
},
"transactions": [
{
"id": "txn_123",
"amount": 50.00,
"commission": {
"id": "com_456",
"amount": 100.00,
"commissionAmount": 50.00,
"createdAt": "2024-01-20T10:00:00Z"
},
"createdAt": "2024-01-25T10:00:00Z"
}
],
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
}
Payouts
Get Payout
Retrieve a single payout by ID with transaction details
GET
/
v1
/
payouts
/
{id}
curl -X GET "https://api.affonso.io/v1/payouts/pay_abc123" \
-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"
},
"transactions": [
{
"id": "txn_123",
"amount": 50.00,
"commission": {
"id": "com_456",
"amount": 100.00,
"commissionAmount": 50.00,
"createdAt": "2024-01-20T10:00:00Z"
},
"createdAt": "2024-01-25T10:00:00Z"
}
],
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
}
Path Parameters
string
required
The unique identifier of the payout to retrieve
Response
The response includes the payout object with transaction details.boolean
Always
true for successful responsesobject
The payout object.
Show Data Object Properties
Show Data Object Properties
string
Unique identifier for the payout
string
The affiliate ID who will receive this payout
number
Invoice number for this payout
number
Total payout amount
string
Payout status (lowercase):
pending, processing, completed, failed, cancelledstring | null
Payment method used for the payout
string | null
External payment reference (e.g., PayPal transaction ID)
string | null
ISO 8601 timestamp when the payout was processed
boolean
Whether this is a managed payout
object | null
Affiliate information object containing:
name(string | null): Affiliate nameemail(string | null): Affiliate email
array
Array of payout transaction objects. Each transaction contains:
id(string): Transaction IDamount(number): Transaction amountcommission(object): Commission details withid,amount,commissionAmount,createdAtcreatedAt(string): ISO 8601 creation timestamp
string
ISO 8601 timestamp of when the payout was created
string
ISO 8601 timestamp of when the payout was last updated
curl -X GET "https://api.affonso.io/v1/payouts/pay_abc123" \
-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"
},
"transactions": [
{
"id": "txn_123",
"amount": 50.00,
"commission": {
"id": "com_456",
"amount": 100.00,
"commissionAmount": 50.00,
"createdAt": "2024-01-20T10:00:00Z"
},
"createdAt": "2024-01-25T10:00:00Z"
}
],
"createdAt": "2024-01-25T10:00:00Z",
"updatedAt": "2024-01-25T10:00:00Z"
}
}
Was this page helpful?
⌘I