Support
/
5 minute read
July 14, 2021

Clearing Detail

Hidden

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

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.

Copied

Is this helpful?

Yes
No

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
Copied

Is this helpful?

Yes
No

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

Copied

Is this helpful?

Yes
No

Feedback on this page?

If you feel we can do anything better, please let our team know.