List Transactions
Header Parameters
X-Request-Idstring
Optional correlation ID associated with the request.
Authorizationstring
Query Parameters
plan_year_idstring Required
Filter by plan year ID. Required
plan_idstring
Filter by plan ID
number_of_transactionsinteger
Maximum number of transactions to be returned by plan(default: 200).
Default value
200
start_datestring
The start date to fetch transactions for. Required if number_of_transactions is 0.
end_datestring
The end date to fetch transactions for. Required if number_of_transactions is 0.
include_running_balanceboolean
Determines if the running balance will be included in the response call.
Default value
false
page_sizeinteger
Maximum number of items to return (default 20, max 100)
Minimum
1
Maximum
100
Default value
20
pageinteger
Page number starting with 0
Default value
0
Path Parameters
consumer_idstring Required
Filter by consumer ID. Required.
Response
200
Object
Transactions retrieved successfully.
Response Attributes
itemsarray Required
The list of data items for the current page.
Max items
100
Show child attributes
paginationobject Required
Show child attributes
400
Object
Bad Request
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
Not Found
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal Server Error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?