RevKeen Docs
Api reference

Get payout by ID

Retrieve a single payout by its public ID (pyt_xxx) or internal UUID.

Related endpoints

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

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/payouts/{id}

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

Path Parameters

id*string

Payout public ID (pyt_xxx) or UUID

Response Body

application/json

curl "https://api.revkeen.com/v2/payouts/string" \  -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"
  }
}
Empty
Empty
Empty
Edit on GitHub