Skip to main content
PATCH
Update a dispute

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

network_eligibility_override
boolean

Override network eligibility restrictions and forces the dispute to be filed with the network.

status
enum<string>

The current status of the dispute.

Available options:
OPEN,
CLOSED

Response

Returned dispute

Response for a card dispute.

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
read-only

The timestamp representing when the dispute was created

Example:

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

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
Available options:
LOST,
NONE,
ONGOING,
RESOLVED,
WON
dispute_documents
object[]
required

Documents associated with the dispute.

disputed_amount
integer
required

The amount to be disputed in cents.

Required range: x >= 1
id
string<uuid>
required
read-only

The unique identifier of the dispute

Example:

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

last_updated_time
string<date-time>
required
read-only

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 string length: 1000
network
enum<string>
required

The network with which the transaction was disputed.

Available options:
NONE,
ACH,
DECISIONLY,
MASTERCARD,
MARQETA,
TABAPAY
payment_rail
enum<string>
required

A short string representing the payment rail of the dispute.

Available options:
CARD,
EXTERNAL_CARD,
ACH
status
enum<string>
required

The current status of the dispute.

Available options:
OPEN,
CLOSED
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"

action_history
Card Action · object[]
required

History of all the action filed for the dispute.

available_actions
object[]
required

List of actions that can be taken on the dispute.

credit_status
enum<string>
required

The status of customer account credit related to the dispute

Available options:
NONE,
PROVISIONAL,
FINAL
lifecycle_state
enum<string>
required
Available options:
EVIDENCE_GATHERING,
EVALUATION,
MANUAL_REVIEW,
DENIED,
PENDING_ACTION,
WRITE_OFF,
CHARGEBACK,
NETWORK_REJECTED_CHARGEBACK,
NETWORK_REJECTED_CHARGEBACK_REVERSAL,
REPRESENTMENT,
PRE_ARBITRATION,
PRE_ARBITRATION_RESPONSE,
ARBITRATION,
ARBITRATION_RESPONSE
managed_by
enum<string>
required
Available options:
CUSTOMER,
GROUND_CONTROL,
AUTO_WRITE_OFF
network_eligibility
object
required

Network eligibility restrictions.

reason_code
enum<string>
required
  • NOTE: deprecated reason codes are accepted for backwards compatibility but will be mapped to their active equivalent reason codes by the API.
Available options:
CARD_LOST_STOLEN_NEVER_RECEIVED,
FRAUDULENT_PROCESSING,
LATE_PRESENTMENT,
PAID_BY_OTHER_MEANS,
TRANSACTION_DID_NOT_COMPLETE,
TRANSACTION_NOT_RECOGNIZED,
UNAUTHORIZED_TRANSACTION,
NO_CARDHOLDER_AUTHORIZATION,
QUESTIONABLE_MERCHANT_ACTIVITY,
CHIP_LIABILITY_SHIFT,
CHIP_PIN_LIABILITY_SHIFT,
POINT_OF_INTERACTION_ERROR,
FRAUD,
AUTHORIZATION_RELATED_CHARGEBACK,
GOODS_OR_SERVICES_NOT_PROVIDED,
DEFECTIVE_GOODS_OR_SERVICES,
CREDIT_NOT_RECEIVED,
DISPUTE_OF_RECURRING_TRANSACTION,
DUPLICATE_TRANSACTION,
TRANSACTION_AMOUNT_DIFFERS,
ATM_CASH_DISPUTE,
CANCELED_OR_RETURNED,
COUNTERFEIT_GOODS,
CARDHOLDER_DISPUTE
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>
Available options:
NETWORK,
INITIATOR
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.

acquirer_reference_number
string

The acquirer reference number of the original transaction associated with the dispute.

merchant_contact
object

Details of a cardholder attempt to contact the merchant about the disputed transaction.

switch_serial_number
string

The switch serial number of the original transaction associated with the dispute.