List dispute statuses

Browse API reference

GET/disputes/{disputeId}/statusesgetdisputesStatuses

Use this method to return the status history of a dispute.

To view the status history of a dispute, you need its disputeId. If you don't have the disputeId, use our List Disputes method to search for the dispute.

Our gateway returns a list that contains each status change, the date it was changed, and its updated status.

Parameters

Name	In	Type	Description
`disputeId`Required	path	`integer`	Unique identifier of the dispute.

Responses

Successful request. Returns the status history for a specific dispute.

200 OK · application/json

[
  {
    "disputeStatusId": 123,
    "status": "new",
    "statusDate": "2024-07-02"
  },
  {
    "disputeStatusId": 124,
    "status": "representmentInProgress",
    "statusDate": "2024-07-05"
  },
  {
    "disputeStatusId": 125,
    "status": "representmentPaid",
    "statusDate": "2024-07-12"
  }
]

Response schema · 3 fields

disputeStatusIdinteger
Unique identifier that we assigned to the status of the dispute.
statusstring
Status of the dispute. Note: If you want to view the status history of the dispute, use our List Dispute Statuses method.prearbitrationInProcessprearbitrationAcceptedprearbitrationDeclinedarbitrationFiledWithCardBandarbitrationFundsToBeReturnedarbitrationLostarbitrationSettledPartialAmountprecomplianceInProcess+14 more
statusDatestringdate
Date that the status of the dispute was last changed. The format of this value is YYYY-MM-DD.

Validation error

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected date, got \"abc\"",
      "parameter": "date"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

review-settlement-reporting