RevKeen Docs
Api reference

List payouts

Retrieve a paginated list of payouts/settlements with optional filters. Results are ordered by creation date (newest first).

Related endpoints

  • GET /payouts/{id} — Get payout by ID
  • GET /payouts/{id}/payments — Get payments in a payout

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/payouts

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

status?string

Filter by payout status

Value in"pending" | "in_transit" | "paid" | "failed" | "canceled"
gateway?string

Filter by payment gateway (nmi, stripe, etc.)

created_after?string

ISO 8601 date - only payouts created after this date

created_before?string

ISO 8601 date - only payouts created before this date

limit?number

Number of results to return (1-100)

Default20
Range1 <= value <= 100
offset?|

Number of results to skip

Default0
Range0 <= value

Response Body

application/json

curl "https://api.revkeen.com/v2/payouts" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "public_id": "pyt_abc123xyz",
      "gateway": "string",
      "gateway_payout_id": "batch_12345",
      "gross_amount_minor": 100000,
      "fees_amount_minor": 2500,
      "net_amount_minor": 97500,
      "currency": "USD",
      "charges_count": 42,
      "refunds_count": 2,
      "chargebacks_count": 0,
      "status": "paid",
      "arrival_date": "2024-01-15",
      "settled_at": "2024-01-15T10:30:00Z",
      "created_at": "2024-01-14T08:00:00Z"
    }
  ],
  "meta": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}
Empty
Empty
Edit on GitHub