PSPs > API Reference > Endpoints > Dispute

Dispute

POST api.ravelin.com/psp/dispute

dispute object required

Show definition

amount integer optional

The amount under dispute, in the currency's basic units.

arn string optional

The Acquirer Reference Number (ARN) is the acquirer's reference for the disputed transaction. It must match the ARN provided on the disputed transaction. If the ARN is not available then you must provide the transactionId or gateway reference.

category string optional

Category mapped to the one given by the cardholder for disputing the transaction.

One of: DUPLICATE, PRODUCT_NOT_RECEIVED, SUBSCRIPTION_CANCELLED, PRODUCT_UNACCEPTABLE, CREDIT_NOT_PROCESSED, GENERAL, FRAUDULENT, or UNRECOGNISED.

currency string optional

The currency of the amount of this dispute, as an ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

disputeId string required

A unique reference for the dispute.

disputeTime integer optional

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).

gateway string optional

The gateway responsible for processing the disputed transaction.

Pattern: ^[a-z0-9]*$

gatewayReference string optional

The gateway reference value provided on the disputed transaction. If the gateway reference is not available then you must provide the transactionId or ARN.

liabilityShifted boolean optional

Whether liability for this dispute was shifted to the issuer.

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.

reason string optional

Reason given by the cardholder for disputing the transaction.

stage string required

Stage of the dispute. A dispute with the stage EARLY_FRAUD_WARNING or REQUEST_FOR_INFORMATION is not considered a chargeback for reporting purposes.

One of: EARLY_FRAUD_WARNING, REQUEST_FOR_INFORMATION, NOTIFICATION_OF_CHARGEBACK, CHARGEBACK, SECOND_CHARGEBACK, CHARGEBACK_REVERSED, PREARBITRATION, or ARBITRATION.

transactionId string optional

Identifier for the disputed transaction. Must match the transactionId provided on the disputed transaction. If the transactionId is not available then you must provide the gateway reference or ARN.

timestamp integer required

A unix timestamp preferably as an integer count of milliseconds since 1970-01-01T00:00 UTC (nanoseconds are also accepted).

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

{
  "dispute": {
    "amount": 1337,
    "arn": "string",
    "currency": "GBP",
    "disputeId": "string",
    "disputeTime": 1512828988826,
    "gateway": "braintree",
    "gatewayReference": "string",
    "liabilityShifted": true,
    "outcome": "LOST",
    "reason": "fraud",
    "stage": "CHARGEBACK",
    "transactionId": "string"
  },
  "timestamp": 1667387532297
}

Response

data object optional

Contains details related to the dispute.

Show definition

warnings array of objects optional

Warnings when the data in the request contained issues.

Show definition

class string optional

Identifier for this warning. Format is [a-z-]+ so you can safely record it in your metrics system.

msg string optional

A description indicating why this warning has been issued.

status integer optional

HTTP response status code.

timestamp integer optional

UNIX timestamp when Ravelin finished handling the request

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "timestamp": 1667387532297
}

Feedback

Was this page helpful?