Support
/
5 minute read
February 22, 2021

Program Reserve Balances

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

Use this view endpoint to compare your program account balances against the program reserve requirement. This endpoint is available only for programs that have a reserve requirement. The data is derived from the balance-related activity on the Marqeta platform. If the reserve is not met, the amount owed is shown in the reserve_owed_amount field.

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 reserve balances data (JSON)

Action: GET
Endpoint: /views/programreservebalances/day

Retrieve program reserve balances data aggregated by day. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/programreservebalances/day?program=my_program&fields=corrected_post_date,amount_to_send,reserve_requirement_amount,reserve_owed_amount endpoint.

Copied

Is this helpful?

Yes
No

Retrieve program reserve balances data (file export)

Action: GET
Endpoint: /views/programreservebalances/day/{export_type}

Retrieve program reserve balances data 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
Fields Description

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/programreservebalances/day/csv?program=my_program endpoint.

Copied

Is this helpful?

Yes
No

Retrieve schema for program reserve balances

Action: GET
Endpoint: /views/programreservebalances/day/schema

Retrieve a JSON representation of the program reserve balances view schema for data 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

The following sample shows a representative response for a GET request to the /views/programreservebalances/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.