Class SearchDisputeEntriesRequest

Inheritance
object
SearchDisputeEntriesRequest
Inherited Members
Namespace: Worldline.Acquiring.Sdk.V1.Domain
Assembly: Worldline.Acquiring.Sdk.dll
Syntax
public class SearchDisputeEntriesRequest

Properties

DisputeId

The unique identifier for a dispute.

Declaration
public string DisputeId { get; set; }
Property Value
Type Description
string

EntryCategories

Declaration
public IList<string> EntryCategories { get; set; }
Property Value
Type Description
IList<string>

EntryDateTime

A range of date time values, used to select disputes that have a date time field that falls within this range.

NOTE: You can set either one or both of the lower and greater than properties to filter the results.
Declaration
public DateTimeRange EntryDateTime { get; set; }
Property Value
Type Description
DateTimeRange

EntryId

The unique identifier for an dispute entry.

Declaration
public string EntryId { get; set; }
Property Value
Type Description
string

EntryTypes

Declaration
public IList<string> EntryTypes { get; set; }
Property Value
Type Description
IList<string>

IncludeDisputeSummary

If true, the summary of the dispute case will be included in the response for dispute entries search. The dispute case summary includes key information about the dispute case such as the current status, the reason for the dispute and the amount of the disputed transaction. This can be useful to provide context about the dispute case when searching for specific dispute entries.
False by default.

Declaration
public bool? IncludeDisputeSummary { get; set; }
Property Value
Type Description
bool?

MerchantScope

A set of fields to specify the scope of the search for disputes related to a specific merchant or set of merchants. The following options are available:

  • Search for disputes related to specific acquirers, by providing the acquirerIds field.
  • Search for disputes related to specific merchant groups, by providing the merchantRootIds field.
  • Search for disputes related to specific merchants, by providing the merchantIds field.

If no merchant scope is provided, disputes for all merchants that the API user has access to will be returned (that also match the other provided search criteria, if any).
Declaration
public MerchantScope MerchantScope { get; set; }
Property Value
Type Description
MerchantScope

Pagination

Pagination details for paginated responses.

First request: Omit searchId, set fromIndex=0, pageSize=20 Subsequent requests: Use searchId from previous response to maintain query context.

Note: searchId expires after 24 hours. If you should perform your original search request again.
Declaration
public PaginationRequest Pagination { get; set; }
Property Value
Type Description
PaginationRequest

SortOrder

The order in which to sort the dispute entries in the response. Can be either ascending (ASC) or descending (DESC). The sorting is done based on the entryDateTime field of the dispute entries, so when the sort order is ascending, the oldest entry is returned first and the newest entry is returned last. By default, the dispute entries are sorted in descending order.

Declaration
public string SortOrder { get; set; }
Property Value
Type Description
string