Disputes

Paginated disputes list

Returns a list of all disputes. The list can also be filtered by dispute status using the -s flag.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
object (ExternalBusinessRequestDto)
status
string
pageNumber
integer <int32>
pageSize
integer <int32>
sortBy
string
direction
string
object (ExternalFilter)
Responses
200

disputes returned

post/v1/disputes/disputes-by-status
Request samples
application/json
{
  • "businessRequest": {
    },
  • "status": "string",
  • "pageNumber": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "direction": "string",
  • "filter": {
    }
}
Response samples
application/json
{
  • "disputes": [
    ],
  • "currentPage": 0,
  • "pageSize": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Dispute penalties list

Retrieves a list of the penalties incurred due to the dispute.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
exceptionIds
Array of strings <uuid>
object (ExternalBusinessRequestDto)
Responses
200

List of penalties returned

post/v1/disputes/my-disputes-penalties
Request samples
application/json
{
  • "exceptionIds": [
    ],
  • "businessRequest": {
    }
}
Response samples
application/json
{
  • "disputes": [
    ]
}

User disputes list

Lists all disputes for the authenticated user.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
object (ExternalBusinessRequestDto)
contractId
string <uuid>
Responses
200

disputes returned

post/v1/disputes
Request samples
application/json
{
  • "businessRequest": {
    },
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51"
}
Response samples
application/json
{
  • "disputes": [
    ]
}