Dispute Object


A dispute is a customer-initiated challenge of a payment through their payment service provider (PSP) or bank.

Properties
acceptedDatestringRead-onlyformat date-time

Date and time at which the dispute was accepted.


actionsArray <DisputeAction>Read-onlymaxItems 20

List of actions that can be performed on the dispute. Each action has a specific due date by which it must be completed. Available actions depend on the dispute's current status and stage.


amountstringimmutabledecimalValue {"gt":"0","maxScale":8}

Disputed amount in the currency's main units. For example, "12.95" for $12.95.


autoDefendedbooleanRead-only

Whether the dispute was automatically defended by the payment processor.


channelstringRead-only

Channel through which the dispute is being processed.


chargeIdstringformat GUIDimmutable

ID of the charge that is being disputed.


createdDatestringRead-onlyimmutableformat date-time

Date and time the dispute was created.


currencyCodestringimmutableformat CURRENCY

Three-letter currency code in ISO-4217 alphabetic format. Matches the currency of the disputed charge.


defendablebooleanRead-only

Whether the dispute can be defended with evidence.


defendedDatestringRead-onlyformat date-time

Date and time at which the dispute was defended.


dueDatestringRead-onlyformat date-time

The latest date and time until which the dispute can remain in its current status.

If this date passes, the dispute will be resolved against the party that is required to take action. For example, if the status is WAITING_MERCHANT, and the due date passes, the dispute will be LOST and a refund will be processed automatically.


extendedFieldsExtendedFields

Custom field data for the dispute object.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringformat GUIDimmutable

Dispute ID.


networkReasonCodestringminLength 1maxLength 64

Network reason code provided by the card network or issuing bank that initiated the dispute.


providerDisputeIdstringformat GUIDimmutable

Unique identifier assigned by the payment service provider for this dispute.


reasonstringRead-only

Reason why the customer initiated the dispute.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the dispute is updated. To prevent conflicting changes, the current revision must be passed when updating the dispute. Ignored when creating a dispute.


sellerProtectionstringRead-only

Level of seller protection coverage for this dispute.

Seller protection is set by the payment provider. For example, PayPal offers a seller protection program.


stagestringRead-only

Stage of the dispute process.


statusstringRead-only

Current status of the dispute. This indicates what action is required and who needs to take it.


tagsTags

Tags assigned to the dispute for organization and filtering purposes.


updatedDatestringRead-onlyformat date-time

Date and time the dispute was updated.

Did this help?