> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Disputes (PULSE)
> Use the cases endpoint to manage transaction disputes on the PULSE network.
export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
const METHOD_STYLES = {
GET: {
bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
text: "mint-text-green-700 dark:mint-text-green-400",
border: "mint-border-green-300 dark:mint-border-green-700"
},
POST: {
bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
text: "mint-text-blue-700 dark:mint-text-blue-400"
},
PUT: {
bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
text: "mint-text-yellow-700 dark:mint-text-yellow-400"
},
PATCH: {
bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
text: "mint-text-orange-700 dark:mint-text-orange-400"
},
DELETE: {
bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
text: "mint-text-red-700 dark:mint-text-red-400"
},
API: {
bg: "mint-bg-black",
text: "mint-text-white"
}
};
const MethodBadge = ({method}) => {
const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
return
{method?.toUpperCase()}
;
};
const content =
{}
{}
{title}
{children &&
{children}
}
Create dispute case
**Action:** `POST`\
**Endpoint:** `/cases`
Create a new dispute case by specifying the type and including the type-specific details object.
Body field details
| Fields | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token
string
Optional | Unique identifier of the dispute case.
If you do not include a token, the system generates one automatically. Because this token is necessary for use in other API calls, it is recommended that, rather than let the system generate the token, you use a simple string that is easy to remember. This value cannot be updated.
**Allowable Values:**
36 char max |
| type
string
Required | Type of dispute case.
**Allowable Values:**
DISPUTE |
| memo
string
Optional | Free-form comments about the dispute.
**Allowable Values:**
512 char max |
| network\_comment
string
Optional | Comment provided by the cardholder to be sent to the PULSE card network.
**Allowable Values:**
500 char max, with the following allowed and disallowed characters:
**Allowed Characters:**
% & \* ( ) \_ - + ' : , . \` , ? /
**Disallowed Characters:**
! @ # \$ ^ = \[ ] \{ } " ; \< > \\ \| |
| salesforce\_ticket\_id
string
Optional | Identifier of the associated Salesforce ticket.
**Allowable Values:**
255 char max |
| dispute\_details
object
Required | Object describing the disputed transaction, including the reason for the dispute.
**Allowable Values:**
See The dispute\_details object table. |
The dispute\_details object
Include this object in your request if the case type is `DISPUTE`.
| Fields | Description |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| original\_transaction\_token
string
Required | Unique identifier of the original transaction under dispute.
**Allowable Values:**
36 char max |
| original\_transaction\_type
string
Required | Transaction type of the original transaction under dispute.
**Allowable Values:**
255 char max |
| dispute\_amount
number
Required | Amount of funds under dispute.
**Allowable Values:**
Must be less than or equal to the original transaction amount |
| dispute\_reason
string
Required | Code describing the reason for the dispute.
**Allowable Values:**
See The dispute\_details.dispute\_reason field table. |
| cardholder\_contact\_date
datetime
Required | Date that the cardholder made initial contact regarding the dispute.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| cancelled\_recurring\_payment\_date
string
Optional | Date that the recurring payment was cancelled.
Optional field for CANCELLED\_RECURRING\_TRANSACTION disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
| recurring\_payment\_plan\_expiry\_date
string
Required | Date that the recurring payment plan expired.
Optional field for CANCELLED\_RECURRING\_TRANSACTION disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
| cash\_over\_indicator
string
Optional | Indicates the disputed portion of the transaction.
- **M** indicates that the merchandise portion of the transaction is in dispute.
- **C** indicates that the cash portion of the transaction is in dispute.
- **B** indicates that both the merchandise and cash portions of the transaction are in dispute.
Conditionally required field for CREDIT\_NOT\_PROCESSED disputes that do not include the date\_of\_return field.
Optional field for INCORRECT\_TRANSACTION\_AMOUNT, LATE\_PRESENTMENT, NO\_AUTHORIZATION, NOT\_AS\_DESCRIBED\_OR\_DEFECTIVE\_MERCHANDISE, and SERVICE\_NOT\_PROVIDED\_MERCHANDISE\_NOT\_RECEIVED disputes
**Allowable Values:**
M, C, B |
| comments
string
Optional | Freeform text comments provided by the cardholder.
Optional field for INCORRECT\_TRANSACTION\_AMOUNT and INCORRECT\_TRANSACTION\_CODE disputes.
**Allowable Values:**
500 char max |
| credit\_confirmation\_number
string
Optional | Reference number for the credit that was provided to the cardholder.
Optional field for INCORRECT\_TRANSACTION\_CODE disputes.
**Allowable Values:**
25 char max |
| date\_of\_return
string
Optional | Date on which the merchandise was returned to the merchant.
Conditionally required field for CREDIT\_NOT\_PROCESSED disputes that do not include the cash\_over\_indicator field.
Optional field for INCORRECT\_TRANSACTION\_CODE and SERVICE\_NOT\_PROVIDED\_MERCHANDISE\_NOT\_RECEIVED disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
| return\_method
string
Optional | Code that indicates the method by which the merchandise was returned to the merchant.
- **F2F** indicates that the merchandise was returned in person.
- **FEDEX** indicates that the merchandise was returned by FedEx.
- **DHL** indicates that the merchandise was returned by DHL.
- **POSTAL\_SERVICE** indicates that the merchandise was returned by the Postal Service.
- **UPS** indicates that the merchandise was returned by UPS.
- **OTHER** indicates that the merchandise was returned by other means.
Optional field for INCORRECT\_TRANSACTION\_CODE disputes.
**Allowable Values:**
F2F, FEDEX, DHL, POSTAL\_SERVICE, UPS, OTHER |
| motive\_code
string
Optional | Code that indicates additional return reason details.
- **QUALITY\_OF\_GOODS\_OR\_SERVICES** indicates that the cardholder disputes the quality of the goods received or services rendered.
- **TERMS\_OF\_SALE\_OR\_COUNTERFEIT\_MERCHANDISE** indicates that the cardholder disputes the terms of sale, or that the merchandise is counterfeit.
Required field for NOT\_AS\_DESCRIBED\_OR\_DEFECTIVE\_MERCHANDISE disputes.
**Allowable Values:**
QUALITY\_OF\_GOODS\_OR\_SERVICES, TERMS\_OF\_SALE\_OR\_COUNTERFEIT\_MERCHANDISE |
| merchandise\_counterfeit\_confirmation\_date
string
Optional | Date that the merchandise was determined to be counterfeit.
Optional field for NOT\_AS\_DESCRIBED\_OR\_DEFECTIVE\_MERCHANDISE disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
| promised\_delivery\_date
string
Optional | Date that the merchandise was due to be delivered, or the service was due to be performed.
Optional field for NOT\_AS\_DESCRIBED\_OR\_DEFECTIVE\_MERCHANDISE disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
| agreed\_delivery\_or\_service\_date
string
Conditionally required | Date of delivery or service agreed upon by both merchant and cardholder. Used for non-receipt of goods or services disputes.
This field is required if the dispute is submitted within 15 days of the settlement date.
This field is optional if the dispute is submitted 16 or more days after the original settlement date.
**Allowable Values:**
Format: yyyy-MM-dd |
| date\_of\_cancellation
string
Optional | Date on which the merchandise or service order was cancelled.
Optional field for CREDIT\_NOT\_PROCESSED disputes.
**Allowable Values:**
Format: yyyy-MM-dd |
The dispute\_details.dispute\_reason field
The following table describes the possible values for the `dispute_details.dispute_reason` field.
| Dispute Reason | Description |
| -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CANCELLED\_RECURRING\_TRANSACTION | A recurring transaction was cancelled. |
| CREDIT\_NOT\_PROCESSED | A credit was not processed. |
| DUPLICATE\_PROCESSING | A single transaction was processed more than once using the same payment credential on the same transaction date, and for the same transaction amount. |
| DUPLICATE\_PROCESSING\_OR\_PAID\_BY\_OTHER\_MEANS | A single transaction was paid by other means. Use this dispute reason only for "paid by other means" disputes. For duplicate processing disputes, use DUPLICATE\_PROCESSING |
| EMV\_LIABILITY\_SHIFT\_COUNTERFEIT\_FRAUD | The transaction was completed with a counterfeit card in a card-present environment and qualifies for the EMV liability shift. |
| EMV\_LIABILITY\_SHIFT\_NON\_COUNTERFEIT\_FRAUD | The transaction was completed in a card-present environment with a card that was reported lost or stolen and qualifies for the EMV liability shift. |
| INCORRECT\_ACCOUNT\_NUMBER | The account number is incorrect. |
| INCORRECT\_TRANSACTION\_AMOUNT | The transaction amount is incorrect. |
| INCORRECT\_TRANSACTION\_CODE | The transaction code is incorrect. |
| LATE\_PRESENTMENT | The card network cannot verify that the transaction amount was deposited within 30 days. |
| NO\_AUTHORIZATION | - Authorization was required, but not obtained.
- The primary account number (PAN) does not exist.
- A Card Not Present (CNP) transaction was initially declined but subsequently approved through stand-in processing. |
| NON\_RECEIPT\_OF\_CASH\_OR\_LOAD\_TRANSACTION\_VALUE\_AT\_ATM | The cardholder did not receive the full cash withdrawal or received only partial amount. |
| NOT\_AS\_DESCRIBED\_OR\_DEFECTIVE\_MERCHANDISE | The merchandise was not as described or defective. |
| NOT\_AUTHORIZED\_CARD\_ABSENT | An unauthorized user initiated the transaction and the card was not present. |
| NOT\_AUTHORIZED\_CARD\_PRESENT | The cardholder denies authorization of or participation in a key-entered transaction conducted in a card-present environment. |
| SERVICE\_NOT\_PROVIDED\_MERCHANDISE\_NOT\_RECEIVED | The goods or services were not provided. |
The pulseProcessingDisputeTypeDetails object
| Fields | Description |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| late\_presentment\_details
object
Conditionally required | An object providing late presentment details.
**Allowable Values:**
See The late\_presentment\_details object table. |
| incorrect\_transaction\_code\_details
object
Conditionally required | An object providing incorrect transaction code details.
**Allowable Values:**
See The incorrect\_transaction\_code\_details object table. |
| incorrect\_currency\_details
object
Conditionally required | An object providing incorrect currency details.
**Allowable Values:**
See The incorrect\_currency\_details object table. |
| incorrect\_account\_number\_details
object
Conditionally required | An object providing incorrect account number details.
**Allowable Values:**
See The incorrect\_account\_number\_details object table. |
| incorrect\_transaction\_amount\_details
object
Conditionally required | An object providing incorrect transaction amount details.
**Allowable Values:**
See The incorrect\_transaction\_amount\_details object table. |
| duplicate\_processing\_or\_paid\_by\_other\_means\_details
object
Conditionally required | An object providing details about duplicate processing or paid by other means.
**Allowable Values:**
See The duplicate\_processing\_or\_paid\_by\_other\_means\_details object table. |
The late\_presentment\_details object
| Fields | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| account\_status
string
Conditionally required | The account status. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
ACCOUNT\_CLOSED, CREDIT\_PROBLEM, FRAUD, NONSUFFICIENT\_FUNDS |
The incorrect\_transaction\_code\_details object
| Fields | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| how\_is\_transaction\_code\_incorrect
string
Conditionally required | The token of the original transaction under dispute. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
CREDIT\_INSTEAD\_OF\_REVERSAL\_OR\_ADJUSTMENT, CREDIT\_POSTED\_AS\_DEBIT, DEBIT\_POSTED\_AS\_CREDIT |
| explain\_why\_the\_credit\_refund\_was\_processed\_in\_error
string
Conditionally required | An explanation for why the credit refund was incorrectly processed. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:** |
The incorrect\_currency\_details object
| Fields | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| incorrect\_currency\_reason
string
Conditionally required | The reason for the incorrect currency. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
CURRENCY\_DIFFERENCE, DCC\_DISPUTE |
| what\_was\_the\_correct\_currency
integer
Conditionally required | An explanation for why the credit refund was incorrectly processed. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
ISO 4217 currency number |
| certification\_that\_the\_cardholder\_did\_ not\_agree\_to\_dynamic\_currency\_ conversion\_and\_did\_not\_make\_an\_ active\_choice
string
Conditionally required | Indicates that the cardholder did not agree to or make an active choice for dynamic currency conversion. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
true, false |
The incorrect\_account\_number\_details object
| Fields | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| is\_the\_account\_number\_on\_the\_issuers\_master\_file
boolean
Conditionally required | Indicates whether the cardholder’s account number is also in the issuer’s file. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
true, false |
| does\_the\_account\_number\_on\_the\_ receipt\_match\_the\_cardholders\_account\_ number\_or\_token
boolean
Conditionally required | Indicates whether the account numbers match. Whether this field is optional or required depends on previous answers provided by the cardholder.
**Allowable Values:**
true, false |
The incorrect\_transaction\_amount\_details object
| Fields | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| what\_is\_the\_amount\_on\_the\_cardholders\_receipt
number
Conditionally required | The amount on the cardholder’s receipt.
**Allowable Values:**
32 bytes |
| what\_is\_the\_currency\_on\_the\_cardholders\_receipt
string
Conditionally required | The currency on the cardholder’s receipt.
**Allowable Values:**
A valid currency code. |
| is\_the\_dispute\_due\_to\_the\_difference\_ between\_quoted\_price\_and\_actual\_ charges\_made\_by\_the\_merchant
boolean
Conditionally required | Indicates whether the dispute appeared due to the difference between quoted price and actual charges made by the merchant.
**Allowable Values:**
true, false |
Response body
| Fields | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
| type
string
Returned | Dispute case type.
**Allowable Values:**
DISPUTE |
| memo
string
Returned | Free-form comments about the dispute.
**Allowable Values:**
512 char max |
| program\_short\_code
string
Returned | Indicates which program the case belongs to.
**Allowable Values:**
10 char max |
| user\_token
string
Returned | Unique identifier of the cardholder who made the original transaction.
**Allowable Values:**
36 char max |
| business\_token
string
Returned | Unique identifier of the business involved in the dispute case.
**Allowable Values:**
36 char max |
| state
string
Returned | Indicates the current case state.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| assignee
string
Returned | Indicates who is working on the case.
**Allowable Values:**
255 char max |
| salesforce\_ticket\_id
string
Optional | Identifier of the Salesforce ticket.
**Allowable Values:**
255 char max |
| type\_change\_time
datetime
Optional | Date and time when the dispute case type was changed.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| dispute\_details
object
Returned | Details of the dispute case.
**Allowable Values:**
See The dispute\_details\_response object table. |
| created\_time
datetime
Returned | Date and time when the dispute case was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| updated\_time
datetime
Returned | Date and time when the dispute case was last updated.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Sample request body
```json JSON lines wrap theme={null}
{
"dispute_details": {
"dispute_reason": "NOT_AUTHORIZED_CARD_ABSENT",
"dispute_amount": 90.00,
"original_transaction_token": "b0c7a19e-e172-4c55-9af3-aad89c339b78",
"cardholder_contact_date": "2025-02-03T00:00:00Z"
},
"type": "DISPUTE"
}
```
Sample response body
```json JSON lines wrap theme={null}
{
"created_time": "2025-03-02T19:28:56Z",
"last_modified_time": "2025-03-02T19:28:56Z",
"token": "deqa-55349",
"type": "DISPUTE",
"user_token": "a5dc8fd4-c428-469c-ab6a-c2b2852771bc",
"state": "OPEN",
"dispute_details": {
"original_transaction_token": "b0c7a19e-e172-4c55-9af3-aad89c339b78",
"original_transaction_type": "authorization.clearing",
"dispute_amount": 90.00,
"currency_code": "GBP",
"dispute_reason": "NOT_AUTHORIZED_CARD_ABSENT",
"network": "PULSE",
"card_token": "8f49f6e5-ced2-4324-b930-829b3305f155",
"provisional_credit_granted": false,
"acquirer_fee": 0.0000,
"associated_transaction_selection_required": false
}
}
```
Retrieve dispute case
**Action:** `GET`\
**Endpoint:** `/cases/{token}`
Retrieve a specific dispute case.
URL path parameters
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case to retrieve.
**Allowable Values:**
36 char max |
Response body
| Fields | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | The unique identifier of the dispute case.
**Allowable Values:**
36 char max |
| type
string
Returned | Dispute case type.
**Allowable Values:**
DISPUTE |
| memo
string
Returned | Free-form comments about the dispute.
**Allowable Values:**
512 char max |
| program\_short\_code
string
Returned | Indicates what program the case belongs to.
**Allowable Values:**
10 char max |
| user\_token
string
Returned | Unique identifier of the cardholder that made the original transaction.
**Allowable Values:**
36 char max |
| business\_token
string
Returned | Unique identifier of the business involved in the dispute case.
**Allowable Values:**
36 char max |
| state
string
Returned | Indicates the current case state.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| assignee
string
Returned | Indicates who is working on the case.
**Allowable Values:**
255 char max |
| salesforce\_ticket\_id
string
Optional | Identifier of the Salesforce ticket.
**Allowable Values:**
255 char max |
| type\_change\_time
datetime
Optional | Date and time when the type was changed.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| dispute\_details
object
Returned | Details of the dispute case.
**Allowable Values:**
See The dispute details response object. |
| created\_time
datetime
Returned | Date and time when the dispute case was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| updated\_time
datetime
Returned | Date and time when the dispute case was last updated.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
```json JSON expandable lines wrap theme={null}
{
"count": 1,
"start_index": 1,
"end_index": 1,
"is_more": false,
"data": [
{
"created_time": "2025-03-02T19:28:56Z",
"last_modified_time": "2025-03-02T19:28:56Z",
"token": "deqa-55349",
"type": "DISPUTE",
"user_token": "a5dc8fd4-c428-469c-ab6a-c2b2852771bc",
"state": "OPEN",
"dispute_details": {
"original_transaction_token": "b0c7a19e-e172-4c55-9af3-aad89c339b78",
"original_transaction_type": "authorization.clearing",
"dispute_amount": 90.00,
"currency_code": "GBP",
"dispute_reason": "NOT_AUTHORIZED_CARD_ABSENT",
"network": "PULSE",
"card_token": "8f49f6e5-ced2-4324-b930-829b3305f155",
"provisional_credit_granted": false,
"acquirer_fee": 0.0000,
"associated_transaction_selection_required": false
}
}
]
}
```
List dispute cases
**Action:** `GET`\
**Endpoint:** `/cases`
List existing dispute cases. This endpoint supports [sorting and pagination](/core-api/sorting-and-pagination/).
Query parameters
| Fields | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 3ds
boolean
Optional | Returns dispute cases that involve 3D Secure.
**Allowable Values:**
true, false |
| assignee
string
Optional | Returns dispute cases associated with the specified assignee.
**Allowable Values:**
255 char max |
| associated\_transaction\_required
boolean
Optional | Returns dispute cases that have any associated transactions.
**Allowable Values:**
true, false |
| chargeback\_token
string
Optional | Returns dispute cases associated with the specified chargeback.
**Allowable Values:**
36 char max |
| dispute\_state
array of strings
Optional | Returns a comma-separated list of dispute states that will be used to filter the resulting case.
**Allowable Values:**
INITIATED, REPRESENTMENT, PRE\_ARBITRATION, ARBITRATION, CASE\_WON, CASE\_LOST, NETWORK\_REJECTED, CLOSED, WRITTEN\_OFF\_ISSUER, WRITTEN\_OFF\_PROGRAM |
| network\_case\_number
string
Optional | Returns dispute cases associated with the specified network case number.
**Allowable Values:**
Valid network case number |
| next\_actor
string
Optional | Returns the dispute cases associated with the specified next actor, such as ISSUER, ACQUIRER, COURT, or DISPUTE\_COMPLETED.
**Allowable Values:**
Existing next actor |
| original\_transaction\_token
string
Optional | Returns dispute cases associated with the specified token.
**Allowable Values:**
36 char max |
| reason
string
Optional | Returns disputes that are using the provided dispute reason.
**Allowable Values:**
See Dispute case reasons |
| state
string
Optional | Returns a comma-separated list of case states that will be used to filter the resulting case.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| type
string
Optional | Returns cases of the specified type.
**Allowable Values:**
DISPUTE |
| user\_token
string
Optional | Returns dispute cases associated with the specified user.
**Allowable Values:**
36 char max |
Response body
| Fields | Description |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | The unique identifier of the dispute case.
**Allowable Values:**
36 char max |
| type
string
Returned | Dispute case type.
**Allowable Values:**
DISPUTE |
| memo
string
Returned | Free-form comments about the dispute.
**Allowable Values:**
512 char max |
| program\_short\_code
string
Returned | Indicates what program the case belongs to.
**Allowable Values:**
10 char max |
| user\_token
string
Returned | Unique identifier of the cardholder who made the original transaction.
**Allowable Values:**
36 char max |
| business\_token
string
Returned | Unique identifier of the business involved in the dispute case.
**Allowable Values:**
36 char max |
| state
string
Returned | Indicates the current case state.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| assignee
string
Returned | Indicates who is working on the case.
**Allowable Values:**
255 char max |
| salesforce\_ticket\_id
string
Optional | Identifier of the Salesforce ticket.
**Allowable Values:**
255 char max |
| type\_change\_time
datetime
Optional | Date and time when the dispute case type was changed.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| dispute\_details
object
Returned | Details of the dispute case.
**Allowable Values:**
See The dispute details response object |
| created\_time
datetime
Returned | Date and time when the dispute case was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| updated\_time
datetime
Returned | Date and time when the dispute case was last updated.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
The dispute\_details\_response object
| Fields | Description |
| ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| original\_transaction\_token
string
Returned | Unique identifier of the original transaction under dispute.
**Allowable Values:**
36 char max |
| original\_transaction\_id
integer
Returned | Unique identifier of the original transaction under dispute.
**Allowable Values:**
36 char max |
| original\_transaction\_type
string
Returned | Transaction type of the original transaction under dispute.
**Allowable Values:**
255 char max |
| dispute\_amount
number
Returned | Amount of funds under dispute.
**Allowable Values:**
Must be less than or equal to the original transaction amount |
| dispute\_amount\_change\_reason
string
Returned | The reason the dispute amount has been changed from the transaction amount.
**Allowable Values:**
MERCHANT\_ISSUED\_PARTIAL\_REFUND, PARTIAL\_DISPUTE, NOT\_AS\_DESCRIBED\_PARTIAL, PARTIAL\_SERVICE, PRORATED\_REFUND, NOT\_AUTHORIZED\_FOR\_FULL\_AMOUNT |
| currency\_code
string
Returned | Currency in which the original transaction was made.
**Allowable Values:**
30 char max |
| dispute\_reason
string
Returned | Code describing the reason for the dispute.
**Allowable Values:**
See The dispute\_details.dispute\_reason field table |
| dispute\_state
string
Returned | The current dispute state. Once the case’s state has been moved to CHARGEBACK\_INITIATED, this field will be updated as it progresses in the backend lifecycle.
**Allowable Values:**
INITIATED, REPRESENTMENT, PRE\_ARBITRATION, ARBITRATION, CASE\_WON, CASE\_LOST, NETWORK\_REJECTED, CLOSED, WRITTEN\_OFF\_ISSUER, WRITTEN\_OFF\_PROGRAM |
| chargeback\_token
string
Returned | Indicates what is the associated chargeback in the legacy system. This is useful to map the current chargeback webhooks back a dispute case. This field is populated once the case state has moved to CHARGEBACK\_INITIATED. For Regulation E dispute cases, this value is returned after dispute case creation.
**Allowable Values:**
36 char max |
| network
string
Returned | Card network on which the transaction took place.
**Allowable Values:**
PULSE |
| network\_case\_number
string
Returned | Card network identifier of the dispute case.
**Allowable Values:**
A valid network case number |
| acquirer\_fee
number
Returned | Acquirer fee for the transaction.
**Allowable Values:**
Valid number |
| associated\_transaction\_selection\_ required
boolean
Returned | Indicates whether there are any transactions related to the original transaction.
**Allowable Values:**
true, false |
| card\_token
string
Returned | Unique identifier of the payment card used in the original transaction.
**Allowable Values:**
36 char max |
| pulseProcessingDisputeTypeDetails
object
Returned | Object providing details about processing error disputes.
**Allowable Values:**
See The pulseProcessingDisputeTypeDetails object table |
| consumer\_dispute\_type\_dispute\_details
object
Returned | Indicates the latest error that has occurred while the case is processed.
**Allowable Values:**
See The consumer\_dispute\_type\_dispute\_details object table |
| network\_case\_status\_details
object
Returned | Available once the case state has been successfully transitioned to CHARGEBACK\_INITIATED.
**Allowable Values:**
See The network\_case\_status\_details object table |
| additional\_dispute\_details
object
Optional | An object providing any additional information for a case.
**Allowable Values:**
See The additional\_dispute\_details object table |
| fraud\_dispute\_type\_details
object
Returned | Provides any additional information for cases with a fraud dispute reason. Contains the general\_fraud\_type\_dispute\_details object, which contains the chip\_on\_card boolean value, which is set to true if the card used for the original transaction had a chip.
**Allowable Values:**
true, false |
| network\_failure\_response
string
Returned | Indicates the latest error that has occurred while the case is processed.
**Allowable Values:**
255 char max |
| fraud\_category\_type\_dispute\_details
object
Returned | Additional information regarding a previously submitted fraud report in the network.
**Allowable Values:**
See The fraud\_category\_type\_dispute\_details object table |
| cardholder\_contact\_date
date
Returned | Date that the cardholder made initial contact regarding the dispute.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| provisional\_credit\_granted
boolean
Returned | Indicates whether the provisional credit was granted. Set to true whenever a credit has been granted through the cases endpoint.
**Allowable Values:**
true, false |
| regulation\_type
string
Returned | Regulation type of the dispute case. For Regulation E cases, this value is REG\_E.
**Allowable Values:**
255 char max |
The network\_case\_status\_details object
| Fields | Description |
| ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| network
string
Returned | Card network on which the original transaction originated and is being processed.
**Allowable Values:**
PULSE |
| network\_case\_number
string
Returned | Card network identifier for the case.
**Allowable Values:**
Valid network identifier |
| case\_status
string
Returned | Card network-specific value that represents the status of the case in the network.
**Allowable Values:**
Valid status value |
| current\_case\_amount
number
Returned | Current amount that has been disputed in the network.
**Allowable Values:**
Valid number |
| next\_actor
string
Returned | Indicates the actor who is currently expected to act upon the case.
**Allowable Values:**
ISSUER, ACQUIRER, DISPUTE\_COMPLETED, UNKNOWN |
| days\_to\_act
integer
Returned | Number of days left to act for the next\_actor before the dispute case defaults.
**Allowable Values:**
Valid integer |
| last\_action\_date
date
Returned | Date when the case was last updated in the card network.
**Allowable Values:**
Format: yyyy-MM-dd |
| case\_opened\_date
date
Returned | Date when the case was opened in the card network.
**Allowable Values:**
Format: yyyy-MM-dd |
| last\_refresh\_date
date
Returned | Date when the case was last refreshed from the card network to the Marqeta platform.
**Allowable Values:**
Format: yyyy-MM-dd |
| allowable\_actions
string
Returned | Actions allowed for the dispute case in the current dispute state.
**Allowable Values:**
SUBMIT, ACCEPT\_AND\_CLOSE, RESPOND\_WITH\_PREARB, RESPOND\_WITH\_PREARB\_RESPONSE, RESPOND\_WITH\_ARB, WAIT, REPRESENTMENT\_RECEIVED, PREARB\_RECEIVED, PREARB\_ACCEPTED, PREARB\_DECLINED, PREARB\_RESPONSE\_DECLINED, CLOSE\_WITH\_CASE\_WON |
Sample response body
```json JSON expandable lines wrap theme={null}
{
"count": 1,
"start_index": 0,
"end_index": 0,
"is_more": true,
"data": [
{
"token": "string",
"type": "DISPUTE",
"memo": "Multiple browser submission",
"program_short_code": "string",
"user_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"business_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "OPEN",
"assignee": "string",
"dispute_details": {
"original_transaction_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"original_transaction_type": "transaction_type",
"dispute_amount": 120.49,
"dispute_amount_change_reason": "MERCHANT_ISSUED_PARTIAL_REFUND",
"currency_code": "480",
"dispute_reason": "SERVICE_NOT_PROVIDED_MERCHANDISE_NOT_RECEIVED",
"dispute_state": "INITIATED",
"chargeback_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"network": "PULSE",
"network_case_number": "string",
"acquirer_fee": 0,
"associated_transaction_selection_required": "true",
"card_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"network_failure_response": "string",
"pulseProcessingDisputeTypeDetails": {
"late_presentment_details": {
"account_status": "ACCOUNT_CLOSED"
},
"incorrect_transaction_code_details": {
"how_is_transaction_code_incorrect": "CREDIT_INSTEAD_OF_REVERSAL_OR_ADJUSTMENT",
"explain_why_the_credit_refund_was_processed_in_error": "string"
},
"incorrect_account_number_details": {
"is_the_account_number_on_the_issuers_master_file": true,
"does_the_account_number_on_the_receipt_match_the_cardholders_account_number_or_token": true
},
"incorrect_transaction_amount_details": {
"what_is_the_amount_on_the_cardholders_receipt": 0,
"what_is_the_currency_on_the_cardholders_receipt": "string"
}
},
"consumer_dispute_type_dispute_details": {
"service_not_provided_merchandise_not_received_details": {
"detailed_description_of_what_was_purchased_and_explanation_of_the_dispute": "string",
"expected_receipt_date": "2025-01-31",
"expected_receipt_time": "2025-01-31",
"did_cardholder_cancel_prior_to_the_expected_date": true,
"cancellation_date": "2025-01-31",
"cancellation_reason": "string",
"did_cardholder_attempt_to_resolve_dispute_with_merchant": true,
"is_attempt_to_resolve_prohibited_by_local_law_or_regulations": true,
"provide_details_of_local_law_or_regulations": "string",
"merchandise_or_services": "MERCHANDISE SERVICES",
"was_merchandise_delivered_to_wrong_location": true,
"address_of_agreed_location": "string",
"did_cardholder_return_merchandise": true,
"date_cardholder_returned_merchandise": "2025-01-31",
"date_merchant_received_returned_merchandise": "2025-01-31",
"did_cardholder_attempt_to_return_merchandise": true,
"date_of_attempted_return": "2025-01-31",
"explain_how_merchandise_was_returned": "string",
"third_party_gift_card_indicator": true,
"pulse_commercial_card_virtual_account_indicator": true,
"did_virtual_account_holder_suffer_financial_loss": true,
"did_merchant_cancel_services": true,
"date_merchant_cancelled_services": "2025-01-31",
"explanation_dispute_prior_expected_delivery_date": "string"
},
"cancelled_recurring_transaction_details": {
"cancellation_date": "2025-01-31",
"cancellation_reason": "string",
"date_issuer_informed_merchant_of_account_closure": "2025-01-31"
},
"not_as_described_or_defective_merchandise_details": {
"not_as_described_or_defective": "NOT_AS_DESCRIBED DEFECTIVE",
"merchandise_or_services": "MERCHANDISE SERVICES",
"date_the_cardholder_first_notified_the_issuer_of_the_dispute": "2025-01-31",
"did_the_cardholder_attempt_to_resolve_the_dispute_with_the_merchant": true,
"is_attempt_to_resolve_prohibited_by_local_law_or_regulations": true,
"provide_details_of_local_law_or_regulations": "string",
"did_the_cardholder_return_the_merchandise": true,
"date_cardholder_returned_the_merchandise": "2025-01-31",
"date_merchant_received_the_returned_merchandise": "2025-01-31",
"return_method": "F2F",
"tracking_number": "string",
"date_of_attempted_return": "2025-01-31",
"provide_a_detailed_description_of_how_the_cardholder_attempted_to_return_and_the_disposition_of_the_merchandise": "string",
"did_the_cardholder_attempt_to_return_the_merchandise": true,
"explain_how_the_merchandise_was_returned": "string",
"cardholder_merchant_previous_negotiation_evidence": true,
"explain_prev_negotiation": "string",
"when_negotiations_begin": "2025-01-31",
"date_merchandise_or_service_was_received": "2025-01-31",
"does_the_dispute_involve_merchandise_or_services_provided_that_do_not_match_the_merchants_verbal_description": true,
"did_the_merchandise_or_services_differ_from_what_was_described_on_the_receipt": true,
"provide_details_of_what_was_ordered_and_not_as_described": "string",
"did_the_cardholder_cancel_the_services": true,
"cancellation_date": "2025-01-31",
"cancellation_reason": "string",
"what_was_ordered_and_how_it_was_damaged_or_defective": "string",
"date_merchandise_was_received": "2025-01-31"
},
"credit_not_processed_details": {
"was_a_credit_voucher_voided_transaction_receipt_or_refund_acknowledgement_given": true,
"is_the_credit_voucher_transaction_receipt_or_refund_acknowledgement_dated": true,
"credit_voucher_transaction_receipt_or_refund_acknowledgement_date": "2025-01-31",
"date_cardholder_returned_cancelled_merchandise": "string"
},
"cancelled_merchandise_or_services_details": {
"merchandise_or_services": "MERCHANDISE SERVICE",
"describe_what_was_purchased": "string",
"date_cardholder_received_or_expected_to_receive_merchandise": "2025-01-31",
"did_the_cardholder_attempt_to_resolve_the_dispute_with_the_merchant": true,
"is_attempt_to_resolve_prohibited_by_local_law_or_regulations": true,
"provide_details_of_local_law_or_regulations": "string",
"did_the_cardholder_return_the_merchandise": true,
"date_of_return": "2025-01-31",
"date_merchant_received_returned_merchandise": "2025-01-31",
"return_method": "F2F",
"tracking_number": "string",
"explain_how_the_merchandise_was_returned": "string",
"did_the_cardholder_attempt_to_return_the_merchandise": true,
"date_of_attempted_return": "2025-01-31",
"detailed_description_of_how_the_cardholder_attempted_to_return_and_the_disposition_of_the_merchandise": "2025-01-31",
"did_cardholder_cancel": true,
"cancellation_date": "2025-01-31",
"cancellation_reason": "string",
"was_cancellation_policy_provided": true,
"type_of_service": "TIMESHARE",
"date_of_service_or_expected_service": "2025-01-31",
"cancelled_guaranteed_reservation_certification_selection": "string"
}
},
"fraud_dispute_type_details": {
"general_fraud_type_dispute_details": {
"chip_on_card": true
}
},
"network_case_status_details": {
"network": "PULSE",
"network_case_number": "string",
"case_status": "string",
"current_case_amount": 0,
"next_actor": "ISSUER",
"days_to_act": 0,
"last_action_date": "2025-01-31T18:57:42.890Z",
"case_opened_date": "2025-01-31",
"last_refresh_date": "2025-01-31T18:57:42.890Z",
"allowable_actions": [
"SUBMIT"
]
},
"fraud_category_type_dispute_details": {
"fraud_report_details": {
"fraud_type": "LOST",
"fraud_type_code": "string",
"fraud_report_id": 0,
"fraud_type_category": "string"
}
}
},
"created_time": "2025-01-31T18:57:42.890Z",
"updated_time": "2025-01-31T18:57:42.890Z"
}
]
}
```
Create dispute case transition
**Action:** `POST`\
**Endpoint:** `/cases/{token}/transitions`
Transition a dispute case to another state or initiate a chargeback against the dispute case.
A dispute case transition is an event that changes the state of a dispute case and triggers other related events. The new state of the dispute case and which related events are triggered is determined by the action defined in the dispute case transition.
URL path parameters
| Fields | Description |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case associated with the transition you want to create.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
Body field details
| Fields | Description |
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Optional | Unique identifier of the dispute case transition. If you do not include a token, the system generates one automatically.
**Allowable Values:**
36 char max |
| action
string
Required | Action taken on the dispute case.
**Allowable Values:**
See Dispute case transitions |
| reason\_code
string
Required | Identifies the standardized reason for the transition.
**Allowable Values:**
See The transition reason\_code field table |
| created\_by
string
Required | Identifier or name of the user who created the transition.
**Allowable Values:**
255 char max |
| assignee
string
Optional | Identifier or name of the user assigned to the dispute case.
**Allowable Values:**
255 char max |
| memo
string
Optional | Additional notes about the transition.
**Allowable Values:**
16,777,215 char max |
| transition\_details
object
Required | An object containing the transition details.
**Allowable Values:**
See The transition\_details object |
The transition\_details object
| Fields | Description |
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| chargeback\_details
object
Required | Object containing the chargeback details.
**Allowable Values:**
See The chargeback\_details object. |
The chargeback\_details object
| Fields | Description |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| attached\_contents
string
Required | List of content tokens that should be submitted to the network when initiating a chargeback. The content tokens should be associated to the case. For more information about the uploading case documents, see Create dispute case content.
**Allowable Values:**
List of valid UUID tokens |
Dispute case transitions
Dispute case transitions represent the workflow during the creation, information gathering, and submission processes a dispute case. The dispute case transition actions and resulting states are described below.
| Action | Reason Code | Resulting State | Description |
| ----------------------------------- | ----------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CREATE | N/A | OPEN, OPEN\_WITH\_ACTION\_REQUIRED | Creates a new dispute case. A default action when a POST request is sent to the /cases endpoint. The OPEN\_WITH\_ACTION\_REQUIRED state results if additional information is needed from the user.
For programs that are enabled for Regulation E, this action and reason code returns an error for a Regulation E dispute and sets provisionalCreditGranted to true. |
| RE\_OPEN | N/A | OPEN | Reopens a dispute case to get additional information or documents. Dispute case state changes to OPEN. |
| CHARGEBACK\_CREDIT | 28 | CHARGEBACK\_INITIATED | Sends a POST request to the \cases endpoint with credit\_user set to true. Set reason\_description as the value of dispute\_reason and channel as ISSUER\_AUTOMATED when creating the chargeback.
Dispute case state changes to CHARGEBACK\_INITIATED if no additional information is required. The OPEN\_WITH\_ACTION\_REQUIRED state results if additional information is needed from the user before the chargeback can be submitted to the network.
Only for programs that are not enabled for Regulation E. |
| CHARGEBACK\_NO\_CREDIT | 29 | CHARGEBACK\_INITIATED | Sends a POST request to the \cases endpoint with credit\_user set to false. Set reason\_description as the value of dispute\_reason and channel as ISSUER\_AUTOMATED when creating the chargeback.
Dispute case state changes to CHARGEBACK\_INITIATED if no additional information is required. The OPEN\_WITH\_ACTION\_REQUIRED state results if additional information is needed from the user before the chargeback can be submitted to the network.
Only for programs that are not enabled for Regulation E. For programs that are enabled for Regulation E, this action and reason code return an error for a Regulation E dispute. |
| CHARGEBACK\_SUBMIT | 51 | CHARGEBACK\_INITIATED | Submitting dispute to the network. This applies only to programs that are enabled for Regulation E and for a Regulation E dispute. If provisional credit has not been granted, this returns an error. For programs that are not enabled for Regulation E, this returns an error. |
| REVIEW | N/A | READY | Dispute case is ready to review. Dispute case state changes to READY. |
| ASSIGN | N/A | No change | Assigns a dispute case to a user. An assignee value is required. Does not change dispute case state. |
| CLOSE | 41 | CLOSED | Closes the dispute case.
The case was won. Dispute case state changes to CLOSED. For all types of dispute cases, this action cannot be triggered until dispute\_state is in a CASE\_WON state. |
| CLOSE | 42 | CLOSED/PENDING\_CLOSED | Closes the dispute case. The case was lost. For non-Regulation E cases, this results in the CLOSED state. For Regulation E cases, this results in the PENDING\_CLOSED state. |
| CLOSE | 45 | CLOSED | Closes the dispute case. Dispute case state changes to CLOSED. This reason code indicates that the case will be closed and written off using funds from the program account. |
| WITHDRAW\_AND\_CLOSE | 40 | CLOSED | No further action is needed, closing the case by withdrawing.
This action can only be taken from the OPEN or OPEN\_WITH\_ACTION\_REQUIRED state and when provisional credit has not been granted. |
| WRITE\_OFF | N/A | No change | Written off either by user or program. |
| GRANT\_CREDIT | N/A | No change | Granting provisional credit. |
| REVERT\_CREDIT | N/A | No change | Reverting provisional credit. |
| CHANGE\_CASE\_TYPE | N/A | No change | Change case from DISPUTE type to the LEGACY\_DISPUTE type. |
The transition reason\_code field
The transition reason code identifies the standardized reason for the transition.
| Reason Code | Description | Related Actions |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| 00 | The dispute case was created. | CREATE |
| 01 | The dispute case was created, but needs additional verification actions. | CREATE |
| 05 | The dispute case is under review. | REVIEW |
| 14 | The Marqeta platform updated the dispute case. | CLOSE, NON\_CHARGEBACK\_CREDIT |
| 22 | The dispute case was assigned to a user. | ASSIGN |
| 23 | The dispute case was reopened. | RE\_OPEN |
| 24 | The dispute case was reopened to gather more information. | RE\_OPEN |
| 25 | The documents were verified and the dispute case is being closed. | CLOSE |
| 26 | The customer closed the dispute case. | CLOSE |
| 27 | The dispute is for a smaller amount and no chargeback is needed. | NON\_CHARGEBACK\_CREDIT |
| 28 | A chargeback was created and the cardholder was credited.
Only for programs that are not enabled for Regulation E. | CHARGEBACK\_CREDIT |
| 29 | A chargeback was created and the cardholder was not credited.
Only for programs that are not enabled for Regulation E. | CHARGEBACK\_NO\_CREDIT |
| 30 | The dispute case was closed automatically due to inactivity. | CLOSE, WITHDRAW\_AND\_CLOSE |
| 34 | The chargeback failed.
Only for programs that are not enabled for Regulation E. | CHARGEBACK\_CREDIT, CHARGEBACK\_NO\_CREDIT |
| 35 | The chargeback failed at the card network.
Only for programs that are not enabled for Regulation E. | CHARGEBACK\_CREDIT, CHARGEBACK\_NO\_CREDIT, CLOSE |
| 36 | KYC override failed. | KYC\_OVERRIDE |
| 39 | Associated transaction selection is required to ready this dispute case. | N/A |
| 40 | No further action is needed. Closing the dispute case by withdrawing.
Only used when the provisional credit has not been granted in the OPEN and OPEN\_WITH\_ACTION\_REQUIRED states. For Regulation E and non-Regulation E cases, this results in the CLOSED state and the chargeback is WITHDRAWN. | WITHDRAW\_AND\_CLOSE |
| 41 | The dispute case was won, accepted with favorable results, for to all types of dispute cases.
This action cannot trigger until the dispute\_state is CASE\_WON. | CLOSE |
| 42 | The dispute case was lost, accepted with unfavorable results.
For non-Regulation E dispute cases, this results in the CLOSED state. For Regulation E dispute cases, this results in PENDING\_CLOSED. | CLOSE |
| 43 | The dispute case was rejected by the network. | CLOSE |
| 44 | The dispute case was written off by the issuer. | WRITE\_OFF, CLOSE |
| 45 | The dispute case was closed and written off by the program using funds from the program account. | WRITE\_OFF, CLOSE |
| 46 | Provisional credit has been granted. | GRANT\_CREDIT |
| 47 | Provisional credit has been reverted. | REVERT\_CREDIT |
| 48 | A failure occurred when attempting to transition to the READY state. | No change |
| 49 | The dispute case was reported to the network as FRAUD. | WITHDRAW\_AND\_CLOSE |
| 50 | The dispute case was changed from DISPUTE type to LEGACY\_DISPUTE type. | CHANGE\_CASE\_TYPE |
| 51 | Submitting dispute to the network.
This applies only to programs that are enabled for Regulation E and for a Regulation E dispute. If provisional credit has not been granted, this returns an error. For programs that are not enabled for Regulation E, this returns an error. | CHARGEBACK\_SUBMIT |
| 52 | Provisional credit is required for a Regulation E dispute case. | N/A |
| 53 | Awaiting milestone. | N/A |
Dispute transition response
| Fields | Description |
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| case\_token
string
Returned | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
| token
string
Returned | Unique identifier of the dispute case transition.
**Allowable Values:**
36 char max |
| action
string
Returned | Action taken on the dispute case.
**Allowable Values:**
See Dispute case transitions |
| reason\_code
string
Returned | Identifies the standardized reason for the transition.
**Allowable Values:**
See The transition reason\_code field table |
| reason\_description
string
Returned | Descriptive reason for the transition.
**Allowable Values:**
36 char max |
| created\_by
string
Returned | Identifier or name of the user who created the transition.
**Allowable Values:**
36 char max |
| from\_state
string
Returned | State of the dispute case before the case transition was created.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| state
string
Returned | Resulting state of the dispute case after the transition was created.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
| assignee
string
Returned | Identifier or name of the user assigned to the dispute case.
**Allowable Values:**
255 char max |
| memo
string
Returned | Additional notes about the transition.
**Allowable Values:**
512 char max |
| failure\_reason
string
Returned | If an error occurred while attempting to transition the dispute case, this field provides a brief description of the failure.
**Allowable Values:**
512 char max |
| transition\_details
object
Returned | Object containing the transition details.
**Allowable Values:**
See The transition\_details object. |
Sample request body (CHARGEBACK\_CREDIT)
This sample is only for programs that are not enabled for Regulation E.
```json JSON lines wrap theme={null}
{
"token": "dispute_case_token",
"action": "CHARGEBACK_CREDIT",
"reason_code": "28",
"created_by": "user_name",
"assignee": "assignee_name",
"memo": "Text about this dispute",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
}
```
Sample response body (CHARGEBACK\_CREDIT)
This sample is only for programs that are not enabled for Regulation E.
```json JSON lines wrap theme={null}
{
"case_token": "my_case_id",
"token": "my_casetransition_id",
"action": "CHARGEBACK_CREDIT",
"reason_code": "28",
"reason_description": "Smaller Amount",
"created_by": "user_name",
"from_state": "OPEN",
"state": "CHARGEBACK_INITIATED",
"assignee": "assignee_name",
"memo": "Text about this dispute",
"failure_reason": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
}
```
Sample request body (CHARGEBACK\_NO\_CREDIT)
```json JSON lines wrap theme={null}
{
"token": "dispute_case_token",
"action": "CHARGEBACK_NO_CREDIT",
"reason_code": "29",
"created_by": "user_name",
"assignee": "assignee_name",
"memo": "Initiating chargeback",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
}
```
Sample response body (CHARGEBACK\_NO\_CREDIT)
```json JSON lines wrap theme={null}
{
"case_token": "my_case_id",
"token": "my_casetransition_id",
"action": "CHARGEBACK_N0_CREDIT",
"reason_code": "29",
"reason_description": "Smaller Amount",
"created_by": "user_name",
"from_state": "OPEN",
"state": "CHARGEBACK_INITIATED",
"assignee": "assignee_name",
"memo": "Initiating chargeback",
"failure_reason": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
}
```
Response action/reason code changes
There are some cases where the reason code is changed by the system for either of two reasons:
* An error occurred while processing a transition.
* The dispute case transition moved the case to a state different from the desired state.
| Action | Reason Code | Resulting State | Description |
| ------------------------------- | ----------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CHARGEBACK\_SUBMIT | 52 | OPEN\_WITH\_ACTION\_REQUIRED | Triggered during an attempt to transition a dispute case with action CHARGEBACK\_SUBMIT and reason code 51. Occurs when attempting to transition a Regulation E dispute case that has not granted provisional credit. |
| CLOSE | 53 | PENDING\_CLOSED | Triggered during an attempt to transition a dispute case with action CLOSED and reason code 42. Occurs for Regulation E cases to indicate that the customer must first notify the cardholder before reverting the credit, as required by Regulation E, and must wait a specified number of days before reverting credit. |
Sample response body (ACTION/REASON CODE CHANGES)
```json JSON lines wrap theme={null}
{
"token": "string",
"case_token": "string",
"reason_code": "51",
"reason_description": "Submit case to the card network",
"created_by": "string",
"from_state": "READY",
"state": "CHARGEBACK_INITIATED",
"action": "CHARGEBACK_SUBMIT",
"memo": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": ["uuid"]
}
}
}
```
Transition failure response
An error occurs when attempting to transition a dispute case using `CHARGEBACK_SUBMIT` when the dispute has no provisional credit granted.
Error response
| Error Code | Error Message | Description |
| ---------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400400 | Attempted to close case as case won when the dispute state is not set to CASE\_WON | Triggered when an attempt to close a case as CASE\_WON without having it be won in the backend lifecycle. |
| 400400 | Cannot write off cases that haven’t granted provisional credit | Triggered during an attempt to transition a case with action CLOSE and reason code 45. Occurs for Regulation E cases if provisional credit has not been granted. Solution: Close the case using WITHDRAW\_AND\_CLOSE. |
| 400401 | Case is no longer applicable as case lost under RegE | Triggered during an attempt to transition a dispute case with action CLOSE and reason code 42. Occurs for Regulation E cases that are past the Regulation E 45-day time limit.
Solution: Close the case with reason code 45. |
| 400400 | Invalid Action for Current State | Triggered during CHARGEBACK\_SUBMIT if the program is not Regulation E enabled. Triggered during CHARGEBACK\_CREDIT or CHARGEBACK\_NO\_CREDIT when attempting to use this action to transition a REG\_E case. |
| 400400 | Unable to withdraw and close because provisional credit has been granted | Triggered during an attempt to transition a case with WITHDRAW\_AND\_CLOSE when the provisional credit has been granted. |
| 400400 | Waiting for provisional credit to be reversed before the case can be closed | Triggered during an attempt to transition a case with action CLOSE and reason code 42. Occurs if the case is in PENDING\_CLOSED state and the reversal of provision credit has not occurred.
Solution: Wait for the provisional credit to be reversed. |
Sample response body (TRANSITION FAILURE RESPONSE)
```json JSON lines wrap theme={null}
{
"token": "string",
"case_token": "string",
"reason_code": "52",
"reason_description": "Provisional credit required",
"created_by": "string",
"from_state": "READY",
"state": "OPEN_WITH_ACTION_REQUIRED",
"action": "CHARGEBACK_SUBMIT",
"memo": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": ["uuid"]
}
}
}
```
Retrieve dispute case transition
**Action:** `GET`\
**Endpoint:** `/cases/{token}/transitions/{transition_token}`
Retrieve a specific dispute case transition for a specific dispute case.
A dispute case transition is an event that changes the state of a dispute case and triggers other related events. The new state of the dispute case and which related events are triggered is determined by the action defined in the dispute case transition.
URL path parameters
| Fields | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token
string
Required | Unique identifier of the dispute case associated with the transitions you want to retrieve.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
| transition\_token
string
Required | Unique identifier of the transition to retrieve.
Send a GET request to /cases/{token}/transitions to retrieve dispute case transition tokens.
**Allowable Values:**
36 char max |
Retrieve dispute case transition response
See [Dispute transition response](#_dispute_transition_response).
Sample response body
```json JSON lines wrap theme={null}
{
"case_token": "string",
"token": "string",
"action": "CREATE",
"reason_code": "44",
"reason_description": "string",
"created_by": "string",
"from_state": "OPEN",
"state": "OPEN",
"assignee": "string",
"memo": "string",
"failure_reason": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
}
```
List dispute case transitions
**Action:** `GET`\
**Endpoint:** `/cases/{token}/transitions`
List existing dispute case transitions for the specified dispute case. This endpoint supports [sorting and pagination](/core-api/sorting-and-pagination/).
URL path parameters
| Fields | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case associated with the transitions you want to list.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
Query parameters
| Fields | Description |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| state
string
Optional | Filter dispute case transitions that contain the specified resulting state.
**Allowable Values:**
OPEN, OPEN\_WITH\_ACTION\_REQUIRED, READY, CHARGEBACK\_INITIATED, CLOSED |
List dispute case transition response
See [Dispute transition response](#_dispute_transition_response).
Sample response body
```json JSON expandable lines wrap theme={null}
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"case_token": "my_case_id",
"token": "my_casetransition_id1",
"action": "CHARGEBACK_CREDIT",
"reason_code": "28",
"reason_description": "Smaller Amount",
"created_by": "string",
"from_state": "OPEN",
"state": "OPEN",
"assignee": "string",
"memo": "Initiating chargeback",
"failure_reason": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
}
},
{
"case_token": "my_case_id",
"token": "my_casetransition_id2",
"action": "ASSIGN",
"reason_code": "05",
"reason_description": "Under Review",
"created_by": "user_name",
"from_state": "READY",
"state": "OPEN",
"assignee": "string",
"memo": "Assigned to user",
"failure_reason": "string",
"transition_details": {
"chargeback_details": {
"attached_contents": [
"4fa85f64-5719-4561-b3fa-2c963f66abc9"
]
}
}
}
]
}
```
Create network dispute transition
**Action:** `POST`\
**Endpoint:** `/cases/{token}/disputetransitions`
Create a network dispute transition.
A network dispute transition is an event that changes the network state of a dispute and triggers other related events. The new state of the dispute within the network dispute lifecycle and which related events are triggered is determined by the action defined in the network dispute transition.
URL path parameters
| Fields | Description |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute associated with the transition you want to create.
Send a GET request to /cases to retrieve case tokens.
**Allowable Values:**
36 char max |
Request body
| Fields | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action
string
Required | Action to take:
- RESPOND\_WITH\_PREARB: Action to move a dispute to prearbitration with PULSE.
- RESPOND\_WITH\_ARB: Action to move a prearbitration disputes to arbitration.
- RESPOND\_WITH\_PREARB\_RESPONSE: Respond to the prearbitration response.
- ACCEPT\_AND\_CLOSE: Action to accept the dispute decision and close the dispute.
- CLOSE\_WITH\_CASE\_WON: Close with case won dispute transition.
- CLOSE\_WITH\_NETWORK\_REJECTED: Close with network rejected.
- REPRESENTMENT\_RECEIVED: Indicates that representment was received.
**Allowable Values:**
RESPOND\_WITH\_PREARB, RESPOND\_WITH\_ARB, RESPOND\_WITH\_PREARB\_RESPONSE, ACCEPT\_AND\_CLOSE, CLOSE\_WITH\_CASE\_WON, CLOSE\_WITH\_NETWORK\_REJECTED, REPRESENTMENT\_RECEIVED |
| created\_by
string
Optional | Indicates the user who is creating the transition.
**Allowable Values:**
255 char max |
| memo
string
Optional | A memo regarding the transaction.
**Allowable Values:**
16777215 char max |
| network\_details
object
Conditionally required | Card network details.
**Allowable Values:**
See The network\_details object table |
The network\_details object
Depending on the transition, contains the `prearbitration_details` object or the `arbitration_details` object.
| Fields | Description |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| prearbitration\_details
object
Optional | Object defining the prearbitration details.
**Allowable Values:**
See The prearbitration\_details object table |
| prearbitration\_response\_details
object
Optional | Object defining the prearbitration response details.
**Allowable Values:**
See The prearbitration\_response\_details object table |
| arbitration\_details
object
Optional | Object defining the arbitration details.
**Allowable Values:**
See The arbitration\_details object table |
| representment\_details
object
Optional | Object defining the network state details.
**Allowable Values:**
See The network\_state\_details object table |
| case\_close\_details
string
Optional | The new dispute state.
**Allowable Values:**
See The case\_close\_details object table |
The prearbitration\_details object
The details for prearbitration.
| Fields | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| amount
number
Required | Amount in dispute.
**Allowable Values:**
32 bytes |
| attached\_contents
string
Optional | Content token for documents to be submitted to the network at the current dispute state.
**Allowable Values:**
256 char max |
| why\_are\_you\_initiating\_prearbitration
string
Required | The reason you are initiating prearbitration.
**Allowable Values:**
255 char max |
| are\_you\_providing\_new\_information
boolean
Required | Indicates whether this state change includes new information useful for the dispute.
**Allowable Values:**
true, false |
| summary\_of\_new\_information
string
Conditionally required. | A summary of the new information provided.
**Allowable Values:**
255 char max |
The prearbitration\_response\_details object
The details for prearbitration response.
| Fields | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| attached\_contents
string
Optional | Content token for documents to be submitted to the network at the current dispute state.
**Allowable Values:**
255 char max |
| prearbitration\_response\_decision
string
Required | The prearbitration response decision.
**Allowable Values:**
ACCEPT\_PARTIAL, DECLINE |
| amount
string
Required | The partial acceptance amount.
**Allowable Values:**
32 bytes |
The arbitration\_details object
The details for arbitration.
| Fields | Description |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| attached\_contents
string
Optional | Content token for documents to be submitted to the network at the current dispute state.
**Allowable Values:**
255 char max |
The representment\_details object
The details for representment transition.
| Fields | Description |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| amount
number
Required | Amount in dispute.
**Allowable Values:**
Min: 0.1 |
| attached\_contents
string
Optional | Content token for documents to be submitted to the network at the current dispute state.
**Allowable Values:**
255 char max |
The case\_close\_details object
The details for case close transition details.
| Fields | Description |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| write\_off
boolean
Optional | Indicates whether the write-off due to the case lost happened.
**Allowable Values:**
true, false |
The network\_details\_response object
Depending on the transition, contains the `prearbitration_details` object or the `arbitration_details` object.
| Fields | Description |
| ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| prearbitration\_details
object
Optional | Object defining the prearbitration details.
**Allowable Values:**
See The prearbitration\_details object table |
| prearbitration\_response\_details
object
Optional | Object defining the prearbitration response details.
**Allowable Values:**
See The prearbitration\_response\_details object table |
| arbitration\_details
object
Optional | Object defining the arbitration details.
**Allowable Values:**
See The arbitration\_details object table |
| representment\_details
object
Optional | Object defining the network state details.
**Allowable Values:**
See The network\_state\_details object table |
| network\_state\_details
string
Optional | A JSON object, containing the details, received from the network.
**Allowable Values:**
Valid JSON object |
| dispute\_state
string
Optional | After the case’s state has been moved to CHARGEBACK\_INITIATED, this field will be updated as it progresses in the backend lifecycle.
**Allowable Values:**
INITIATED, REPRESENTMENT, PRE\_ARBITRATION, ARBITRATION, CASE\_WON, CLOSED, NETWORK\_REJECTED, CASE\_LOST, WRITTEN\_OFF\_ISSUER, WRITTEN\_OFF\_PROGRAM |
| case\_close\_details
string
Optional | New dispute case state.
**Allowable Values:**
See The case\_close\_details object table |
Sample request with prearbitration
```json JSON expandable lines wrap theme={null}
{
"action": "RESPOND_WITH_PREARB",
"created_by": "user_name",
"memo": "pre-arb transition for testing",
"network_details": {
"prearbitration_details": {
"amount": 112.0,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 0.10,
"attached_contents": [
"string"
]
},
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample response with prearbitration
```json JSON expandable lines wrap theme={null}
{
"token": "my_dispute_transition_token",
"created_time": "2024-07-20T22:10:57.423Z",
"last_modified_time": "2024-07-20T22:10:57.423Z",
"case_token": "my_case_token",
"action": "RESPOND_WITH_PREARB",
"created_by": "user_name",
"memo": "pre-arb transition for testing",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "network_dispute_id",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"content_token"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"content_token"
]
},
"representment_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"network_state_details": "string",
"dispute_state": "INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample request with arbitration
```json JSON expandable lines wrap theme={null}
{
"action": "RESPOND_WITH_ARB",
"created_by": "user_name",
"memo": "arbitration response transition response for testing",
"network_details": {
"prearbitration_details": {
"amount": 112.0,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 0.1,
"attached_contents": [
"string"
]
},
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample response with arbitration
```json JSON expandable lines wrap theme={null}
{
"token": "my_dispute_transition_token",
"created_time": "2024-07-20T22:10:57.423Z",
"last_modified_time": "2024-07-20T22:10:57.423Z",
"case_token": "my_case_token",
"action": "RESPOND_WITH_ARB",
"created_by": "user_name",
"memo": "Arbitration response transition response for testing",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "network_dispute_id",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"content_token"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"content_token"
]
},
"representment_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"network_state_details": "string",
"dispute_state": "INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample accept and close dispute request
```json JSON expandable lines wrap theme={null}
{
"action": "ACCEPT_AND_CLOSE",
"created_by": "user_name",
"memo": "accept and close",
"network_details": {
"prearbitration_details": {
"amount": 112.0,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 0.1,
"attached_contents": [
"string"
]
},
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample accept and close dispute response
```json JSON expandable lines wrap theme={null}
{
"token": "my_dispute_transition_token",
"created_time": "2024-07-20T22:10:57.423Z",
"last_modified_time": "2024-07-20T22:10:57.423Z",
"case_token": "my_case_token",
"action": "ACCEPT_AND_CLOSE",
"created_by": "user_name",
"memo": "accept and close",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "network_dispute_id",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"content_token"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"content_token"
]
},
"representment_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"network_state_details": "string",
"dispute_state": "INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample close with case won dispute request
```json JSON expandable lines wrap theme={null}
{
"action": "CLOSE_WITH_CASE_WON",
"created_by": "user_name",
"memo": "close with case won",
"network_details": {
"prearbitration_details": {
"amount": 112.0,
"attached_contents": [
"content_token"
],
"why_are_you_initiating_prearbitration": "string",
"are_you_providing_new_information": true,
"summary_of_new_information": "string"
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 0.10,
"attached_contents": [
"string"
]
},
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample close with case won dispute response
```json JSON expandable lines wrap theme={null}
{
"token": "my_dispute_transition_token",
"created_time": "2024-07-20T22:10:57.423Z",
"last_modified_time": "2024-07-20T22:10:57.423Z",
"case_token": "my_case_token",
"action": "CLOSE_WITH_CASE_WON",
"created_by": "user_name",
"memo": "close with case won",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "network_dispute_id",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"prearbitration_response_details": {
"attached_contents": [
"content_token"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"content_token"
]
},
"representment_details": {
"amount": 112.5,
"attached_contents": [
"content_token"
]
},
"network_state_details": "string",
"dispute_state": "INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Create ACCEPT\_AND\_CLOSE transition
This transition moves the network dispute state to `CASE_LOST` sets the case transition to `CLOSE` with reason code 42 (Case Lost).
For Regulation E dispute cases, if the case is past 45 days, the callee must specify both `write_off` and `write_off_actor`. When this occurs, the dispute state is set to `WRITE_OFF_PROGRAM` and sets the case transition to `CLOSE` with reason code 45 (Write off Program).
Query parameters
| Fields | Description |
| ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action
string
Required | Action taken.
**Allowable Values:**
ACCEPT\_AND\_CLOSE |
| created\_by
string
Required | Identifier or name of the user who created the transition.
**Allowable Values:**
255 char max |
| memo
string
Required | Memo regarding the transaction.
**Allowable Values:**
16777215 char max |
| close\_case\_details.write\_off
boolean
Conditionally required | Required if the 45-day Regulation E time limit has expired.
**Allowable Values:**
true, false |
| close\_case\_details.write\_off\_actor
string
Conditionally required | Triggers a CLOSE case transition with reason code 45. Required if the 45-day Regulation E time limit has expired.
**Allowable Values:**
PROGRAM |
Response fields
See the [Network dispute transition response](#_network_dispute_transition_response_body) table.
Error codes
| Error Code | Error Message | Description |
| ---------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400301 | Case is RegE and can only be accepted and closed with write off after it expires | Triggered when attempting to do an ACCEPT\_AND\_CLOSE action without write-off information for a case that has exceeded the 45-day milestone. |
Sample ACCEPT\_AND\_CLOSE transition request
```json JSON lines wrap theme={null}
{
"action": "ACCEPT_AND_CLOSE",
"created_by": "string",
"memo": "string",
"network_details": {
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Sample ACCEPT\_AND\_CLOSE transition response
```json JSON lines wrap theme={null}
{
"token": "string",
"case_token": "string",
"action": "ACCEPT_AND_CLOSE",
"created_by": "string",
"memo": "string",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "string",
"system_error_message": "string",
"network_error_message": "string",
"created_time": "timestamp",
"last_modified_time": "timestamp",
"network_details": {
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Create CLOSE\_WITH\_CASE\_WON transition
For Regulation E and non-Regulation E network dispute cases, the dispute state is set to `CASE_WON` and a `CLOSE` case transition with reason code 41 (Case Won) is created.
Sample CLOSE\_WITH\_CASE\_WON transition request
```json JSON lines wrap theme={null}
{
"action": "CLOSE_WITH_CASE_WON",
"created_by": "string",
"memo": "string"
}
```
Sample CLOSE\_WITH\_CASE\_WON transition response
```json JSON lines wrap theme={null}
{
"token": "string",
"case_token": "string",
"action": "ACCEPT_AND_CLOSE",
"created_by": "string",
"memo": "string",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "string",
"system_error_message": "string",
"network_error_message": "string",
"created_time": "timestamp",
"last_modified_time": "timestamp",
"network_details": {
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
Retrieve network dispute transition
**Action:** `GET`\
**Endpoint:** `/cases/{token}/disputetransitions/{transition_token}`
Retrieve a specific network dispute transition for a specific dispute.
A network dispute transition is an event that changes the state of a dispute and triggers other related events. The new state of the dispute and which related events are triggered is determined by the action defined in the transition.
URL path parameters
| Fields | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| transition\_token
string
Required | Unique identifier of the transition to retrieve.
**Allowable Values:**
36 char max
Send a GET request to /cases/{token}/transitions to retrieve dispute transition tokens. |
Response fields
See the [Network dispute transition response](#_network_dispute_transition_response_body) table.
Sample response body
```json JSON expandable lines wrap theme={null}
{
"token": "my_network_transition_id1",
"created_time": "2024-07-21T19:32:01.326Z",
"last_modified_time": "2024-07-21T19:32:01.326Z",
"case_token": "my_case_token",
"action": "CHARGEBACK_CREDIT",
"created_by": "user_name",
"memo": "Initiating chargeback",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "string",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 120.0,
"attached_contents": [
"string"
]
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 120.0,
"attached_contents": [
"string"
]
},
"network_state_details": "string",
"dispute_state": "CHARGEBACK_INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
```
List network dispute transitions
**Action:** `GET`\
**Endpoint:** `/cases/{token}/disputetransitions`
List existing network dispute transitions for the specified dispute, including details of the merchant/acquirer responses during the backend resolution process. This endpoint supports [sorting and pagination](/core-api/sorting-and-pagination/).
URL path parameters
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute associated with the transitions you want to list.
Send a GET request to /cases to retrieve dispute tokens.
**Allowable Values:**
36 char max |
List network dispute transitions response fields
See the [Network dispute transition response](#_network_dispute_transition_response_body) table.
Sample response body
```json JSON expandable lines wrap theme={null}
{
"count": 0,
"start_index": 0,
"end_index": 0,
"is_more": true,
"data": [
{
"token": "string",
"created_time": "2024-07-21T17:37:37.792Z",
"last_modified_time": "2024-07-21T17:37:37.792Z",
"case_token": "string",
"action": "SUBMIT",
"created_by": "string",
"memo": "string",
"from_network_status": "string",
"to_network_status": "string",
"network_dispute_id": "string",
"system_error_message": "string",
"network_error_message": "string",
"network_details": {
"prearbitration_details": {
"amount": 0,
"attached_contents": [
"string"
]
},
"prearbitration_response_details": {
"attached_contents": [
"string"
],
"prearb_response_decision": "ACCEPT_PARTIAL",
"amount": "string"
},
"arbitration_details": {
"attached_contents": [
"string"
]
},
"representment_details": {
"amount": 0.1,
"attached_contents": [
"string"
]
},
"network_state_details": "string",
"dispute_state": "INITIATED",
"case_close_details": {
"write_off": true,
"write_off_actor": "PROGRAM"
}
}
}
]
}
```
Create dispute case content
**Action:** `POST`\
**Endpoint:** `/cases/{token}/contents`
Upload and store documents related to a dispute, such as supporting evidence or KYC verification documents.
The supported document formats are PDF, TIFF, and JPEG. Each uploaded file is restricted to 2 MB.
URL path parameter
| Fields | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
Request body
| Fields | Description |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| document\_category
string
Required | Category of the document. The category is also forwarded to PULSE.
**Allowable Values:**
AFFIDAVIT\_FRAUD, AUTHORIZATION\_RECORD, BANK\_STATEMENT, CANCELLED\_CHECK, CARDHOLDER\_LETTER, CREDIT\_VOUCHER, FULFILLMENT, ISSUER\_CERTIFICATION, MERCHANT\_LETTER, NETWORK\_DOCUMENT, NETWORK\_EXHIBIT, OTHERS, RECEIPT, SALES\_DRAFT, SECOND\_OPTION, UPDATED\_CARDHOLDER\_LETTER, UPDATED\_MERCHANT\_LETTER |
| document\_name
string
Required | Name of the document.
**Allowable Values:**
Must include the file extension, as appropriate for a supported file format: .pdf, .tiff, or .jpeg. |
| document\_data
binary
Required | Base64-encoded file.
**Allowable Values:**
2 MB max size |
Create content response body
| Fields | Description |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token
string
Returned | Unique identifier of the document.
**Allowable Values:**
36 char max |
| case\_token
string
Returned | Unique identifier of the dispute case you want to upload documents against.
**Allowable Values:**
36 char max |
| document\_name
string
Returned | Name of the document.
**Allowable Values:**
255 char max |
| document\_category
string
Returned | Type of document.
**Allowable Values:**
AFFIDAVIT\_FRAUD, AUTHORIZATION\_RECORD, BANK\_STATEMENT, CANCELLED\_CHECK, CARDHOLDER\_LETTER, CREDIT\_VOUCHER, FULFILLMENT, ISSUER\_CERTIFICATION, MERCHANT\_LETTER, NETWORK\_DOCUMENT, NETWORK\_EXHIBIT, OTHERS, RECEIPT, SALES\_DRAFT, SECOND\_OPTION, UPDATED\_CARDHOLDER\_LETTER, UPDATED\_MERCHANT\_LETTER |
| document\_content\_type
string
Returned | Content type of the document.
**Allowable Values:**
application/pdf, image/tiff, image/jpeg |
| network\_processing\_type
string
Returned | Indicates the current status of the document at the network:
- SUBMITTED – Indicates it has been submitted to the network using the Dispute Case Transition or Network Dispute Transition endpoint.
- RECEIVED – Indicates that the document has been downloaded from the network, which occurs when the acquirer uploaded a document to support their claim.
**Allowable Values:**
SUBMITTED, RECEIVED |
| network\_processing\_phase
string
Returned | Indicates the status of the document in the dispute lifecycle.
**Allowable Values:**
INITIATED, REPRESENTMENT, PRE\_ARBITRATION |
| network\_processing\_time
datetime
Returned | Date and time when the document has either been submitted by the user or received from the network.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| created\_time
datetime
Returned | Date and time when the dispute was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| updated\_time
datetime
Returned | Date and time when the dispute was last modified.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| download\_link
string
Returned | Link to download the file if it is included in the request. This only applies to the GET case content by token endpoint.
**Allowable Values:**
Valid URI |
Sample request body
```json JSON lines wrap theme={null}
Content-Type: multipart/form-data; boundary=marqeta_file_separator
Cache-Control: no-cache
--marqeta_file_separator
Content-Type: application/json; Content-Disposition: form-data; name="body"
{
"document_category": "RECEIPT",
"document_name": "receipt.pdf",
"document_data": "string"
}
--marqeta_file_separator
Content-Type: image/jpeg; Content-Disposition: form-data; name="file"
file=@/Users/username/Downloads/online-receipt-location.jpg
--marqeta_file_separator--
```
Sample response body
```json JSON lines wrap theme={null}
{
"token": "my_content_token",
"case_token": "my_case_token",
"document_name": "string",
"document_category": "RECEIPT",
"document_content_type": "application/pdf",
"network_processing_type": "SUBMITTED",
"network_processing_phase": "INITIATED",
"network_processing_time": "2025-02-01T20:22:34.913Z",
"created_time": "2025-02-01T20:22:34.913Z",
"updated_time": "2025-02-01T20:22:34.913Z",
"download_link": "download_link"
}
```
List contents uploaded against a dispute case
**Action:** `GET`\
**Endpoint:** `/cases/{token}/contents`
Get a list of uploaded contents for the specified dispute case.
URL path parameter
| Fields | Description |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case for which to return the contents list.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
List contents response
For response details, see [Create content response body](#_create_content_response_body).
Sample response body
```json JSON expandable lines wrap theme={null}
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"token": "my_content_token",
"case_token": "my_case_token",
"document_name": "receipt.pdf",
"document_category": "RECEIPT",
"document_content_type": "image/jpeg",
"network_processing_type": "RECEIVED",
"network_processing_phase": "INITIATED",
"network_processing_time": "2025-01-19T13:22:07Z",
"created_time": "2025-01-19T13:22:07Z",
"updated_time": "2025-02-19T12:22:07Z",
"download_link": "uri"
},
{
"token": "my_content_token",
"case_token": "my_case_token",
"document_name": "receipt.pdf",
"document_category": "RECEIPT",
"document_content_type": "image/jpeg",
"network_processing_type": "RECEIVED",
"network_processing_phase": "INITIATED",
"network_processing_time": "2025-01-19T13:22:07Z",
"created_time": "2025-01-19T13:22:07Z",
"updated_time": "2025-02-19T14:22:07Z",
"download_link": "uri"
}
]
}
```
Retrieve content and status
**Action:** `GET`\
**Endpoint:** `/cases/{case_token}/contents/{token}`
Get a specific document and its status, and optionally start returning a temporary link to download the file.
If you include the `download_link=true` query parameter, a temporary link is returned in the response that you can use to download the document. The link is active for 15 minutes; after that time, you must call this endpoint again to generate a new link.
URL path parameters
| Fields | Description |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| case\_token
string
Required | Unique identifier of the dispute case for which to return the contents list.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
| token
string
Required | Unique identifier of the document.
**Allowable Values:**
36 char max |
| download\_link
string
Optional | If set to true, this parameter causes a download link for the document to be included in the response.
**Allowable Values:**
true, false |
Response body
For response details, see [Create content response body](#_create_content_response_body).
Sample response body
```json JSON lines wrap theme={null}
{
"token": "my_content_token",
"case_token": "my_case_token",
"document_name": "letter.pdf",
"document_category": "CARDHOLDER_LETTER",
"document_content_type": "string",
"network_processing_type": "SUBMITTED",
"network_processing_phase": "INITIATED",
"network_processing_time": "2025-02-02T23:06:18.429Z",
"created_time": "2025-02-02T23:06:18.429Z",
"updated_time": "2025-02-02T23:06:18.429Z",
"download_link": "uri"
}
```
Update document
**Action:** `PUT`\
**Endpoint:** `/cases/{token}/contents/{content_token}`
Change the name of a document or category. If the content has already been processed and is currently `SUBMITTED` or `RECEIVED`, an error is returned.
URL path parameter
| Fields | Description |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case for which to return the contents list.
Send a GET request to /cases to retrieve dispute case tokens.
**Allowable Values:**
36 char max |
| content\_token
string
Required | Content token that identifies the document.
**Allowable Values:**
36 char max |
Body field details
| Fields | Description |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| document\_name
string
Required | Name of the document.
**Allowable Values:**
255 char max |
| document\_category
string
Required | Category of the document.
**Allowable Values:**
AFFIDAVIT\_FRAUD, AUTHORIZATION\_RECORD, BANK\_STATEMENT, CANCELLED\_CHECK, CARDHOLDER\_LETTER, CREDIT\_VOUCHER, FULFILLMENT, ISSUER\_CERTIFICATION, MERCHANT\_LETTER, NETWORK\_DOCUMENT, NETWORK\_EXHIBIT, OTHERS, RECEIPT, SALES\_DRAFT, SECOND\_OPTION, UPDATED\_CARDHOLDER\_LETTER, UPDATED\_MERCHANT\_LETTER |
Update document response body
For response details, see [Create content response body](#_create_content_response_body).
Sample request body
```json JSON lines wrap theme={null}
{
"document_name": "receipt.pdf",
"document_category": "RECEIPT"
}
```
Sample response body
```json JSON lines wrap theme={null}
{
"token": "my_content_token",
"case_token": "my_case_token",
"document_name": "letter.pdf",
"document_category": "CARDHOLDER_LETTER",
"document_content_type": "string",
"network_processing_type": "SUBMITTED",
"network_processing_phase": "INITIATED",
"network_processing_time": "2025-02-02T23:06:18.429Z",
"created_time": "2025-02-02T23:06:18.429Z",
"updated_time": "2025-02-02T23:06:18.429Z",
"download_link": "uri"
}
```
Delete a document
**Action:** `DELETE`\
**Endpoint:** `/cases/{token}/contents/{content_token}`
Delete a dispute case document. If the document has already been processed with the `network_processing_type` set to `SUBMITTED` or `RECEIVED`, an error is returned.
URL path parameter
| Fields | Description |
| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
**Allowable Values:**
255 char max |
| content\_token
string
Required | Unique identifier of the content to delete.
**Allowable Values:**
255 char max |
Delete content response
This endpoint returns a `200` response code and `success` in the response body.
Sample response body
```json JSON lines wrap theme={null}
{
"status": "success"
}
```
Create dispute case action
**Action:** `POST`\
**Endpoint:** `/cases/{token}/actions`
Create a dispute case action.
Path parameter
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
Body field details
| Fields | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| action\_type
string
Required | - GRANT\_PROVISIONAL\_CREDIT - Grant provisional credit and trigger the event.
- REVERT\_PROVISIONAL\_CREDIT - Revert a previously granted provisional credit and trigger an event.
**Allowable Values:**
GRANT\_PROVISIONAL\_CREDIT, REVERT\_PROVISIONAL\_CREDIT |
| created\_by
string
Required | Indicates the actor who created the dispute case action.
**Allowable Values:**
255 char max |
Response body
| Fields | Description |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
| action\_type
string
Returned | Action taken.
**Allowable Values:**
255 char max |
| created\_by
string
Returned | Indicates the actor who created the dispute case action.
**Allowable Values:**
255 char max |
Sample request
```json JSON lines wrap theme={null}
{
"action_type": "GRANT_PROVISIONAL_CREDIT",
"created_by": "string"
}
```
Sample response
```json JSON lines wrap theme={null}
{
"case_token": "",
"action_type": "GRANT_PROVISIONAL_CREDIT",
"created_by": "string"
}
```
Create event
**Action:** `POST`\
**Endpoint:** `/cases/{token}/events`
Create a dispute case event.
If you are a Managed by Marqeta (MxM) customer or a hybrid card program and you are submitting a dispute that falls under Regulation E, you must create a case event with evidence. For instructions on creating a case event with evidence, see [Disputes Evidence Collection](/core-api/disputes-evidence-collection/).
Path parameter
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
Body field details
| Fields | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| name
string
Required | Name of the event.
**Allowable Values:**
255 char max |
| event\_date
datetime
Optional | Date and time when the event took place.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| created\_by
string
Required | Indicates the actor creating the event.
**Allowable Values:**
255 char max |
Response body
| Fields | Description |
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the event.
**Allowable Values:**
36 char max |
| case\_token
string
Returned | Unique identifier of the associated case that triggered this event.
**Allowable Values:**
36 char max |
| name
string
Returned | Name of the event.
**Allowable Values:**
255 char max |
| category
string
Returned | Category to which the event belongs.
**Allowable Values:**
REG\_E |
| created\_by
string
Required | Indicates the actor who created the event.
**Allowable Values:**
255 char max |
| event\_date
datetime
Returned | Date and time when the event took place.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| created\_time
datetime
Returned | Date and time when the event was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
Sample request
```json JSON lines wrap theme={null}
{
"name": "string",
"created_by": "string",
"event_date": "timestamp",
}
```
Sample response
```json JSON lines wrap theme={null}
{
"token": "uuid",
"case_token": "string",
"name": "string",
"category": "string",
"created_by": "string",
"event_date": "timestamp",
"created_time": "timestamp"
}
```
List events
**Action:** `GET`\
**Endpoint:** `/cases/{token}/events`
List events.
Path parameter
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
Response body
| Fields | Description |
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the event.
**Allowable Values:**
36 char max |
| case\_token
string
Returned | Unique identifier of the associated case that triggered this event.
**Allowable Values:**
36 char max |
| name
string
Returned | Name of the event.
**Allowable Values:**
255 char max |
| category
string
Returned | Category to which the event belongs.
**Allowable Values:**
REG\_E |
| created\_by
string
Required | Identifier or name of the user creating the event.
**Allowable Values:**
255 char max |
| event\_date
datetime
Returned | Date and time when the event took place.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| created\_time
datetime
Returned | Date and time when the event was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
Sample response
```json JSON lines wrap theme={null}
{
"count": 30,
"start_index": 0,
"end_index": 29,
"is_more": true,
"data": [
{
"case_token": "string",
"category": "string",
"sub_category": "string",
"milestone": "string",
"next_milestone_due_date": "timestamp",
"created_time": "timestamp",
"last_modified_time": "timestamp"
}
]
}
```
List dispute case milestones
**Action:** `GET`\
**Endpoint:** `/cases/{token}/milestones`
List dispute case milestones.
Path parameter
| Fields | Description |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| token
string
Required | Unique identifier of the dispute case.
**Allowable Values:**
36 char max |
Body field details
| Fields | Description |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| name
string
Required | Name of the event.
**Allowable Values:**
255 char max |
| event\_date
datetime
Optional | Date and time when the event took place.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| created\_by
string
Required | Identifier or name of the user creating the event.
**Allowable Values:**
255 char max |
Response body
| Fields | Description |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
| case\_token
string
Returned | Unique identifier of the associated case that triggered this event.
**Allowable Values:**
36 char max |
| milestone
string
Required | Event milestone.
**Allowable Values:**
255 char max |
| next\_milestone\_due\_date
datetime
Returned | Date that the next milestone is due.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| created\_time
datetime
Returned | Date and time when the event was created.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
| last\_modified\_time
datetime
Returned | Date and time when the event was last modified.
**Allowable Values:**
Format: yyyy-MM-dd’T’HH:mm:ssZ |
Sample response
```json JSON lines wrap theme={null}
{
"count": 30,
"start_index": 0,
"end_index": 29,
"is_more": true,
"data": [
{
"case_token": "string",
"milestone": "string",
"next_milestone_due_date": "timestamp",
"created_time": "timestamp",
"last_modified_time": "timestamp"
}
]
}
```
## Related topics
- [Creating a Dispute](/docs/developer-guides/disputes-create.md)
- [Disputes Sandbox Overview](/docs/developer-guides/disputes-sandbox/disputes-sandbox-overview.md)
- [2023 Release Notes](/docs/developer-guides/release-notes-2023.md)
- [About Disputes](/docs/developer-guides/about-disputes.md)
- [2024 Release Notes](/docs/developer-guides/release-notes-2024.md)