RevKeen Docs
Api reference

List voids

Retrieve a paginated list of voids with optional filters. Results are ordered by creation date (newest first). Voids are full-amount cancellations of unsettled transactions.


Related endpoints

  • POST /voids — Create a void
  • GET /voids/{id} — Get void by ID

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
/voids
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 void status

Value in"pending" | "processing" | "succeeded" | "failed"
payment_id?string

Filter by original payment ID

Formatuuid
gateway?string

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

created_after?string

ISO 8601 date - only voids created after this date

created_before?string

ISO 8601 date - only voids 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/voids" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "public_id": "void_abc123xyz",
      "payment_id": "660e8400-e29b-41d4-a716-446655440000",
      "parent_transaction_id": "660e8400-e29b-41d4-a716-446655440000",
      "order_id": null,
      "gateway": "string",
      "gateway_void_id": "txn_void_12345",
      "amount_minor": 10000,
      "currency": "USD",
      "reason": "Customer requested cancellation",
      "reason_code": "customer_request",
      "status": "succeeded",
      "failure_reason": null,
      "failure_code": null,
      "voided_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