Skip to main content
GET
Get the list of rewards.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer_id
string
required

The id you used to create the given consumer

Query Parameters

amount
number

Filter by amount

Amount of the transaction

bankwire_ref
string

Filter by bankwire_ref

consumer
string

Filter by consumer

Consumer

created_at
string

Filter by created_at

Filtering on date of creation between -- after -- before --

executed_at
string

Filter by executed_at

Execution date of the transaction

page
integer

the page number

Required range: x >= 1
per_page
integer

the number of elements per page

Required range: 1 <= x <= 100
sort
enum<string>

Sort by given attribute

Available options:
amount,
status,
created_at,
executed_at,
consumer,
bankwire_ref,
type,
-amount,
-status,
-created_at,
-executed_at,
-consumer,
-bankwire_ref,
-type
status
enum<string>

Filter by status

Available options:
CANCELLED,
PENDING_VALIDATION,
VALIDATED,
PAID_IN,
PAID_OUT,
ERROR
type
enum<string>

Filtering on reward type

Available options:
CASHBACK,
GIFT

Response

OK

items
object[]
meta
object