Retrieve List of Disputes

GET 
/entities/{entity-id}/disputes

Retrieves a list of disputes for entity based on the provided parameters.

Request

Path Parameters

entity-id stringrequired

Entity Id

Query Parameters

from_date daterequired

From Date

to_date daterequired

To Date

response_date_sort stringrequired

Possible values: [CreateDate, UpdateDate]

Response Date Sort

receive_files boolean
Receive Files
Default value: false
offset integer
Offset
Default value: 0
size integer
Size
Default value: 100

Responses

200

OK

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

404

Not Found

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

totalCount integer
disputes object[]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

Object describing the error in case such occurred during processing of the request.

code stringrequired

Code of the error in case such occurred during processing of the request.

Possible values: <= 11 characters

reason string

Description of the error in case such occurred during processing of the request.

Possible values: <= 400 characters

Example (from schema)

{
  "totalCount": 0,
  "disputes": [
    {
      "id": "string",
      "creationDate": "2024-07-29T15:51:28.071Z",
      "verdict": "won",
      "transaction": {
        "id": 0,
        "date": "2024-07-29T15:51:28.071Z",
        "merchantTransactionId": "string",
        "arn": "string",
        "amount": 0,
        "currency": "string"
      },
      "paymentOption": "string",
      "maskedCardNumber": "string",
      "availableActions": [
        "ACCEPT"
      ],
      "lastDisputeEvent": {
        "id": "string",
        "updateDate": "2024-07-29T15:51:28.071Z",
        "expirationDate": "2024-07-29T15:51:28.071Z",
        "status": {
          "code": "string",
          "description": "string"
        },
        "disputeAmount": 0,
        "rejectAmount": 0,
        "currency": "string",
        "remarks": "string",
        "disputeReason": {
          "code": "string",
          "description": "string"
        },
        "rejectReason": {
          "code": "string",
          "description": "string"
        },
        "files": [
          {
            "id": "string",
            "name": "string",
            "data": "string"
          }
        ],
        "initiatedBy": "Issuer"
      }
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "string",
      "reason": "string"
    }
  }
}

Loading...