RevKeenDocs
StatusSupport
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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

GET
/payouts/{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 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

Payout public ID (pyt_xxx) or UUID

Response Body

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/payouts/string" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "public_id": "string",    "gateway": "string",    "gateway_payout_id": "string",    "gross_amount_minor": 0,    "fees_amount_minor": 0,    "net_amount_minor": 0,    "currency": "string",    "charges_count": 0,    "refunds_count": 0,    "chargebacks_count": 0,    "status": "pending",    "arrival_date": "string",    "settled_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z"  }}

List payments GET

List all payments for the authenticated merchant. Supports filtering and cursor-based pagination. --- **Related endpoints** - `GET /payments/{id}` — Retrieve a payment **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

List payouts GET

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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.