Skip to main content
GET
List Statements
The Rewards Statements API replaces this endpoint.New customers should use List Rewards Statements instead.
OAuth Scope

Authorizations

Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

Learn more in the API credentials guide โ†’

Query Parameters

customer_id
string

customer_id is a required field.

ref_ids
string[]

Optionally filter by the ref_ids of the statements.

statement_ids
string[]

Optionally filter by the ids of the statements.

statuses
enum<string>[]

Optionally filter by the statuses of the statements to be returned. Defaults to all statuses.

Available options:
STATEMENT_STATUS_UNSPECIFIED,
STATEMENT_STATUS_INITIATED,
STATEMENT_STATUS_GENERATED,
STATEMENT_STATUS_PAID
limit
integer<int32>

Number of results to return. Defaults to 100.

order
enum<string>

Sort order for the results by period start, defaults to DESC if not provided.

Available options:
DESC,
ASC
page_cursor
string

Cursor for getting the next page of results.

Response

200 - application/json

Successfully retrieve statements

statements
object[]
next_page_cursor
string