API explorer

Theme switcher

Dispute

The Dispute allows merchants to initiate disputes related to customer invoices. It provides a structured way to handle issues such as product returns, damaged goods, or custom concerns.

Body Parameters

billinkIdstring Required

The unique identifier for the billink.

billinkUsernamestring Required

The unique username for the billink.

categorystring Required

The category parameter specifies the category under which the dispute created.

customerEmailstring Required

The customerEmail parameter holds the email address of the customer involved in the dispute.

customerNamestring Required

The customerName parameter stores the name of the customer involved in the dispute.

filestring

The file parameter is used to upload a file related to the first dispute message. Accepts only base64

fileNamestring

The fileName parameter specifies the name of the file uploaded as part of first dispute message. Valid file formats: 'png', 'pdf', 'jpg', 'jpeg', 'doc', 'docx', 'heic'

invoicestring Required

The invoice parameter holds information related to the invoice associated with the dispute.

localestring Required

The locale parameter defines the language which will be used in dispute

messagestring Required

The message parameter allows for adding additional information or comments related to the dispute.

Response

200
Object

Response Attributes

categorystring
clientobject

Show child attributes

createdAtobject

Show child attributes

currentStepobject
customerobject

Show child attributes

disputeContentarray
emailsarray
freshDeskTicketobject
idnumber
notificationModestring
ownerobject

Show child attributes

resolvedboolean
resolvedAtobject
statusstring
stepsarray
400
Object

Response Attributes

codenumber
messagestring
errorstring
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?