Skip to main content
Use this view endpoint to retrieve all the journal 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 journal entries detail (JSON)

Action: GET
Endpoint: /views/credit/journalentries/detail
Retrieve journal 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/journalentries/detail?program=my_program&fields=status,amount,created_time 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": "character varying(7)",
            "display": "Status",
            "description": "The program status.",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "amount",
            "type": "numeric(14,2)",
            "display": "Amount",
            "description": "#N/A",
            "units": "USD",
            "has_total": true,
            "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
        }
    ],
    "records": [
        {
            "status": "POSTED",
            "amount": "5000.5",
            "created_time": "2022-07-29T15:59:41.909Z"
        },
        {
            "status": "POSTED",
            "amount": "6099.4",
            "created_time": "2022-07-20T15:36:01.909Z"
        },

        ...

        {
            "status": "POSTED",
            "amount": "299.5",
            "created_time": "2022-08-20T15:39:49.909Z"
        }
    ]
}

Retrieve journal entries detail (file export)

Action: GET
Endpoint: /views/credit/journalentries/detail/{export_type}
Retrieve journal 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 journal entries detail

Action: GET
Endpoint: /views/credit/journalentries/detail/schema
Retrieve a JSON representation of the journal 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/journalentries/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": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "card_token",
        "type": "character varying(36)",
        "display": "Card Token",
        "description": "The token of the card; unique within a program.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "status",
        "type": "character varying(7)",
        "display": "Status",
        "description": "The program status.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "amount",
        "type": "numeric(14,2)",
        "display": "Amount",
        "description": "#N/A",
        "units": "USD",
        "has_total": true,
        "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": "settlement_date",
        "type": "timestamp without time zone",
        "display": "Settlement Date",
        "description": "A date field sourced from the Networks or relevant financial service which reflects when they settled the transaction event.",
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "detail_token",
        "type": "character varying(36)",
        "display": "Detail Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_token",
        "type": "character varying(128)",
        "display": "User Token",
        "description": "A unique identifier (within a given Marqeta Card Program) for a user record. All other references to a user token will be prefaced with account, business, parent or acting to specify which user token is referenced.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "journal_group",
        "type": "character varying(128)",
        "display": "Journal Group",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "journal_entry_type",
        "type": "character varying(128)",
        "display": "Journal Entry Type",
        "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
    }
]