RevKeen Docs
Api reference

List charges

Retrieve a paginated list of charges with optional filtering by customer, status, or date range.

Related endpoints

  • POST /charges — Create a one-time charge
  • GET /charges/{id} — Get charge
  • POST /charges/{id}/capture — Capture charge
  • POST /charges/{id}/refund — Refund charge

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
/charges

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

page?integer

Page number

Default1
Range1 <= value
limit?integer

Maximum number of results (1-100)

Default20
Range1 <= value <= 100
customerId?string

Filter by customer UUID

Formatuuid
status?string

Filter by charge status

Value in"pending" | "succeeded" | "failed" | "refunded" | "partially_refunded"
createdGte?string

Filter charges created on or after this date

Formatdate-time
createdLte?string

Filter charges created on or before this date

Formatdate-time

Response Body

application/json

curl "https://api.revkeen.com/v2/charges" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "string",
      "customerId": "string",
      "invoiceId": "string",
      "paymentMethodId": "string",
      "amountMinor": 0,
      "amountCapturedMinor": 0,
      "amountRefundedMinor": 0,
      "currency": "str",
      "status": "pending",
      "description": "string",
      "statementDescriptor": "string",
      "failureCode": "string",
      "failureMessage": "string",
      "gatewayTransactionId": "string",
      "receiptUrl": "string",
      "captured": true,
      "metadata": {
        "property1": null,
        "property2": null
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}
Empty
Edit on GitHub