Skip to main content
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": "[email protected]"
    },
    "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

id
string
required
The unique identifier of the payout to retrieve

Response

The response includes the payout object with transaction details.
success
boolean
Always true for successful responses
data
object
The payout object.
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": "[email protected]"
    },
    "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"
  }
}