POST api.ravelin.com/v2/dispute

Show all
timestamp integer required

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.

Show definition
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.

POST https://api-staging.ravelin.com/v2/dispute HTTP/1.1
Authorization: token ...
Content-Type: application/json

  "timestamp": 1512828988826,
  "dispute": {
    "disputeId": "abc-123-XYZ",
    "gateway": "braintree",
    "gatewayReference": "abc-123-XYZ",
    "transactionId": "abc-123-XYZ",
    "amount": 15212,
    "currency": "GBP",
    "disputeTime": 1479302798,
    "reason": "fraud",
    "stage": "CHARGEBACK",
    "outcome": "LOST",
    "liabilityShifted": true,
    "nonFraud": false,
    "descriptor": "ravelin.com #1239424",
    "acquirerReferenceNumber": "12345678901234567890123"