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

{
    "total": 0,
    "is_more": false,
    "count": 0,
    "info": {},
    "start_date": null,
    "end_date": null,
    "last_run_time": "",
    "schema": [
        {
            "field": "status",
            "type": "TEXT",
            "scale": null,
            "character_maximum_length": 7.0,
            "description": "The program status.",
            "display": "Status",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "type",
            "type": "TEXT",
            "scale": null,
            "character_maximum_length": 128.0,
            "description": null,
            "display": "Type",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "amount",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": "#N/A",
            "display": "Amount",
            "units": null,
            "has_total": true,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "status": 3099.4,
            "type": 3246.07,
            "amount": 5000
        },
        {
            "status": 6108.1,
            "type": 6099.4,
            "amount": 10000
        },

        ...

        {
            "status": 2705.85,
            "type": 3444.87,
            "amount": 5000
        }
    ]
}

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

{
    "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

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

[
    {
        "field": "token",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 36.0,
        "description": "#N/A",
        "display": "Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_id",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 36.0,
        "description": null,
        "display": "Transaction Id",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_token",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 36.0,
        "description": null,
        "display": "Account Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "status",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 7.0,
        "description": "The program status.",
        "display": "Status",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "type",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 128.0,
        "description": null,
        "display": "Type",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "amount",
        "type": "NUMBER",
        "scale": 2.0,
        "character_maximum_length": null,
        "description": "#N/A",
        "display": "Amount",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "currency_code",
        "type": "TEXT",
        "scale": null,
        "character_maximum_length": 3.0,
        "description": "The three-number code of the currency.",
        "display": "Currency Code",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "created_time",
        "type": "TIMESTAMP_NTZ",
        "scale": null,
        "character_maximum_length": null,
        "description": "The time the ACH verification was created.",
        "display": "Created Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "is_filter_only": false
    }
]

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

{
    "total": 54,
    "is_more": false,
    "count": 54,
    "info": {},
    "start_date": null,
    "end_date": null,
    "last_run_time": "",
    "schema": [
        {
            "field": "total_amount",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": null,
            "display": "Total Amount",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "status",
            "type": "TEXT",
            "scale": null,
            "character_maximum_length": 36.0,
            "description": "The program status.",
            "display": "Status",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "month_key",
            "type": "DATE",
            "scale": null,
            "character_maximum_length": null,
            "description": null,
            "display": "Month Key",
            "units": null,
            "has_total": false,
            "date_format": "YYYY-MM",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "total_amount": 99.4,
            "status": "ACTIVE",
            "month_key": "2021-05"
        },
        {
            "total_amount": 276.1,
            "status": "ACTIVE",
            "month_key": "2021-05"
        },

        ...

        {
            "total_amount": 290.85,
            "status": "ACTIVE",
            "month_key": "2021-05"
        }
    ]
}

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

{
    "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

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

[
    {
        "field": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "total_amount",
        "type": "numeric(14,2)",
        "display": "Total Amount",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "status",
        "type": "character varying(36)",
        "display": "Status",
        "description": "The program status.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "month_key",
        "type": "date",
        "display": "Month Key",
        "description": null,
        "date_format": "YYYY-MM",
        "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
    }
]

​Retrieve disputes detail (JSON)

​Sample response body

​Retrieve disputes detail (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve schema for disputes detail

​Sample response body

​Retrieve disputes by month (JSON)

​Sample response body

​Retrieve disputes by month (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve schema for disputes by month

​Sample response body

Retrieve disputes detail (JSON)

Sample response body

Retrieve disputes detail (file export)

URL path parameters

Query parameters

Sample response body

Retrieve schema for disputes detail

Sample response body

Retrieve disputes by month (JSON)

Sample response body

Retrieve disputes by month (file export)

URL path parameters

Query parameters

Sample response body

Retrieve schema for disputes by month

Sample response body