DOCS

New!

/

5 minute read

March 1, 2020

Activity Balances

Use this view endpoint to retrieve activity balance data. 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

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?expand=sig_purchases_net&program=my_program endpoint.

{
    "total": 31,
    "is_more": false,
    "count": 31,
    "info": {},
    "start_date": "2019-10-22T00:00:00+0000",
    "end_date": "2019-11-21T00:00:00+0000",
    "last_run_time": "2019-09-04T16:09:22Z",
    "schema": [
        {
            "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": "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": "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
        }
    ],
    "records": [
        {
            "post_date": "2019-11-21T00:00:00.000Z",
            "corrected_post_date": "2019-11-21T00:00:00.000Z",
            "starting_balance": -296099.4,
            "ending_balance": -295246.07
        },
        {
            "post_date": "2019-11-20T00:00:00.000Z",
            "corrected_post_date": "2019-11-20T00:00:00.000Z",
            "starting_balance": -296108.1,
            "ending_balance": -296099.4
        },

        ...

        {
            "post_date": "2019-10-22T00:00:00.000Z",
            "corrected_post_date": "2019-10-22T00:00:00.000Z",
            "starting_balance": -295905.85,
            "ending_balance": -295444.87
        }
    ]
}

Is this helpful?

Retrieve activity data by day (file export)

Action: GET
Endpoint: /views/activitybalances/day/{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/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": "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": "marqeta_funds_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Marqeta loads, adjustments, and unloads.",
        "display": "Marqeta Funds 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": "sig_purchases_net",
        "type": "numeric(14,2)",
        "description": "The amount of signature based purchase transactions less returns, defined by transactions having funds flow through a MasterCard, Visanet or Discover account.",
        "display": "Sig Purchases Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "pin_purchases_net",
        "type": "numeric(14,2)",
        "description": "The net amount of PIN-based purchases, refunds, and acquirer fees on Maestro, Cirrus, Visa Interlink, VisaPlus, VisaNet Debit, or Pulse.",
        "display": "Pin Purchases Net",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "pending_chargebacks",
        "type": "numeric(14,2)",
        "description": "The amount of pending chargebacks–funds are put in a holding account until the chargeback is completed.",
        "display": "Pending Chargebacks",
        "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": "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
    }
]

Is this helpful?

Retrieve activity data by account (JSON)

Action: GET
Endpoint: /views/activitybalances/{account_agg}

Retrieve activity balance data, broken out by type of transaction (load, PIN, or signature) and aggregated by the specified type of account. This endpoint returns a JSON object that contains an array of records matching your filter query.

URL path parameters

Fields Description

account_agg

string
Required

Type of account for which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values: actor, accountholder, business

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/actor?count=2&program=my_program?&fields=account_type,ach_loads_net,net_balance_activity,ending_balance endpoint.

{
    "total": 2,
    "is_more": false,
    "count": 2,
    "info": {},
    "start_date": "2019-11-01T00:00:00+0000",
    "end_date": "2019-11-22T00:00:00+0000",
    "last_run_time": "2019-11-22T00:11:15Z",
    "schema": [
        {
            "field": "account_type",
            "type": "character varying(64)",
            "description": "The type of the account: business, parent, child.",
            "display": "Account Type",
            "units": null,
            "has_total": false,
            "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": "net_balance_activity",
            "type": "numeric(14,2)",
            "description": "#N/A",
            "display": "Net Balance Activity",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "ending_balance",
            "description": "Ending Balance",
            "type": "numeric(14,2)",
            "display": "Ending Balance",
            "has_total": true,
            "units": "USD",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "account_type": null,
            "ach_loads_net": 0.0,
            "net_balance_activity": 0.0,
            "ending_balance": 0.0
        },
        {
            "account_type": "Parent",
            "ach_loads_net": 0.0,
            "net_balance_activity": 852.18,
            "ending_balance": 0.0
        }
    ]
}

Is this helpful?

Retrieve activity data by account (file export)

Action: GET
Endpoint: /views/activitybalances/{account_agg}/{export_type}

Retrieve activity balance data, broken out by type of transaction (load, PIN, or signature) and aggregated by the specified type of account. 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

account_agg

string
Required

Type of account for which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values: actor , accountholder , business

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":"e32112160c9b0b83dd82748b10a9df46d1d75b2a.csv.gz"
}

Is this helpful?

Retrieve schema for activity balances by account

Action: GET
Endpoint: /views/activitybalances/{account_agg}/schema

Retrieve a JSON representation of the activity balance view schema for data broken out by the type of transaction (load, PIN, or signature) and aggregated by the specified type of account. 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

account_agg

string
Required

Account for which to aggregate the data. For more information, see Data aggregation levels.

Allowable Values: actor, accountholder, business

Sample response body

The following sample shows a representative response for a GET request to the /views/activitybalances/actor/schema?program=my_program endpoint. The schema can vary based on the data aggregation level and 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": "acting_user_token",
        "type": "character varying(128)",
        "description": "The unique user token of a card holder. This can be seen in the user view and transaction level views.",
        "display": "Acting User Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "acting_uai",
        "type": "character varying(128)",
        "description": "The unique account identifier (UAI) for an acting card holder account within a bank; unique across programs.",
        "display": "Acting Uai",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "parent_user_token",
        "type": "character varying(128)",
        "description": "The unique user token identifying the parent of the user or business account.",
        "display": "Parent User Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "parent_uai",
        "type": "character varying(128)",
        "description": "The unique account identifier (UAI) for the parent of the user or business account.",
        "display": "Parent Uai",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "business_name",
        "type": "character varying(128)",
        "description": "The name of the business associated with a card holder, acting card holder, or business account.",
        "display": "Business Name",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "business_user_token",
        "type": "character varying(128)",
        "description": "The business token associated with an acting card holder or parent card holder.",
        "display": "Business User Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "business_uai",
        "type": "character varying(128)",
        "description": "The unique account identifier (UAI) for the business account within a bank; unique across programs.",
        "display": "Business Uai",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_type",
        "type": "character varying(64)",
        "description": "The type of the account: business, parent, child.",
        "display": "Account Type",
        "enum_values": [
            "Business",
            "Child",
            "Parent",
            "UNKNOWN"
        ],
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_user_token",
        "type": "character varying(128)",
        "description": "The unique user token for the associated user account.",
        "display": "Account User Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_uai",
        "type": "character varying(128)",
        "description": "The unique account identifier (UAI) for an account within a bank; unique across programs.",
        "display": "Account Uai",
        "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": "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": "marqeta_funds_loads_net",
        "type": "numeric(14,2)",
        "description": "The net amount of Marqeta loads, adjustments, and unloads.",
        "display": "Marqeta Funds 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": "sig_purchases_net",
        "type": "numeric(14,2)",
        "description": "The amount of signature based purchase transactions less returns, defined by transactions having funds flow through a MasterCard, Visanet or Discover account.",
        "display": "Sig Purchases 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": "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": "net_balance_activity",
        "type": "numeric(14,2)",
        "description": "#N/A",
        "display": "Net Balance Activity",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "ending_balance",
        "description": "Ending Balance",
        "type": "numeric(14,2)",
        "display": "Ending Balance",
        "has_total": true,
        "units": null,
        "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.