Program Balances Settlement
Note
This endpoint is limited in availability. For more information, contact your Marqeta representative.Retrieve balance data based on settlements for the program account. Each row represents the balance data, including bank balance and the amount to transfer to fund your program, at a specified aggregation level. 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 program balances settlement data (JSON)
Copy section link
Action: GET
Endpoint: /views/programbalancessettlement/{time_agg}
Retrieve program balances settlement 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: day, month |
Sample response body
Copy section link
The following sample shows a representative response for a GET request to the /views/programbalancessettlement/day?program=my_program&fields=corrected_post_date,beginning_bank_balance,partner_funds_loads_net,deposit,ending_bank_balance endpoint.
Retrieve program balances settlement data (file export)
Copy section link
Action: GET
Endpoint: /views/programbalancessettlement/{time_agg}/{export_type}
Retrieve program balances settlement 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: day, 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 schema for program balances settlement
Copy section link
Action: GET
Endpoint: /views/programbalancessettlement/{time_agg}/schema
Retrieve a JSON representation of the program balances settlement view schema. 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/programbalancessettlement/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).