The time at which this data payload was valid. When sending events in realtime, this will usually be 'now'. This is used to merge data that arrives out-of-order.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
dispute
object
required
A dispute occurs when a cardholder makes a claim to the issuer of their payment method to challenge the legitimacy of a payment, initiating a chargeback for card payment methods. See our Sending Disputes guide to learn more about the dispute process.
Stage of the dispute. A dispute with the stage EARLY_FRAUD_WARNING or REQUEST_FOR_INFORMATION is not considered a chargeback for reporting purposes. See our Sending Disputes guide to learn more.
One of:
EARLY_FRAUD_WARNING, REQUEST_FOR_INFORMATION, NOTIFICATION_OF_CHARGEBACK, CHARGEBACK, SECOND_CHARGEBACK, CHARGEBACK_REVERSED, PREARBITRATION, or ARBITRATION.
gateway
string
important
Name of the payment gateway that processed the disputed transaction.
gatewayReference
string
important
Payment gateway's identifier for the disputed transaction. Must match the gateway reference of the original transaction. Not required if you provide transactionId.
transactionId
string
important
Identifier for the disputed transaction. Must match the transaction identifier of the original transaction. Not required if you provide gatewayReference.
Currency of the dispute amount, as an ISO 4217 currency code.
Pattern: ^[a-zA-Z]{3}$
disputeTime
integer
important
Time at which the dispute was created, used for reporting.
A unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).
reason
string
optional
Reason given by the cardholder for disputing the transaction.
outcome
string
optional
Outcome of the dispute. Use ACCEPTED for disputes you have accepted and decided not to defend, WON for disputes you have successfully defended, EXPIRED for disputes that have timed out and LOST for disputes ruled in favour of the cardholder. Omit outcome if the dispute is still open.
One of:
ACCEPTED, WON, LOST, or EXPIRED.
liabilityShifted
boolean
optional
Whether liability for this dispute was shifted to the issuer. See Liability Shift.
nonFraud
boolean
optional
Whether the cardholder disputed the payment for reasons other than fraud. Make sure to set a reason if this is the case - see our disputes guide to learn more.
custom
object
optional
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
eventType
string
optional
An eventType should identify what event in your system triggered this API call.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$
orderId
string
optional
The ID of the order the dispute originated from. When provided
instead of gatewayReference and transactionId, Ravelin will set the
gatewayReference and transactionId to that of the first successful
transaction of the order.
customerId
string
optional
The ID of the customer this dispute originated from.
Ravelin will look this up from the referenced order or transaction.