> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Clearing Detail

> Use this view endpoint to retrieve clearing details.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

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](/diva-api/response-customization/).

<h2 id="_retrieve_clearing_detail_data_json">
  Retrieve clearing detail data (JSON)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/clearing/detail`

```json JSON expandable lines wrap theme={null}
  {
     "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.

<h3 id="_sample_response_body">
  Sample response body
</h3>

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.

<h2 id="_retrieve_clearing_detail_data_file_export">
  Retrieve clearing detail data (file export)
</h2>

**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.

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                       | Description                                                                              |
| -------------------------------------------- | ---------------------------------------------------------------------------------------- |
| export\_type<br /><br />string<br />Required | File format in which to export the data.<br /><br />**Allowable Values:**<br /><br />csv |

<h3 id="_query_parameters">
  Query parameters
</h3>

| Fields                                   | Description                                                                                                                               |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| compress<br /><br />string<br />optional | Type of file compression for the exported file.<br /><br />**Allowable Values:**<br /><br />gz, zip<br /><br />**Default value:**<br />gz |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}
```

<h2 id="_retrieve_clearing_detail_schema">
  Retrieve clearing detail schema
</h2>

**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.

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

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).


## Related topics

- [Data Products and Insights](/docs/developer-guides/data-products-and-insights.md)
- [Reports In-depth](/docs/developer-guides/reports-in-depth.md)
- [JIT Funding Reports](/docs/developer-guides/jit-funding-reports.md)
- [Exploring the DiVA API](/docs/diva-api/exploring-the-diva-api.md)
- [Settlement and Reconciliation in Europe](/docs/developer-guides/mq-eu-settlement-reconciliation.md)
