Skip to main content
Warning
This page is currently deprecated and the functionality it describes will soon be unavailable. To learn more, contact your Marqeta representative.
This feature will be replaced by journal entries. For documentation on journal entries, see: Use this view endpoint to retrieve all of the ledger entries for the credit accounts in a program. 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 ledger entries detail (JSON)

Action: GET
Endpoint: /views/credit/ledgerentries/detail Retrieve ledger entries detail for all 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/ledgerentries/detail?program=my_program&fields=post_date,currency,amount_to_send endpoint.
JSON
{
  "total": 96,
  "is_more": false,
  "count": 96,
  "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": 7.0,
      "description": "The program status.",
      "display": "Status",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "type",
      "type": "TEXT",
      "scale": null,
      "character_maximum_length": 128.0,
      "description": null,
      "display": "Type",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "amount",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": "#N/A",
      "display": "Amount",
      "units": null,
      "has_total": true,
      "is_filter_only": false
    }
  ],
  "records": [
    {
      "status": 3099.4,
      "type": 3246.07,
      "amount": 5000
    },
    {
      "status": 6108.1,
      "type": 6099.4,
      "amount": 10000
    },

    ...

    {
      "status": 2705.85,
      "type": 3444.87,
      "amount": 5000
    }
  ]
}

​
Retrieve ledger entries detail (file export)

Action: GET
Endpoint: /views/credit/ledgerentries/detail/{export_type} Retrieve ledger entries detail for all 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 ledger entries detail

Action: GET
Endpoint: /views/credit/ledgerentries/detail/schema Retrieve a JSON representation of the ledger entries 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/ledgerentries/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": "TEXT",
    "scale": null,
    "character_maximum_length": 36.0,
    "description": "#N/A",
    "display": "Token",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "transaction_id",
    "type": "TEXT",
    "scale": null,
    "character_maximum_length": 36.0,
    "description": null,
    "display": "Transaction Id",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "account_token",
    "type": "TEXT",
    "scale": null,
    "character_maximum_length": 36.0,
    "description": null,
    "display": "Account Token",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "status",
    "type": "TEXT",
    "scale": null,
    "character_maximum_length": 7.0,
    "description": "The program status.",
    "display": "Status",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "type",
    "type": "TEXT",
    "scale": null,
    "character_maximum_length": 128.0,
    "description": null,
    "display": "Type",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "amount",
    "type": "NUMBER",
    "scale": 2.0,
    "character_maximum_length": null,
    "description": "#N/A",
    "display": "Amount",
    "units": "USD",
    "has_total": true,
    "is_filter_only": false
  },
  {
    "field": "currency_code",
    "type": "TEXT",
    "scale": null,
    "character_maximum_length": 3.0,
    "description": "The three-number code of the currency.",
    "display": "Currency Code",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "created_time",
    "type": "TIMESTAMP_NTZ",
    "scale": null,
    "character_maximum_length": null,
    "description": "The time the ACH verification was created.",
    "display": "Created Time",
    "units": null,
    "has_total": false,
    "date_format": "YYYY-MM-DD HH:mm:ss",
    "is_filter_only": false
  }
]

Related topics

About Credit Account Ledger EntriesLedger EntriesAbout Credit Account Journal EntriesCredit Journal EntriesAbout Credit Account Statements