Class SearchDisputesRequest

Inheritance

object

SearchDisputesRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Worldline.Acquiring.Sdk.V1.Domain

Assembly: Worldline.Acquiring.Sdk.dll

Syntax

public class SearchDisputesRequest

Properties

AcquirerDisputeReference

The reference provided by the acquirer for the dispute.

Declaration

public string AcquirerDisputeReference { get; set; }

Property Value

Type	Description
string

AcquirerReferenceNumber

Acquirer reference number (ARN) for transaction

Declaration

public string AcquirerReferenceNumber { get; set; }

Property Value

Type	Description
string

ClosedDateTime

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 ClosedDateTime { get; set; }

Property Value

Type	Description
DateTimeRange

DisputeId

The unique identifier for a dispute.

Declaration

public string DisputeId { get; set; }

Property Value

Type	Description
string

DisputeStages

Declaration

public IList<string> DisputeStages { get; set; }

Property Value

Type	Description
IList<string>

DisputeStatusCategories

Declaration

public IList<string> DisputeStatusCategories { get; set; }

Property Value

Type	Description
IList<string>

IsOpen

Indicates whether the dispute is open or closed. An open dispute is a dispute that's still in the process of being resolved, while a closed dispute is a dispute that has been resolved.

Declaration

public bool? IsOpen { get; set; }

Property Value

Type	Description
bool?

LastStatusChangedDateTime

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 LastStatusChangedDateTime { get; set; }

Property Value

Type	Description
DateTimeRange

MerchantReference

Reference for the transaction to allow the merchant to reconcile their payments in our report files and in their disputes.
It is advised to submit a unique value per transaction.
The value is returned in the baseTrxType/addlMercData element of the MRX file.

Declaration

public string MerchantReference { get; set; }

Property Value

Type	Description
string

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

OpenedDateTime

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 OpenedDateTime { get; set; }

Property Value

Type	Description
DateTimeRange

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

PaymentId

The unique identifier for the original payment transaction that resulted in the dispute. Depending on the interface used for the original transaction different values are returned. If the original transaction was made through the Acquiring API, the paymentId from the original transaction is returned.

Declaration

public string PaymentId { get; set; }

Property Value

Type	Description
string

ResponseDueDate

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

NOTE: You can set either one or both of the properties to filter the results.

Declaration

public DateRange ResponseDueDate { get; set; }

Property Value

Type	Description
DateRange

Schemes

Declaration

public IList<string> Schemes { get; set; }

Property Value

Type	Description
IList<string>

SortBy

The field by which to sort the search results. This can be any of the date-time fields in the dispute resource, such as openedDateTime, closedDateTime, lastStatusChangedDateTime or responseDueDate.

Declaration

public string SortBy { get; set; }

Property Value

Type	Description
string

SortOrder

The order in which to sort the search results. Can be either ascending (ASC) or descending (DESC).

Declaration

public string SortOrder { get; set; }

Property Value

Type	Description
string

UnifiedCategories

Declaration

public IList<string> UnifiedCategories { get; set; }

Property Value

Type	Description
IList<string>