Credit Accounts

Use this view endpoint to retrieve details for all of the credit accounts in a program. This endpoint also provides intra-monthly balance calculations attached to each account, including purchases, interest, fees, credits, and payments, which are updated whenever an activity occurs that might affect the ledger. 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 accounts detail (JSON)

Action: GET
Endpoint: /views/credit/accounts/detail Retrieve credit account details for a given program. 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/credit/accounts/detail?program=my_program&fields=status,current_balance,available_credit endpoint.

JSON

{
    "total": 72,
    "is_more": false,
    "count": 72,
    "info": {},
    "start_date": "2021-04-01T00:00:00+0000",
    "end_date": "2021-04-01T00:00:00+0000",
    "last_run_time": "2021-04-01T00:00:00+0000",
    "schema": [
        {
            "field": "status",
            "type": "TEXT",
            "scale": null,
            "character_maximum_length": 128.0,
            "description": "The program status.",
            "display": "Status",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "current_balance",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": null,
            "display": "Current Balance",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "available_credit",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": null,
            "display": "Available Credit",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "status": "ACTIVE",
            "current_balance": 3246.07,
            "available_credit": 5000
        },
        {
            "status": "ACTIVE",
            "current_balance": 6099.4,
            "available_credit": 10000
        },

        ...

        {
            "status": "ACTIVE",
            "current_balance": 3444.87,
            "available_credit": 5000
        }
    ]
}

Retrieve accounts detail (file export)

Action: GET
Endpoint: /views/credit/accounts/detail/{export_type} Retrieve credit accounts detail for a program and export file. 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

JSON

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

Retrieve schema for accounts detail

Action: GET
Endpoint: /views/credit/accounts/detail/schema Retrieve a JSON representation of the accounts detail view schema. 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/credit/accounts/detail/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

[
    {
        "field": "token",
        "type": "character varying(36)",
        "display": "Token",
        "description": "#N/A",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "name",
        "type": "character varying(255)",
        "display": "Name",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency_code",
        "type": "character varying(3)",
        "display": "Currency Code",
        "description": "The three-number code of the currency.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "status",
        "type": "character varying(128)",
        "display": "Status",
        "description": "The program status.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "type",
        "type": "character varying(128)",
        "display": "Type",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "current_balance",
        "type": "numeric(14,2)",
        "display": "Current Balance",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "available_credit",
        "type": "numeric(14,2)",
        "display": "Available Credit",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "credit_limit",
        "type": "numeric(14,2)",
        "display": "Credit Limit",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "purchases",
        "type": "numeric(14,2)",
        "display": "Purchases",
        "description": "The amount of purchases and any reversals related to settled transactions.",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "interest",
        "type": "numeric(14,2)",
        "display": "Interest",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "fees",
        "type": "numeric(14,2)",
        "display": "Fees",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "credits",
        "type": "numeric(14,2)",
        "display": "Credits",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "payments",
        "type": "numeric(14,2)",
        "display": "Payments",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "created_time",
        "type": "timestamp without time zone",
        "display": "Created Time",
        "description": "The time the ACH verification was created.",
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "report_load_timestamp",
        "type": "timestamp without time zone",
        "display": "Report Load Timestamp",
        "description": "UTC time when the record was loaded into Marqeta's reporting system",
        "date_format": "YYYY-MM-DD",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]

​Retrieve accounts detail (JSON)

​Sample response body

​Retrieve accounts detail (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve schema for accounts detail

​Sample response body

Retrieve accounts detail (JSON)

Sample response body

Retrieve accounts detail (file export)

URL path parameters

Query parameters

Sample response body

Retrieve schema for accounts detail

Sample response body