Creating disputes with more data (or complete)

On the other hand, when a dispute comes with more than the basic data, we refer to it as a “complete dispute.” It’s worth noting that you can use any amount of optional fields as you want. It’s not mandatory to provide either all or none optional fields.

For example, a chargeback with only some of the optional fields could be:

PUT /dispute
{
  "currency": "USD",
  "notification_date": "2024-08-07T12:33:17.919Z",
  "operation": "retrieval",
  "amount": 10,
  "payment_processor": {
    "solution": "PayPal"
  },
  "reason": "Cardmember claims fraud",
  "payment": {
    "currency": "EUR",
    "amount": 20,
    "id": "4e83da2e-fafa-4135-a59e-14a20713c19e",
    "card": {
      "brand": "ECMC_COMMERCIAL_CREDIT^SSL"
    }
  },
  "company": {
    "name": "ACME Inc."
  }
}

This has only the optional fields company.name, payment.currency, and payment.amount.

The result in our system would be:

Creating basic disputes with partial data

Another option is to provide all the optional fields, for example:

PUT /dispute
{
 "currency": "USD",
 "notification_date": "2024-08-07T13:02:17.919Z",
 "operation": "chargeback",
 "has_refund": false,
 "amount": 4.53,
 "payment_processor": {
   "solution": "Checkout.com",
   "provider": "Macropay"
 },
 "reason": "Cardmember claims fraud",
 "payment": {
   "currency": "EUR",
   "id": "56cfdda5-a2a6-41b8-aafc-ebeddff04d42",
   "external_id": "a6f821f8-a521-45f0-b053-e64b04fa23cf",
   "date": "2024-08-06T10:33:17.919Z",
   "card": {
     "brand": "ECMC_COMMERCIAL_CREDIT^SSL",
     "holder": "Jane Doe"
   },
   "is_3d_secure": true,
   "amount": 9.99
 },
 "company": {
   "name": "Acme Corporation",
   "email": "acme@example.com",
   "address": "Acme Street 123",
   "url": "https://www.acme.com",
   "privacy_term_url": "https://www.acme.com/privacy",
   "policy_term_url": "https://www.acme.com/policy",
   "product": "Acme Product",
   "registration_number": "123456789"
 },
 "external_url": "https://www.acme.com/chargeback/a6f821f8-a521-45f0-b053-e64b04fa23cf",
 "customer": {
   "name": "Jane Doe",
   "email": "janedoe@example.com",
   "ip": "1.1.1.1"
 },
 "dispute_id": "a6f821f8-a521-45f0-b053-e64b04fa23cf"
}

This would generate the following chargeback in our system:

Creating basic disputes with more data

Finally, in custom property, you can provide any data relevant to your product, like:

PUT /dispute
{
  "currency": "USD",
  "notification_date": "2024-08-07T13:15:17.919Z",
  "operation": "retrieval",
  "amount": 10,
  "payment_processor": {
    "solution": "PayPal"
  },
  "reason": "Cardmember claims fraud",
  "payment": {
    "id": "5d66ec1a-fb0a-4a4d-b0d0-dc8ec8510422",
    "card": {
      "brand": "ECMC_COMMERCIAL_CREDIT^SSL"
    }
  },
  "custom": {
    "additionalProperty1": {
      "label": "Custom Label 1",
      "value": "Custom Value 1"
    },
    "additionalProperty2": {
      "label": "Custom Label 2",
      "value": "Custom Value 2"
    }
  }
}

This would generate a chargeback in our system:

Creating basic disputes with more data

The Additional info section contains custom fields.