Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Reviews

List Reviews

Returns a list of your fraud reviews, newest-first.

Use the open filter to focus on reviews that still need action.

get/v1/reviews

Query parameters

openboolean nullable

Filter by review state. true returns only open reviews, false returns only closed. Omit to return both.

Filter by review state. true returns only open reviews, false returns only closed. Omit to return both.

charge_idstring nullable

Filter to reviews on a specific charge.

Example:fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter to reviews on a specific charge.

payment_intent_idstring nullable

Filter to reviews on a specific payment intent.

Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter to reviews on a specific payment intent.

client_reference_idstring nullable

Filter by client_reference_id (matches your own identifier on the underlying checkout session, when present).

Filter by client_reference_id (matches your own identifier on the underlying checkout session, when present).

starting_afterstring nullable

Cursor for forward pagination — review id from a previous page.

Example:frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Cursor for forward pagination — review id from a previous page.

ending_beforestring nullable

Cursor for backward pagination.

Example:frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Cursor for backward pagination.

limitinteger nullable

Page size, between 1 and 100. Default 20.

Example:10

Page size, between 1 and 100. Default 20.

Response

An envelope wrapping a list of review objects.

Example response

{
  "reviews": [
    {
      "review_id": "frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "charge_id": "fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "reason": "rule",
      "opened_reason": "rule",
      "open": false,
      "test_mode": false,
      "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "created_at": "2026-06-15T14:30:00Z"
    }
  ]
}