Activity Balances
Use this view endpoint to retrieve activity balance data. Activities include loading and spending events. You can break out your data by credit and debit types and aggregate the data by day, or break out your data by the type of transaction (load, PIN, or signature) and aggregate the data by actor. In both cases, you can also specify the level of card network-specific detail. The data is derived from the balance-related activity on the Marqeta platform.
This endpoint supports multiple response formats, query filtering, field filtering, sorting, pagination, and currency conversion. For more information about response options, see Response Customization.
Retrieve activity data by day (JSON)
Copy section link
Action: GET
Endpoint: /views/activitybalances/day
Retrieve activity balance data, broken out by credit and debit types and aggregated by day. This endpoint returns a JSON object that contains an array of records matching your filter query.
Query parameters
Copy section link
| Fields | Description |
|---|---|
expand
string
|
Expandable fields for which to retrieve additional details. You can specify any number of expandable fields in a comma-delimited list. For example, Allowable Values:
|
Retrieve activity data by day (file export)
Copy section link
Action: GET
Endpoint: /views/activitybalances/day/{export_type}
Retrieve activity balance data, broken out by credit and debit types and aggregated by day. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
export_type
string
|
File format in which to export the data. Allowable Values: csv |
Query parameters
Copy section link
| Fields | Description |
|---|---|
expand
string
|
Expandable fields for which to retrieve additional details. You can specify any number of expandable fields in a comma-delimited list. For example, Allowable Values:
|
compress
string
|
Type of file compression for the exported file. Allowable Values: gz, zip Default value: |
Retrieve schema for activity balances by day
Copy section link
Action: GET
Endpoint: /views/activitybalances/day/schema
Retrieve a JSON representation of the activity balance view schema for data broken out by credit and debit types and aggregated by day. The schema object contains an array of objects that describe the available columns and the data type of each column.
Sample response body
Copy section link
The following sample shows a representative response for a GET request to the /views/activitybalances/day/schema?program=my_program endpoint.
The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).