XendBridge
Search…
⌃K

Get All Disputes

Get all disputes raised in a third party application
This GET endpoint gets all disputes made by a third party. For the params to be passed, the startDate and endDate has to be a converted date time in seconds. The disputeStatus can be either 'OpenDispute', 'DisputeBeingAttendedTo' or 'DisputeResolved'. The pagenumber and pageSize are to be included.
The publicKey is to be passed in the header as it's required.
get
https://canary.xendbridge.com
/api/Dispute/ThirdParty?startDate=1632756987000&endDate=1638027387000...
...&disputeStatus=DisputeResolved&page=1&pageSize=50
Request Fields
Response Fields
Parameters
Type
Definitions
startDate
double
Required The date and time of the start of a dispute in milliseconds.
endDate
double
Required The end date and time of the end of dispute in milliseconds.
disputeStatus
enum
RequiredThe status of the dispute on an order. It could either be OpenDispute, DisputeBeingAttendedTo or DisputeResolved.
page
int
Required This is the number of a page with a specific page size of disputes.
pageSize
int
Required This is the number of the size of disputes on a page.
Parameters
Type
Definitions
data
object
This holds the properties; records, pageSize, currentPage, totalPages & totalRecords.
id
guid
This is the id of the record in the database.
attachmentUrl
string
This is any media url attachment posted in a dispute.
orderReference
string
The order reference of an order made.
orderId
guid
The guid of an order record in the database.
orderDate
long
The date and time when that order was made in milliseconds.
disputeRaisedAt
long
The date and time the dispute was raised at in milliseconds.
disputeLastUpdatedAt
long
The last date and time update on a dispute in milliseconds
disputeStatus
enum
The status of the dispute on an order. It could either be OpenDispute, DisputeBeingAttendedTo or DisputeResolved.
disputeRaisedBy
enum
This is the entity who raised the dispute.
disputeRemark
string
This is the remark on a dispute by any participant.
disputeComment
string
This is the comment by the consumer of the dispute.
payinCurrency
enum
This is the currency in which the order is paid in.
recieveInCurrency
enum
This is the currency in which the order is received in.
payInAmount
decimal
This is the amount of the order to be paid to.
receiveInAmount
decimal
This is the amount of the order to be received in.
clientPaymentMethod
enum
This is the customer's payment method.
thirdPartyAppName
string
This is the Third party app integrated with XendBridge.
providerName
string
This is the name of the provider.
providerEmail
string
This is the email address of the provider.
providerPhone
string
This is the provider's phone number.
customerName
string
This is the customer's name.
customerEmail
string
This is the customer's email.
customerPhone
string
This is the customer's phone number.
disputeChats
array
This is holds the objects of the different chats in a dispute
id
guid
The id of the chat record in the database.
receivedAt
DateTime
This is the date the chat message was received.
receivedAtTimeStamp
double
This is the time date the chat message was received at in milliseconds.
sentBy
enum
This is the participant who sent the message.
sentTo
enum
This is the participant who the message is being sent to.
senderName
string
This is the participant's name who sent the message.
message
string
This the content of the message sent.
pageSize
int
This is the number of disputes chats in a page.
currentPage
int
This is the current page number.
totalPages
int
This is the total number of pages of the disputes for a third party app.
totalRecords
int
This is the total number of records of the disputes in third party app.
status
string
This is the status of the request.
message
string
This returns empty if no errors occurs.