Get All Chargebacks

GET 
/api/chargebacks

Returns a list of all open chargebacks against the merchant. Supports pagination. You can optionally specify a date range and/or status type. A successful response includes extensive info about the dispute, including created date, id, due date, etc.

Request

Query Parameters

status DisputeStatus

Possible values: [Open, Won, Lost, Closed, Other, Pending]

from date-time
to date-time

Header Parameters

X-Splitit-Skip int32
With respect to pagination, how many pages to skip ahead (default is 0)
Default value: 0
X-Splitit-Take int32
With respect to pagination, the number of records to include in each page (default is 100)
Default value: 100

Responses

200

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Chargebacks

object[]

required

Array [

Idstringrequired

DisputeCreatedDatedate-timerequired

DueDatedate-timerequired

InstallmentPlanNumberstringrequired

InstallmentNumberint64required

PlanStatusstringrequired

TransactionIdstringrequired

MerchantNamestringrequired

TotalPlanAmount

object

required

Amountnumberrequired

CurrencyCodestringrequired

DisputeAmount

object

required

Amountnumberrequired

CurrencyCodestringrequired

StatusDisputeStatus (string)required

Possible values: [Open, Won, Lost, Closed, Other, Pending]

PlanActivatedDatedate-time

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "Chargebacks": [
    {
      "Id": "string",
      "DisputeCreatedDate": "2024-07-29T15:51:28.071Z",
      "DueDate": "2024-07-29T15:51:28.071Z",
      "InstallmentPlanNumber": "string",
      "InstallmentNumber": 0,
      "PlanStatus": "string",
      "TransactionId": "string",
      "MerchantName": "string",
      "TotalPlanAmount": {
        "Amount": 0,
        "CurrencyCode": "string"
      },
      "DisputeAmount": {
        "Amount": 0,
        "CurrencyCode": "string"
      },
      "Status": "Open",
      "PlanActivatedDate": "2024-07-29T15:51:28.071Z"
    }
  ]
}

401

Response Headers

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

403

Response Headers

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

404

Response Headers

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

500

Response Headers

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}