Skip to main content
GET
List the payments that paid a consumer's rewards out to their bank account.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Path Parameters

consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"consumer-12345"

Query Parameters

page
integer
default:1
Required range: x >= 1
per_page
integer
default:50
Required range: 1 <= x <= 1000
sort
enum<string>
default:-created_at

Sort field, prefixed by - for descending (e.g. -created_at).

Available options:
created_at,
-created_at
Example:

"-created_at"

status
enum<string>[] | null

Filter on one or several payment statuses.

Available options:
PENDING,
SUCCEEDED,
FAILED
Example:

Response

Successful Response

items
RewardPaymentSchema · object[]
required
meta
PageMeta · object
required