/

5 minute read

February 19, 2020

Program Reserve Balances

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.

{
    "total": 17,
    "is_more": false,
    "count": 17,
    "info": {},
    "start_date": "2019-11-01T00:00:00+0000",
    "end_date": "2019-11-22T00:00:00+0000",
    "last_run_time": "2018-08-27T16:08:03Z",
    "schema": [
        {
            "field": "corrected_post_date",
            "type": "date",
            "description": "A transaction date that accounts for potential adjustments, allowing balances to be calculated across a single date range. For most cases, Corrected Post Date and Post Date are identical. When different, Corrected Post Date represents the correct reporting date, and Post Date represents when the transaction was posted to the Marqeta ledger.",
            "display": "Corrected Post Date",
            "units": null,
            "has_total": false,
            "date_format": "YYYY-MM-DD",
            "is_filter_only": false
        },
        {
            "field": "amount_to_send",
            "type": "numeric(14,2)",
            "description": "The net amount of partner funds and JIT Funding loads: (Partner Funds Loads + Partner Funds Unloads + Partner Funds Adjustments) + (JIT Loads + JIT Unloads + JIT Adjustments)",
            "display": "Amount To Send",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "reserve_requirement_amount",
            "type": "numeric(14,2)",
            "description": "#N/A",
            "display": "Reserve Requirement Amount",
            "units": "USD",
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "reserve_owed_amount",
            "type": "numeric(14,2)",
            "description": "#N/A",
            "display": "Reserve Owed Amount",
            "units": "USD",
            "has_total": false,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "corrected_post_date": "2019-11-23T00:00:00.000Z",
            "amount_to_send": 0.0,
            "reserve_requirement_amount": 7639941.25,
            "reserve_owed_amount": 0.0
        },
        {
            "corrected_post_date": "2019-11-22T00:00:00.000Z",
            "amount_to_send": -1702955.81,
            "reserve_requirement_amount": 8946315.23,
            "reserve_owed_amount": 0.0
        },

        ...

        {
            "corrected_post_date": "2019-11-07T00:00:00.000Z",
            "amount_to_send": -3484361.68,
            "reserve_requirement_amount": 8857451.45,
            "reserve_owed_amount": 0.0
        }
    ]
}

Is this helpful?

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.

{
    "token":"cc57379c686e9cfe064ebc421346173632907c88.csv.gz"
}

Is this helpful?

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).

[
    {
        "field": "program",
        "type": "character varying(128)",
        "description": "The name of the card program.",
        "display": "Program",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "bank",
        "type": "character varying(128)",
        "description": "The bank under which the program operates.",
        "display": "Bank",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "corrected_post_date",
        "type": "date",
        "description": "A transaction date that accounts for potential adjustments, allowing balances to be calculated across a single date range. For most cases, Corrected Post Date and Post Date are identical. When different, Corrected Post Date represents the correct reporting date, and Post Date represents when the transaction was posted to the Marqeta ledger.",
        "display": "Corrected Post Date",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "corrected_note_flag",
        "type": "integer",
        "description": null,
        "display": "Corrected Note Flag",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "day_of_week",
        "type": "character varying(10)",
        "description": "#N/A",
        "display": "Day Of Week",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency",
        "type": "character varying(10)",
        "description": "The abbreviated currency code.",
        "display": "Currency",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency_code",
        "type": "integer",
        "description": "The three-number code of the currency.",
        "display": "Currency Code",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "amount_to_send",
        "type": "numeric(14,2)",
        "description": "The net amount of partner funds and JIT Funding loads: (Partner Funds Loads + Partner Funds Unloads + Partner Funds Adjustments) + (JIT Loads + JIT Unloads + JIT Adjustments)",
        "display": "Amount To Send",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "ending_bank_balance",
        "type": "numeric(14,2)",
        "description": "",
        "display": "Ending Bank Balance",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "reserve_requirement_description",
        "type": "character varying(64)",
        "description": "#N/A",
        "display": "Reserve Requirement Description",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reserve_minimum_amount",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Reserve Minimum Amount",
        "units": "USD",
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reserve_avg_week_amount",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Reserve Avg Week Amount",
        "units": "USD",
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reserve_days_amount",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Reserve Days Amount",
        "units": "USD",
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reserve_requirement_amount",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Reserve Requirement Amount",
        "units": "USD",
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reserve_owed_amount",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Reserve Owed Amount",
        "units": "USD",
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "last_modified_time",
        "type": "timestamp without time zone",
        "description": "The date when the record was most recently updated.",
        "display": "Last Modified Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    }
]

Is this helpful?

Have any feedback on this page?

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

We strive for the best possible developer experience.