Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Disputes

Challenge a dispute

Challenges a specific dispute. You should call this endpoint once you have attached all the relevant evidence. Note that you can no longer submit further evidence once challenged, so make sure you have gathered as much as possible to ensure a better chance of winning the dispute.

post/disputes/{disputeId}/challenge

Path parameters

disputeIdstring required
Example:dsp_01FCTS1XMKH9FF43CAFA4CXT3P

Dispute to challenge

Response

Successfully challenged the given Dispute

idstring

The ID of the dispute

amountinteger

The amount that is being disputed and the merchant is liable for

currencystring

The ISO currency code

status'Open' | 'Cancelled' | 'Accepted' | 'Challenged' | 'Lost' | 'Won' | 'Expired'
category'Fraudulent' | 'Authorization' | 'ProcessingError' | 'CardholderDispute' | 'General'

Disputes are grouped into a specific category based on their reason.code. These define the overlapping reason across various card schemes (who each have their own codes)

respondByinteger

The deadline by which the evidence needs responding by. Note that you cannot attach evidence or challenge the dispute once this date has passed. The dispute will move to Expired.

recommendedEvidencestring[]

The evidence strongly recommended for the best chance to challenge and win the dispute. Note that this is based on the underlying reason.code of the Dispute and is subject to change should further types of evidence be added or no longer supported. Leverage this field to select the best forms of evidence should you choose to challenge the dispute.

createdTimestampinteger

The epoch timestamp (seconds) when the dispute was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the dispute was last updated

Example response

{
  "id": "dsp_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "amount": 500,
  "currency": "GBP",
  "status": "Open",
  "category": "Fraudulent",
  "reason": {
    "code": "13.6",
    "description": "Merchandise/Services Not Received"
  },
  "respondBy": 1685059200,
  "paymentSession": {
    "id": "ps_01G0EYVFR02KBBVE2YWQ8AKMGJ",
    "paymentType": "Standard",
    "paymentMethod": {
      "card": {
        "scheme": "Mastercard",
        "last4": "4444"
      }
    }
  },
  "evidence": {
    "files": {
      "proofOfDelivery": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "customerSignature": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "receipt": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "shippingConfirmation": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "customerCommunication": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "refundPolicy": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "recurringPaymentAgreement": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      },
      "uncategorised": {
        "id": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
      }
    }
  },
  "customer": {
    "email": "john.doe@ryftpay.com",
    "id": "cus_01G0EYVFR02KBBVE2YWQ8AKMGJ",
    "createdTimestamp": 1470989538
  },
  "subAccount": {
    "id": "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}