Skip to main content
Use this view endpoint to retrieve a statements summary for credit accounts. This endpoint retrieves an amalgamation of Credit’s Statement Summary, Statement Payment Info, and Statement Year-to-date objects. Each record encapsulates the data that is associated with an account for these three objects. 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 current statements (JSON)

Action: GET
Endpoint: /views/credit/statements/current Retrieve a current statements summary for the credit accounts in a 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/statements/current?program=my_program&fields=opening_balance,closing_balance,credit_limit endpoint.
JSON
{
  "total": 110,
  "is_more": false,
  "count": 110,
  "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": "opening_balance",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": null,
      "display": "Opening Balance",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "closing_balance",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": null,
      "display": "Closing Balance",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "credit_limit",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": null,
      "display": "Credit Limit",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    }
  ],
  "records": [
    {
      "opening_balance": 3099.4,
      "closing_balance": 3246.07,
      "credit_limit": 5000
    },
    {
      "openng_balance": 6108.1,
      "closing_balance": 6099.4,
      "credit_limit": 10000
    },

    ...

    {
      "opening_balance": 2705.85,
      "closing_balance": 3444.87,
      "credit_limit": 5000
    }
  ]
}

​
Retrieve current statements (file export)

Action: GET
Endpoint: /views/credit/statements/current/{export_type} Retrieve current statements for the credit accounts in a program and export to a 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

FieldsDescription
export_type

string
Required		File format in which to export the data.

Allowable Values:

csv

​
Query parameters

FieldsDescription
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 current statements

Action: GET
Endpoint: /views/credit/statements/current/schema Retrieve a JSON representation of the current statements 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/statements/current/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": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "opening_balance",
        "type": "numeric(14,2)",
        "display": "Opening Balance",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "closing_balance",
        "type": "numeric(14,2)",
        "display": "Closing Balance",
        "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": "available_credit",
        "type": "numeric(14,2)",
        "display": "Available Credit",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "past_due_amount",
        "type": "numeric(14,2)",
        "display": "Past Due Amount",
        "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": "days_in_billing_cycle",
        "type": "integer",
        "display": "Days In Billing Cycle",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "cycle_type",
        "type": "character varying(36)",
        "display": "Cycle Type",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "opening_date",
        "type": "timestamp without time zone",
        "display": "Opening Date",
        "description": null,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "closing_date",
        "type": "timestamp without time zone",
        "display": "Closing Date",
        "description": null,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "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": "new_statement_balance",
        "type": "numeric(14,2)",
        "display": "New Statement Balance",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "minimum_payment_due",
        "type": "numeric(14,2)",
        "display": "Minimum Payment Due",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "payment_due_date",
        "type": "timestamp without time zone",
        "display": "Payment Due Date",
        "description": null,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "payment_cutoff_date",
        "type": "timestamp without time zone",
        "display": "Payment Cutoff Date",
        "description": null,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "three_year_savings",
        "type": "numeric(14,2)",
        "display": "Three Year Savings",
        "description": null,
        "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
    }
]

Related topics

About Credit Account StatementsStatementsAbout Credit AccountsAbout Credit Account Ledger EntriesCredit Ledger Entries