Skip to main content
POST
Request statement

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"

Idempotency-Key
string
required

Unique key for safely retrying this request. Up to 255 characters; we recommend a UUIDv4. The first request executes and its response is cached; subsequent requests with the same key replay the cached response (24h retention).

Required string length: 1 - 255

Body

type
enum<string>
required

What the statement itemises

Available options:
CARD_TRANSACTION_FEES,
CARD_NON_TRANSACTION_FEES
Example:

"CARD_TRANSACTION_FEES"

period
object
required

Inclusive calendar-day range to cover, UTC. At most 31 days, starting no earlier than 2026-06-01 and ending at least two days before today.

fields
string[]

Columns to include, in file order. Omit for every column of the type.

Minimum array length: 1
Minimum string length: 1
Example:
format
enum<string>
default:CSV

File format

Available options:
CSV
Example:

"CSV"

Response

Statement resource

id
string<uuid>
required

Unique statement identifier

type
enum<string>
required

What the statement itemises

Available options:
CARD_TRANSACTION_FEES,
CARD_NON_TRANSACTION_FEES
Example:

"CARD_TRANSACTION_FEES"

origin
enum<string>
required

Who requested the statement

Available options:
CLIENT,
REAP
Example:

"CLIENT"

status
enum<string>
required

Current statement status

Available options:
PENDING,
GENERATED,
FAILED
Example:

"PENDING"

period
object
required
fields
string[] | null
required

Columns in the file, in order. null means every column of the type.

Example:
format
enum<string>
required

File format

Available options:
CSV
Example:

"CSV"

version
string
required

API version the statement was requested under. Fixes the column definitions the file follows.

Example:

"2025-02-14"

rowCount
integer | null
required

Number of data rows in the file, once generated

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1842

byteSize
integer | null
required

Size of the file in bytes, once generated

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

412034

dataAsOf
string | null
required

ISO 8601 timestamp of how fresh the source data was when the file was produced, when known

Example:

"2025-04-02T03:15:00Z"

generatedAt
string | null
required

ISO 8601 timestamp of when the file became available

Example:

"2025-04-02T03:20:12Z"

createdAt
string
required

ISO 8601 timestamp of creation

Example:

"2025-04-02T03:20:00Z"

updatedAt
string
required

ISO 8601 timestamp of last update

Example:

"2025-04-02T03:20:12Z"