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

retrieve_files boolean
Retrieve 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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

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

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

reference string

Reference value for troubleshooting

Possible values: <= 400 characters

Example: 110.1260

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": "7000.1000",
      "reason": "Internal Processing Error",
      "reference": "110.1260"
    }
  }
}

Loading...