Retrieve Disputes List

get

https://api-dev.prolifepayments.com/reports/v1/disputes

Query Params

start_date

int32

required

The start date for the search in unix format. This applies to the disputes' creation date.

end_date

int32

required

The end date for the search in unix format. This applies to the disputes' creation date.

date_sort_by

string

Defaults to last_modified_date

Indicates whether the the search will be sorted by the load_date or last_modified_date column. Allowed values: "load_date", "last_modified_date".

dispute_state

string

Comma separated string that indicates which states are included in the search. Allowed values: "retrieval", "chargeback", "reversal", "prearbitration", "arbitration", "ach_return", "ach_correction".

limit

int32

Defaults to 10

The number of records to retrieve. If not provided it defaults to 10.

next_results_token

string

Keyset pagination is a method of retrieving a subset of results based on the last seen item; the next_result_token field returns a token to be used in the path parameters for accessing the next page of results.

Headers

onBehalfOf

string

Specifies the account for which the Disputes request retrieval is intended. This is used for scenarios where one partner retrieves disputes on behalf of another partner, such as in PayFac or related partner relationships.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400