RevKeenDocs
StatusSupport
API Reference

Get income report

Get income report for the authenticated merchant. Requires 'finance:read' scope. --- **Related endpoints** - `GET /finance/summary` — Get finance summary **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
/finance/income

Get income report for the authenticated merchant. Requires 'finance:read' scope.

Related endpoints

  • GET /finance/summary — Get finance summary

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

Query Parameters

start_date*string

Start date

end_date*string

End date

group_by?string

Group results by time period

Default"day"

Value in

  • "day"
  • "week"
  • "month"
subscription_id?string

Filter by subscription UUID

Formatuuid
status?string

Filter by status

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/finance/income?start_date=2024-01-01&end_date=2024-12-31" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "summary": {    "total_gross_cents": 0,    "total_fees_cents": 0,    "total_net_cents": 0,    "total_tx_count": 0,    "total_refund_count": 0  },  "rows": [    {}  ]}

Get export status GET

Check the status of an export job. When status is 'completed', the download_url will contain a presigned URL (valid for 1 hour). --- **Related endpoints** - `POST /exports` — Create an export **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 finance summary GET

Get finance summary for the authenticated merchant. Requires 'finance:read' scope. --- **Related endpoints** - `GET /finance/income` — Get income report **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.