Clearing Detail - Marqeta Docs

Use this view endpoint to retrieve clearing details. A single clearing transaction message, identified by the transaction_token, is represented in several rows, with one row for each accounting layer. There are typically three transentry_token entries for every transaction_token, with an entry for purchase, cross-border fees, and currency conversion fees. The accounting layer for each entry is identified by the account_group field. Each record includes an initiating_transaction_token value, which corresponds to the initial authorization record. The corresponding initial authorization record can be found in the Authorizations Detail report by filtering for a transaction_token that matches the initiating_transaction_token value for the clearing record. The data is derived from the transaction-related messages sent to and from 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 clearing detail data (JSON)

Action: GET
Endpoint: /views/clearing/detail

JSON

  {
     "total": 31098,
     "is_more": true,
     "count": 10000,
     "info": {},
     "start_date": "2019-05-01T00:00:00+0000",
     "end_date": "2019-05-23T00:00:00+0000",
     "last_run_time": "2019-05-23T15:05:57Z",
     "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": "currency_conversion_fees",
             "type": "numeric(38,2)",
             "description": "The amount of currency conversion fees charged by either Mastercard, Visa, Discover, Maestro, Cirrus, VisaInterlink, VisaPlus, VisaNetDebit or Pulse.",
             "display": "Currency Conversion Fees",
             "units": "USD",
             "has_total": true,
             "is_filter_only": false
         }
     ],
     "records": [
         {
             "post_date": "2019-05-23T00:00:00.000Z",
             "currency_conversion_fees": 0
         },
         {
             "post_date": "2019-05-23T00:00:00.000Z",
             "currency_conversion_fees": 0
         },

         …

         {
             "post_date": "2019-05-23T00:00:00.000Z",
             "currency_conversion_fees": 0
         }
     ]
 }

Retrieve clearing detail data. 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/clearing/day?program=my_program&fields=post_date,currency_conversion_fees endpoint.

Retrieve clearing detail data (file export)

Action: GET
Endpoint: /views/clearing/detail/{export_type} Retrieve clearing detail data. 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 clearing detail schema

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

​Retrieve clearing detail data (JSON)

​Sample response body

​Retrieve clearing detail data (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve clearing detail schema

​Sample response body

Retrieve clearing detail data (JSON)

Sample response body

Retrieve clearing detail data (file export)

URL path parameters

Query parameters

Sample response body

Retrieve clearing detail schema

Sample response body