> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Program Funding Balances

> Use this view endpoint to retrieve funding balance data about the program account.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

<Note>
  **Note**\
  This endpoint is limited in availability. For more information, contact your Marqeta representative.
</Note>

Use this view endpoint to retrieve funding 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](/diva-api/response-customization/).

<h2 id="_retrieve_program_funding_balances_data_json">
  Retrieve program funding balances data (JSON)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/programbalances/{time_agg}`

Retrieve program funding balance data, aggregated over the specified time period. This endpoint returns a JSON object that contains an array of records matching your filter query.

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                    | Description                                                                                                                                                                                                                      |
| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| time\_agg<br /><br />string<br />Required | Time period over which to aggregate the data. For more information, see <a href="/diva-api/response-customization/#_data_aggregation_levels">Data aggregation levels</a>.<br /><br />**Allowable Values:**<br /><br />day, month |

<h3 id="_sample_response_body">
  Sample response body
</h3>

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.

```json JSON expandable lines wrap theme={null}
{
    "total": 17,
    "is_more": false,
    "count": 17,
    "info": {},
    "start_date": "2023-11-01T00:00:00+0000",
    "end_date": "2023-11-19T00:00:00+0000",
    "last_run_time": "2022-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": "2023-11-20T00:00:00.000Z",
            "beginning_bank_balance": 11878375.63,
            "amount_to_send": 0.0,
            "ending_bank_balance": 11878375.63
        },
        {
            "corrected_post_date": "2023-11-19T00:00:00.000Z",
            "beginning_bank_balance": 13386182.9,
            "amount_to_send": -1507807.27,
            "ending_bank_balance": 11878375.63
        },

        ...

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

<h2 id="_retrieve_program_funding_balances_data_file_export">
  Retrieve program funding balances data (file export)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/programbalances/{time_agg}/{export_type}`

Retrieve program funding 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.

<h3 id="_url_path_parameters_2">
  URL path parameters
</h3>

| Fields                                       | Description                                                                                                                                                                                                                       |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| time\_agg<br /><br />string<br />Required    | Time period over which to aggregate the data. For more information, see <a href="/diva-api/response-customization/#_data_aggregation_levels">Data aggregation levels</a> .<br /><br />**Allowable Values:**<br /><br />day, month |
| export\_type<br /><br />string<br />Required | File format in which to export the data.<br /><br />**Allowable Values:**<br /><br />csv                                                                                                                                          |

<h3 id="_query_parameters">
  Query parameters
</h3>

| Fields                                   | Description                                                                                                                               |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| compress<br /><br />string<br />optional | Type of file compression for the exported file.<br /><br />**Allowable Values:**<br /><br />gz, zip<br /><br />**Default value:**<br />gz |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/programbalances/day/csv?program=my_program` endpoint.

```json JSON lines wrap theme={null}
{
    "token": "111122226c444d8888888a9999ae11111db63db5.csv.gz"
}
```

<h2 id="_retrieve_schema_for_program_funding_balances">
  Retrieve schema for program funding balances
</h2>

**Action:** `GET`\
**Endpoint:** `/views/programbalances/{time_agg}/schema`

Retrieve a JSON representation of the program funding 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.

<h3 id="_url_path_parameters_3">
  URL path parameters
</h3>

| Fields                                    | Description                                                                                                                                                                                                                       |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| time\_agg<br /><br />string<br />Required | Time period over which to aggregate the data. For more information, see <a href="/diva-api/response-customization/#_data_aggregation_levels">Data aggregation levels</a> .<br /><br />**Allowable Values:**<br /><br />day, month |

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

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

```json JSON expandable lines wrap theme={null}
[
    {
        "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
    }
]
```


## Related topics

- [2022 Release Notes](/docs/developer-guides/release-notes-2022.md)
- [Reports In-depth](/docs/developer-guides/reports-in-depth.md)
- [Activity Balances Funding Day](/docs/diva-api/activity-balances-funding-day.md)
- [Program Funding Sources](/docs/core-api/program-funding-sources.md)
- [Program Gateway Funding Sources](/docs/core-api/program-gateway-funding-sources.md)
