GET
/
disputes
List disputes
curl --request GET \
  --url https://api.synctera.com/v1/disputes \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "disputes": [
    {
      "action_history": [
        {
          "action": "ARBITRATION",
          "creation_time": "2010-05-06T12:23:34.321Z",
          "external_reference_id": "<string>",
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "memo": "<string>",
          "message": "<string>",
          "payment_rail": "ACH",
          "reason_code": "ATM_CASH_DISPUTE",
          "representment_reason_code": "ACCOUNT_NOT_LISTED_ON_EWB",
          "status": "ACCEPTED",
          "supporting_doc_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "tenant": "abcdef_ghijkl",
          "updated_reason_code_memo": "<string>",
          "violation_code": "ACQ_STMT_REQUEST",
          "violation_date": "2023-11-07T05:31:56Z"
        }
      ],
      "available_actions": [
        {
          "action": "ARBITRATION",
          "state": "ACCEPT",
          "timestamp_valid_to": "2010-05-06T12:23:34.321Z"
        }
      ],
      "lifecycle_state": "ARBITRATION",
      "managed_by": "CUSTOMER",
      "network_eligibility": {
        "is_digital_wallet_token": true,
        "is_three_ds": true
      },
      "reason_code": "ATM_CASH_DISPUTE",
      "account_id": "ca4450a5-5d4c-4afc-9533-729e2948c477",
      "applicable_regulation": "REGULATION_E",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "credit_status": "FINAL",
      "currency": "USD",
      "customer_id": "52593ea7-4d66-40df-80e9-3b9bc54fa880",
      "date_customer_reported": "2010-05-06T12:23:34.321Z",
      "decision": "LOST",
      "dispute_documents": [
        {
          "creation_time": "2010-05-06T12:23:34.321Z",
          "dispute_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "file_name": "example.pdf",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tenant": "abcdef_ghijkl"
        }
      ],
      "disputed_amount": 2,
      "external_reference_id": "<string>",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_action_by": "INITIATOR",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "memo": "<string>",
      "network": "ACH",
      "payment_rail": "ACH",
      "status": "CLOSED",
      "tenant": "abcdef_ghijkl",
      "timestamp_final_decision": "2023-11-07T05:31:56Z",
      "timestamp_investigation_due": "2023-11-07T05:31:56Z",
      "timestamp_provisional_credit_due": "2023-11-07T05:31:56Z",
      "transaction_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
to_date
string<date>

Only display disputes with a creation date less than or equal to to_date

​
transaction_id
string<uuid>

The unique identifier of a posted transaction

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
account_id
string<uuid>[]

Account ID

​
payment_rail
enum<string>

Specifies the payment rail type for the returned disputes.

Available options:
ACH,
CARD,
EXTERNAL_CARD
​
start_time
string<date-time>

Only display disputes with a creation time greater than or equal to start_time

​
status
enum<string>

The current status of the dispute.

Available options:
CLOSED,
OPEN
​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
end_time
string<date-time>

Only display disputes with a final decision time less than or equal to end_time

​
from_date
string<date>

Only display disputes with a creation date greater than or equal to from_date

​
decision
enum<string>
DecisionDescription
LOSTDecision reached in favour of the network.
NONENo decision was reached.
ONGOINGDispute is ongoing and requires further action.
RESOLVEDResolved in favour of the account holder.
WONDecision reached in favour of the account holder.
Available options:
LOST,
NONE,
ONGOING,
RESOLVED,
WON
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

Response

200
application/json

List of disputes

The response is of type object.