Update a dispute

Update a dispute

curl --request PATCH \
  --url https://api.synctera.com/v1/disputes/{dispute_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "CLOSED"
}'

{
  "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"
}

PATCH

disputes

{dispute_id}

Update a dispute

curl --request PATCH \
  --url https://api.synctera.com/v1/disputes/{dispute_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "CLOSED"
}'

{
  "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.

Path Parameters

dispute_id

string<uuid>

required

The unique identifier of the dispute

Example:

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

Body

application/json

Dispute update request body

status

enum<string>

required

The current status of the dispute.

Available options:

CLOSED,

OPEN

Response

Returned dispute

action_history

object[]

required

History of all the action filed for the dispute.

Show child attributes

available_actions

object[]

required

List of actions that can be taken on the dispute.

Show child attributes

lifecycle_state

enum<string>

required

Lifecycle	Description
DENIED	The dispute has been denied.
PENDING_ACTION	A dispute has been created and is pending subsequent action.
WRITE_OFF	The dispute has been written off and will not be filed with the card network.
CHARGEBACK	A chargeback has been created with the card network. The acquiring bank now has the opportunity to file for re-presentment. If no re-presentment is filed the acquirer assumes financial responsibility and the case is won.
NETWORK_REJECTED_CHARGEBACK	The chargeback submission has been rejected by the card network. The chargeback can be optionally resubmitted once the rejection reason has been addressed.
NETWORK_REJECTED_CHARGEBACK_REVERSAL	The chargeback reversal has been rejected by the card network.
REPRESENTMENT	The acquiring bank has created a re-presentment with the card network. The issuing bank now has the opportunity to file for pre-arbitration. If no pre-arbitration is filed the issuer assumes financial responsibility and the case is lost.
PRE_ARBITRATION	A pre-arbitration case has been created with the network. The acquiring bank now has the opportunity to rebut the case with subsequent evidence. If no rebuttal is filed the acquirer assumes financial responsibility and the case is won.
PRE_ARBITRATION_RESPONSE	The acquiring bank has rebutted the pre-arbitration case. The issuing bank now has the opportunity to file for arbitration. If no arbitration case is filed the issuer assumes financial responsibility and the case is lost.
ARBITRATION	An arbitration case has been created with the card network. The acquiring bank now has the opportunity to rebut the arbitration case with subsequent evidence.
ARBITRATION_RESPONSE	The acquiring bank has rebutted the arbitration case. The issuing bank can either withdraw the case or do nothing and the card network will make a decision on who assumes the financial responsibility.
PRE_COMPLIANCE	A pre-compliance case has been created by either the issuer or acquirer.
PRE_COMPLIANCE_RESPONSE	The opposing party has rebutted the pre-compliance case with further evidence.
COMPLIANCE	The initiating party has escalated the pre-compliance case to compliance.
COMPLIANCE_RESPONSE	The opposing party has rebutted the compliance case with further evidence.

Available options:

ARBITRATION,

ARBITRATION_RESPONSE,

CHARGEBACK,

COMPLIANCE,

COMPLIANCE_RESPONSE,

DENIED,

NETWORK_REJECTED_CHARGEBACK,

NETWORK_REJECTED_CHARGEBACK_REVERSAL,

PENDING_ACTION,

PRE_ARBITRATION,

PRE_ARBITRATION_RESPONSE,

PRE_COMPLIANCE,

PRE_COMPLIANCE_RESPONSE,

REPRESENTMENT,

WRITE_OFF

managed_by

enum<string>

required

Managed By	Description
CUSTOMER	The dispute is managed by the customer.
GROUND_CONTROL	The dispute is managed by Synctera Ground Control.

Available options:

CUSTOMER,

GROUND_CONTROL

network_eligibility

object

required

Network eligibility restrictions.

Show child attributes

reason_code

enum<string>

required

Reason Code	Description
ATM_CASH_DISPUTE	Some or all funds debited from the cardholder's account as the result of an ATM withdrawal were not dispensed.
CARD_LOST_STOLEN_NEVER_RECEIVED	The cardholder did not authorize the transaction and the card is no longer, or had never been, in the possession of the cardholder.
CHIP_LIABILITY_SHIFT	A fraudulent transaction resulted from the use of a counterfeit card at a non-hybrid terminal for a validly issued emv card.
COUNTERFEIT_GOODS	The cardholder claims that the goods were purported to be genuine, but were counterfeit.
CREDIT_NOT_RECEIVED	The cardholder's account was not credited for a refund from a merchant or was inaccurately debited instead of credited.
DEFECTIVE_GOODS_OR_SERVICES	Goods or services were either not as described or defective, including shipped merchandise was received damaged or not suitable for its intended purpose as well as the merchant didn't honour the terms and conditions of a contract.
DISPUTE_OF_RECURRING_TRANSACTION	The cardholder notified the merchant to cancel the recurring transaction and the merchant continued to bill the cardholder or the cardholder was not aware they were agreeing to a recurring transaction.
DUPLICATE_TRANSACTION	The same transaction has been processed more than once, resulting in duplicate charges.
FRAUDULENT_PROCESSING	The cardholder is in possession and control of all valid cards, processed at least one legitimate face-to-face transaction, and denies making one or more additional face-to-face transactions at the same merchant location.
GOODS_OR_SERVICES_NOT_PROVIDED	The cardholder has been debited for goods or services that were to be shipped, delivered or otherwise provided and were not received by the expected delivery date.
LATE_PRESENTMENT	The transaction was authorized offline by the chip and submitted for clearing more than 7 calendar days after the transaction date.
PAID_BY_OTHER_MEANS	The cardholder used a different form of payment for this specific transaction. (Mastercard pre-compliance/compliance only)
TRANSACTION_AMOUNT_DIFFERS	The amount of the transaction does not match the agreed-upon or expected amount.
TRANSACTION_DID_NOT_COMPLETE	The cardholder engaged in the transaction and claims it did not complete. Goods or services were not provided.
TRANSACTION_NOT_RECOGNIZED	The account holder does not recognize the transaction, possibly due to mistake or fraud.
UNAUTHORIZED_TRANSACTION	The transaction was not authorized by the account holder.

Available options:

ATM_CASH_DISPUTE,

CARD_LOST_STOLEN_NEVER_RECEIVED,

CHIP_LIABILITY_SHIFT,

COUNTERFEIT_GOODS,

CREDIT_NOT_RECEIVED,

DEFECTIVE_GOODS_OR_SERVICES,

DISPUTE_OF_RECURRING_TRANSACTION,

DUPLICATE_TRANSACTION,

FRAUDULENT_PROCESSING,

GOODS_OR_SERVICES_NOT_PROVIDED,

LATE_PRESENTMENT,

PAID_BY_OTHER_MEANS,

TRANSACTION_AMOUNT_DIFFERS,

TRANSACTION_DID_NOT_COMPLETE,

TRANSACTION_NOT_RECOGNIZED,

UNAUTHORIZED_TRANSACTION

account_id

string<uuid>

required

The customer account related to the dispute, to which dispute-related credits will be posted.

Example:

"ca4450a5-5d4c-4afc-9533-729e2948c477"

creation_time

string<date-time>

required

The timestamp representing when the dispute was created

Example:

"2010-05-06T12:23:34.321Z"

credit_status

enum<string>

required

The status of customer account credit related to the dispute

Status	Description
NONE	The customer account has not been credited or a provisional credit has been reversed and not replaced.
PROVISIONAL	A provisional credit has been posted to the customer account.
FINAL	A final credit has been posted to the customer account.

Available options:

FINAL,

NONE,

PROVISIONAL

currency

string

required

ISO 4217 Alpha-3 currency code

Required string length: 3

Example:

"USD"

customer_id

string<uuid>

required

The customer related to the dispute, to which dispute-related credits will be posted.

Example:

"52593ea7-4d66-40df-80e9-3b9bc54fa880"

date_customer_reported

string<date-time>

required

The timestamp representing when the customer reported the dispute.

Example:

"2010-05-06T12:23:34.321Z"

decision

enum<string>

required

Decision	Description
LOST	Decision reached in favour of the network.
NONE	No decision was reached.
ONGOING	Dispute is ongoing and requires further action.
RESOLVED	Resolved in favour of the account holder.
WON	Decision reached in favour of the account holder.

Available options:

LOST,

NONE,

ONGOING,

RESOLVED,

WON

dispute_documents

object[]

required

Documents associated with the dispute.

Show child attributes

disputed_amount

integer

required

The amount to be disputed in cents.

Required range: x >= 1

string<uuid>

required

The unique identifier of the dispute

Example:

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

last_updated_time

string<date-time>

required

The timestamp representing when the dispute was last modified

Example:

"2010-05-06T12:23:34.321Z"

memo

string

required

Brief written message describing the reason for disputing the transaction.

Maximum length: 1000

network

enum<string>

required

The network with which the transaction was disputed.

Available options:

ACH,

MARQETA,

MASTERCARD,

NONE,

TABAPAY

payment_rail

enum<string>

required

A short string representing the payment rail of the dispute.

Available options:

ACH,

CARD,

EXTERNAL_CARD

status

enum<string>

required

The current status of the dispute.

Available options:

CLOSED,

OPEN

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

transaction_id

string<uuid>

required

The ID of the posted transaction to be disputed.

Example:

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

applicable_regulation

enum<string>

Available options:

REGULATION_E,

REGULATION_Z

external_reference_id

string

Reference ID associated with the dispute on the external network.

last_action_by

enum<string>

action_by	Description
INITIATOR	The last action was taken by the initiator of the dispute.
NETWORK	The last action was taken by the network.

Available options:

INITIATOR,

NETWORK

timestamp_final_decision

string<date-time>

The time that a final decision was made on the dispute.

timestamp_investigation_due

string<date-time>

timestamp_provisional_credit_due

string<date-time>

The time by which provisional credit should be posted to the customer account in response to the dispute.

Get a Dispute Create a dispute action

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Authorizations

Path Parameters

Body

Response