Skip to main content
GET
List statements
Required scope: STATEMENTS_READ

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Reap-Subproject-Id
string<uuid>

Selects the subproject the request operates on; only accepted with a parent project credential.

Query Parameters

limit
integer
default:20

Maximum number of items to return (1-100, default: 20)

Required range: x <= 100
Examples:

20

50

100

cursor
string

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

type
enum<string>[]

Filter by statement type. Comma-separated for several.

  • CARD_TRANSACTION_FEES: One row per card transaction cost event: settlements, authorizations, refunds and token events with their billed amounts, FX and ATM markups and interchange
Available options:
CARD_TRANSACTION_FEES
status
enum<string>[]

Filter by status. Comma-separated for several.

  • PENDING: Requested; the file is being produced
  • GENERATED: The file is ready to download
  • FAILED: The file could not be produced. Request the statement again
Available options:
PENDING,
GENERATED,
FAILED
origin
enum<string>[]

Filter by who requested the statement. Comma-separated for several.

  • CLIENT: Requested by the client through the API
  • REAP: Produced by Reap on a schedule, such as the monthly statement backing an invoice
Available options:
CLIENT,
REAP
periodFrom
string<date>

Only statements whose period starts on or after this day

periodTo
string<date>

Only statements whose period ends on or before this day

Response

200 - application/json

Response for status 200

items
object[]
required
nextCursor
string | null
required

Cursor for next page, or null if no more items