/
5 minute read
September 15, 2023

Retrieving Credit Disputes

Use this view endpoint to retrieve dispute data for credit accounts in a program in either a detailed or monthly view. 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 disputes detail (JSON)

Action: GET
Endpoint: /views/credit/disputes/detail

Retrieve dispute details for the 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/credit/disputes/detail?program=my_program&fields=status,type,amount endpoint.

JSON
Copied

Is this helpful?

Yes
No

Retrieve disputes detail (file export)

Action: GET
Endpoint: /views/credit/disputes/detail/{export_type}

Retrieve disputes 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

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
Copied

Is this helpful?

Yes
No

Retrieve schema for disputes detail

Action: GET
Endpoint: /views/credit/disputes/detail/schema

Retrieve a JSON representation of the dispute 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/credit/disputes/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
Copied

Is this helpful?

Yes
No

Retrieve disputes by month (JSON)

Action: GET
Endpoint: /views/credit/disputes/month

Retrieve dispute data by month for all credit accounts in a program. This endpoint provides an aggregated sum of all disputes grouped by account and status (WON, LOST, or REVERSED). Active disputes are skipped. For example, if an account has three disputes, with two won and one lost, two records are returned—one record with the sum of all disputes won, and the other with the sum of all disputes lost. 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/credit/disputes/month?program=my_program&fields=status,type,amount endpoint.

JSON
Copied

Is this helpful?

Yes
No

Retrieve disputes by month (file export)

Action: GET
Endpoint: /views/credit/disputes/month/{export_type}

Retrieve disputes data by month 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

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
Copied

Is this helpful?

Yes
No

Retrieve schema for disputes by month

Action: GET
Endpoint: /views/credit/disputes/month/schema

Retrieve a JSON representation of the disputes by month 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/credit/disputes/month/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
Copied

Is this helpful?

Yes
No

Subscribe to our developer newsletter