DOCS

New!

/

5 minute read

February 3, 2020

Program Balances

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.

{
    "total": 17,
    "is_more": false,
    "count": 17,
    "info": {},
    "start_date": "2019-11-01T00:00:00+0000",
    "end_date": "2019-11-19T00: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": "beginning_bank_balance",
            "type": "numeric(14,2)",
            "description": "#N/A",
            "display": "Beginning Bank Balance",
            "units": "USD",
            "has_total": true,
            "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
        }
    ],
    "records": [
        {
            "corrected_post_date": "2019-11-20T00:00:00.000Z",
            "beginning_bank_balance": 11878375.63,
            "amount_to_send": 0.0,
            "ending_bank_balance": 11878375.63
        },
        {
            "corrected_post_date": "2019-11-19T00:00:00.000Z",
            "beginning_bank_balance": 13386182.9,
            "amount_to_send": -1507807.27,
            "ending_bank_balance": 11878375.63
        },

        ...

        {
            "corrected_post_date": "2019-11-04T00:00:00.000Z",
            "beginning_bank_balance": 6382613.97,
            "amount_to_send": -2991341.36,
            "ending_bank_balance": 8050308.79
        }
    ]
}

Is this helpful?

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.

{
    "token":"111122226c444d8888888a9999ae11111db63db5.csv.gz"
}

Is this helpful?

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

[
    {
        "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": "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": "beginning_bank_balance",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Beginning Bank Balance",
        "units": "USD",
        "has_total": true,
        "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": "deposit",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Deposit",
        "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": "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.