Simulate a network dispute action
🚧 Beta This is a Beta endpoint. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.
This endpoint is intended for use only in the testing environment to simulate a network action on a dispute.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Path Parameters
The unique identifier of the dispute
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
Details of the simulated dispute action
- Card Action
- ACH Action
- External Card Action
Create an action against a disputed card transaction
CHARGEBACK, REPRESENTMENT, PRE_ARBITRATION, ARBITRATION, PROVISIONAL_CREDIT, WRITE_OFF, EVIDENCE_GATHERING, DISPUTE A short string representing the payment rail of the dispute.
CARD, EXTERNAL_CARD, ACH ACCEPT, CREATE, COMPLETE, LOST, NETWORK_REJECT, NETWORK_REJECT_REVERSAL, REBUT, REVERSE, REFUND, EXPIRE, REJECT, WITHDRAW, WON Optional amount for the action in cents. If not provided, defaults to the dispute amount. Amount is only applicable when creating actions (state: CREATE) and is only supported for specific action types (see table below); amounts provided for other action types or states will be ignored.
x >= 0Memo text related to card dispute action
- Required for PRE_ARBITRATION, ARBITRATION
13000Message text related to card dispute action
100Deprecated reason codes are accepted for backwards compatibility and mapped to their active equivalent. Which codes are active depends on the dispute management version. See the Version 2 rollout for dates, which flow to follow, and a link to the Version 1 guide.
Version 2
Version 1
CARD_LOST_STOLEN_NEVER_RECEIVED, FRAUDULENT_PROCESSING, LATE_PRESENTMENT, PAID_BY_OTHER_MEANS, TRANSACTION_DID_NOT_COMPLETE, TRANSACTION_NOT_RECOGNIZED, NO_CARDHOLDER_AUTHORIZATION, QUESTIONABLE_MERCHANT_ACTIVITY, CHIP_LIABILITY_SHIFT, CHIP_PIN_LIABILITY_SHIFT, POINT_OF_INTERACTION_ERROR, UNAUTHORIZED_TRANSACTION, 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 The unique identifier of the supporting document
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Memo text describing the reason for updating a reason code.
- Required for PRE_ARBITRATION and ARBITRATION if a reason code is provided in the request. If no reason code is present in the request, the original CHARGEBACK reason code will be used.
1000Response
Successfully simulated dispute action
- Card Action
- ACH Action
- External Card Action
Response for a card dispute action.
CHARGEBACK, REPRESENTMENT, PRE_ARBITRATION, ARBITRATION, PROVISIONAL_CREDIT, WRITE_OFF, EVIDENCE_GATHERING, DISPUTE The timestamp representing when the object was created
"2010-05-06T12:23:34.321Z"
The unique identifier of the dispute action
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
A short string representing the payment rail of the dispute.
CARD, EXTERNAL_CARD, ACH ACCEPTED, SUBMITTED, COMPLETED, LOST, NETWORK_REJECTED, NETWORK_REJECTED_REVERSAL, REBUTTED, REVERSED, REFUNDED, EXPIRED, REJECTED, WITHDRAWN, WON The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
"abcdef_ghijkl"
The amount of the action in cents.
x >= 0Reference ID associated with the action on the external network.
Memo text related to card dispute action
Message text related to card dispute action
Deprecated reason codes are accepted for backwards compatibility and mapped to their active equivalent. Which codes are active depends on the dispute management version. See the Version 2 rollout for dates, which flow to follow, and a link to the Version 1 guide.
Version 2
Version 1
CARD_LOST_STOLEN_NEVER_RECEIVED, FRAUDULENT_PROCESSING, LATE_PRESENTMENT, PAID_BY_OTHER_MEANS, TRANSACTION_DID_NOT_COMPLETE, TRANSACTION_NOT_RECOGNIZED, NO_CARDHOLDER_AUTHORIZATION, QUESTIONABLE_MERCHANT_ACTIVITY, CHIP_LIABILITY_SHIFT, CHIP_PIN_LIABILITY_SHIFT, POINT_OF_INTERACTION_ERROR, UNAUTHORIZED_TRANSACTION, 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 INVALID_ACQUIRER_REFERENCE_DATA, NON_RECEIPT_OF_DOCUMENTATION, DOCUMENTATION_INELIGIBLE, DOCUMENTATION_SCANNING_ERROR, CORRECT_TRANSACTION_DATE, CORRECT_MERCHANT_LOCATION, ISSUER_AUTHORIZED, CREDIT_PREVIOUSLY_ISSUED, CHARGEBACK_REMEDIED, DUPLICATE_CHARGEBACK, PAST_CHARGEBACK_TIME_LIMIT, INVALID_DATA_RECORD_TEXT, CORRECT_MCC, AUTHORIZATION_ADVISED_SUSPICIOUS, NO_AUTHORIZATION_REQUEST_REQUIRED_OR_ATTEMPTED, ACCOUNT_NOT_LISTED_ON_EWB, INVALID_CHARGEBACK, CHIP_LIABILITY_SHIFT, CHIP_PIN_LIABILITY_SHIFT The unique identifier of the supporting document
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Memo text describing the reason for updating a reason code.

