Skip to main content

List Payouts

Retrieve a paginated list of all payouts, with optional filtering by status and date range.

Endpoint

GET /v1/payouts

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1).
limitintegerNoResults per page (default: 20, max: 100).
statusstringNoFilter by status: pending, processing, completed, failed.
fromstringNoISO 8601 start date for filtering.
tostringNoISO 8601 end date for filtering.

Request

curl "https://api.thiqwave.com/v1/payouts?page=1&limit=20&status=completed" \
  -H "X-API-Key: your_api_key"

Response

{
  "data": [
    {
      "payout_id": "payout_1234567890",
      "quote_id": "quote_9876543210",
      "status": "completed",
      "source_currency": "USDT",
      "source_network": "ethereum",
      "source_amount": "500.00",
      "destination_currency": "AED",
      "destination_account": {
        "account_holder": "John Doe",
        "account_number": "0123456789",
        "bank_code": "ABUAAE3D",
        "country": "AE"
      },
      "destination_amount": 52250,
      "reference": "payout_ref_001",
      "created_at": "2026-04-09T14:30:00Z",
      "completed_at": "2026-04-09T14:35:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 87,
    "total_pages": 5
  }
}

Response Fields

FieldTypeDescription
dataarrayArray of payout objects.
meta.pageintegerCurrent page number.
meta.limitintegerResults per page.
meta.totalintegerTotal number of payouts.
meta.total_pagesintegerTotal number of pages.

Notes

  • Use pagination to retrieve large result sets efficiently.
  • Filter by status to focus on specific payout states.
  • Use from and to parameters to filter by date range.