/

5 minute read

November 10, 2020

Activity Balances Network Detail

Activities include loading and spending events. You can break out your data by credit and debit types and aggregate the data by day, or break out your data by the type of transaction (load, PIN, or signature) and aggregate the data by a specified type of account. In both cases, you can also specify the level of card network-specific detail. 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 activity data by day (JSON)

Action: GET
Endpoint: /views/activitybalances/day/networkdetail

activitybalances/day/networkdetail?program=stdm

Retrieve activity balance data, broken out by credit and debit types and aggregated by day. This endpoint returns a JSON object that contains an array of records matching your filter query.

Query parameters

Fields Description

expand

string
Optional

Expandable fields for which to retrieve additional details. You can specify any number of expandable fields in a comma-delimited list.

For example, expand=pin_purchases_net breaks out PIN purchases by card network.

Allowable Values:

pin_purchases_net, sig_purchases_net

Sample response body

The following sample shows a representative response for a GET request to the /views/activitybalances/day/network/detail?expand=sig_purchases_net&program=my_program endpoint.

{
    "total": 9,
    "is_more": false,
    "count": 9,
    "info": {},
    "start_date": "2020-11-01T00:00:00+0000",
    "end_date": "2020-11-06T00:00:00+0000",
    "last_run_time": "2019-09-04T16:09:22Z",
    "schema": [
        {
            "field": "starting_balance",
            "type": "numeric(14,2)",
            "description": "The starting balance for a day: Loads_Net + Sig_Purchases_Net + PIN_Purchases_Net + Chargebacks + Transfers + Currency_Fees + Program_Fees",
            "display": "Starting Balance",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "partner_funds_loads_net",
            "type": "numeric(14,2)",
            "description": "The net amount of funds loaded or unloaded usimg a program funding account including any adjustments.",
            "display": "Partner Funds Loads Net",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "direct_deposit_loads_net",
            "type": "numeric(14,2)",
            "description": "The net amount of funds loaded or unloaded via direct deposit including any adjustments.",
            "display": "Direct Deposit Loads Net",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "starting_balance": 10628.01,
            "partner_funds_loads_net": 0.0,
            "direct_deposit_loads_net": 0.0
        },
        {
            "starting_balance": 10618.4,
            "partner_funds_loads_net": 0.0,
            "direct_deposit_loads_net": 0.0
        },

        ...

        {
            "starting_balance": 10604.77,
            "partner_funds_loads_net": 0.0,
            "direct_deposit_loads_net": 0.0
        }
    ]
}

Is this helpful?

Retrieve activity data by day (file export)

Action: GET
Endpoint: /views/activitybalances/day/networkdetail/{export_type}

Retrieve activity balance data, broken out by credit and debit types and 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

expand

string
Optional

Expandable fields for which to retrieve additional details. You can specify any number of expandable fields in a comma-delimited list.

For example, expand=pin_purchases_net breaks out PIN purchases by card network.

Allowable Values:

pin_purchases_net, sig_purchases_net

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body

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

Is this helpful?

Retrieve schema for activity balances by day

Action: GET
Endpoint: /views/activitybalances/day/networkdetail/schema

Retrieve a JSON representation of the activity balance view schema for data broken out by credit and debit types and 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/activitybalances/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": "post_date",
        "type": "date",
        "description": "The date a transaction was posted by the network.",
        "display": "Post Date",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "corrected_post_date",
        "type": "timestamp without time zone",
        "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": "currency",
        "type": "character varying(10)",
        "description": "The abbreviated currency code.",
        "display": "Currency",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "starting_balance",
        "type": "numeric(14,2)",
        "description": "The starting balance for a day: Loads_Net + Sig_Purchases_Net + PIN_Purchases_Net + Chargebacks + Transfers + Currency_Fees + Program_Fees",
        "display": "Starting Balance",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "ach_loads_net",
        "type": "numeric(14,2)",
        "description": "The amount of funds loaded using an ACH bank-to-bank transfer, accounting for adjustments and unloads.",
        "display": "Ach Loads Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "credit_or_debit_card_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of funds loaded onto a Marqeta-issued card via another credit or debit card including adjustments and unloads.",
        "display": "Credit Or Debit Card Loads Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "partner_funds_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of funds loaded or unloaded usimg a program funding account including any adjustments.",
        "display": "Partner Funds Loads Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "jit_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of loads, adjustments, and unloads associated with a JIT Funding transaction.",
        "display": "Jit Loads Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "direct_deposit_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of funds loaded or unloaded via direct deposit including any adjustments.",
        "display": "Direct Deposit Loads Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "mastercard_sig_purchases",
        "type": "numeric(14,2)",
        "description": "The amount of Mastercard signature-based purchases.",
        "display": "Mastercard Sig Purchases",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "mastercard_sig_returns",
        "type": "numeric(14,2)",
        "description": "The amount of Mastercard signature-based returns.",
        "display": "Mastercard Sig Returns",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "visanet_sig_purchases",
        "type": "numeric(14,2)",
        "description": "The amount of VisaNet signature-based purchases.",
        "display": "Visanet Sig Purchases",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "visanet_sig_returns",
        "type": "numeric(14,2)",
        "description": "The amount of VisaNet signature-based returns.",
        "display": "Visanet Sig Returns",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "discover_sig_purchases",
        "type": "numeric(14,2)",
        "description": "The amount of Discover signature-based purchases.",
        "display": "Discover Sig Purchases",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "discover_sig_returns",
        "type": "numeric(14,2)",
        "description": "The amount of Discover signature-based returns.",
        "display": "Discover Sig Returns",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "maestro_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Maestro PIN-based purchases, returns, and acquirer fees.",
        "display": "Maestro Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "cirrus_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Cirrus PIN-based purchases, returns, and acquirer fees.",
        "display": "Cirrus Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "interlink_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Interlink PIN-based purchases, returns, and acquirer fees.",
        "display": "Interlink Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "plus_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of VisaPlus PIN-based purchases, refunds, and acquirer fees.",
        "display": "Plus Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "netdebit_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of VisaNet Debit PIN-based purchases, refunds, and acquirer fees.",
        "display": "Netdebit Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "pulse_pin_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Pulse PIN-based purchases, refunds, and acquirer fees.",
        "display": "Pulse Pin Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "chargebacks",
        "type": "numeric(14,2)",
        "description": "The amount of chargebacks that have completed, usually accompanied by a CASE_WON status.",
        "display": "Chargebacks",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "currency_conversion_fees",
        "type": "numeric(14,2)",
        "description": "The amount of currency conversion fees charged by either MasterCard, Visa, Discover, Maestro, Cirrus, VisaInterlink, VisaPlus, VisaNetDebit or Pulse.",
        "display": "Currency Conversion Fees",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "program_fees",
        "type": "numeric(14,2)",
        "description": "The amount of fees charged to a card holder by a given program. This is usally a fee for participating in a card program.",
        "display": "Program Fees",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "account_funding_transfers",
        "type": "numeric(25,2)",
        "description": null,
        "display": "Account Funding Transfers",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "original_credit_transfers",
        "type": "numeric(25,2)",
        "description": null,
        "display": "Original Credit Transfers",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "ending_balance",
        "type": "numeric(14,2)",
        "description": "The ending balance for a day: Loads_Net + Sig_Purchases_Net + PIN_Purchases_Net + Chargebacks + Transfers + Currency_Fees + Program_Fees",
        "display": "Ending Balance",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "network_loads",
        "type": "numeric(25,2)",
        "description": null,
        "display": "Network Loads",
        "units": null,
        "has_total": false,
        "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.