Settlements
Use this view endpoint to retrieve settlement transaction data at a specified aggregation level.
For example, if you choose an aggregation level of detail, each row represents a single settlement transaction.
The data is derived from the transaction-related messages sent to and from 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.
For in-depth information on this endpoint, see Settlements in Reports In-depth.
Retrieve settlement data (JSON)
Copy section link
Action: GET
Endpoint: /views/settlements/{time_agg}
Retrieve settlements transaction data, aggregated over the specified time period. This endpoint returns a JSON object that contains an array of records matching your filter query.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
time_agg
string
|
Time period over which to aggregate the data. For more information, see Data aggregation levels. Allowable Values: detail, day, week, month |
Retrieve settlement data (file export)
Copy section link
Action: GET
Endpoint: /views/settlements/{time_agg}/{export_type}
Retrieve settlements transaction data, aggregated over the specified time period. 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 |
|---|---|
time_agg
string
|
Time period over which to aggregate the data. For more information, see Data aggregation levels. Allowable Values: detail, day, week, month |
export_type
string
|
File format in which to export the data. Allowable Values: csv |
Query parameters
Copy section link
| Fields | Description |
|---|---|
compress
string
|
Type of file compression for the exported file. Allowable Values: gz, zip Default value: |
Retrieve settlement schema
Copy section link
Action: GET
Endpoint: /views/settlements/{time_agg}/schema
Retrieve a JSON representation of the settlements view schema for data aggregated over the specified time period. The schema object contains an array of objects that describe the available columns and the data type of each column.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
time_agg
string
|
Time period over which to aggregate the data. For more information, see Data aggregation levels. Allowable Values: detail, day, week, month |
Sample response body
Copy section link
The following sample shows a representative response for a GET request to the /views/settlements/detail/schema?program=my_program endpoint.
The schema can vary based on the data aggregation level and the data you are authorized to access (based on the credentials you provide in your request).