Marqeta.com
Support
/
5 minute read
December 18, 2020

Program Balances

Note
This endpoint is limited in availability. For more information, contact your Marqeta representative.

Use this view endpoint to retrieve balance data about the program account. Each row represents the net loads against the program account 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 data (JSON)

Action:

GET

Endpoint:
/views/programbalances/{time_agg}

Retrieve program balance 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
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, month

Sample response body

The following sample shows a representative response for a

GET
request to the
/views/programbalances/day?program=my_program&fields=corrected_post_date,beginning_bank_balance,amount_to_send,ending_bank_balance
endpoint.

Copied

Is this helpful?

Yes
No

Retrieve program balances data (file export)

Action:

GET

Endpoint:
/views/programbalances/{time_agg}/{export_type}

Retrieve program balance 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
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, month

export_type

string
Required

File format in which to export the data.

Allowable Values:

csv

Query parameters
Fields Description

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body

The following sample shows a representative response for a

GET
request to the
/views/programbalances/day/csv?program=my_program
endpoint.

Copied

Is this helpful?

Yes
No

Retrieve schema for program balances

Action:

GET

Endpoint:
/views/programbalances/{time_agg}/schema

Retrieve a JSON representation of the program balance 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
Fields Description

time_agg

string
Required

Time period over which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values:

day, month

Sample response body

The following sample shows a representative response for a

GET
request to the
/views/programbalances/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).

Copied

Is this helpful?

Yes
No

Feedback on this page?

If you feel we can do anything better, please let our team know.