Create a Chargeback

POST 
/api/chargebacks/

Merchants with the proper permissions can create a chargeback in the Splitit system (you may want to do this, for example, if you received notice of a chargeback from your processor). Created chargebacks have Open status.

Request

application/json

Body

required

ChargebackCreationDatedate-time

Optional, if not set, gets set to current time. Only dates less than or equal to now should be used, and should be in UTC format, e.g. "2024-04-29T14:33:44.613Z"

RefDisputeIdstringrequired

Merchant reference id given for this dispute

DueDateForEvidencedate-time

Due date for submitting evidence for this dispute. Should be in UTC format, e.g. "2024-04-29T14:33:44.613Z"

InstallmentPlanNumberstringrequired

Associated installment plan number. Optional if RefOrderNumber is specified

RefOrderNumberstringrequired

Optional if InstallmentPlanNumber is specified

Amountnumberrequired

Chargeback amount

Currencystringrequired

Chargeback currency, e.g. USD, AUD, CAD, EUR, GBP, JPY, SGD

ReasonCodestringrequired

Chargeback reason code.

TransactionSplititReferencestringrequired

This is the merchant reference that comes from the processor with the chargeback notification. It includes a Splitit reference number from the relevant capture operation.

Responses

200

Response Headers

application/json

Schema

Schema

Errors

object[]

Array [

Codestring

Messagestring

AdditionalInfostring

]

StatusCodeint32required
TraceIdstring
IsSuccessbooleanrequired

Chargeback

object

required

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

ReasonCodestringrequired

Evidences

object[]

required

Array [

EvidenceIdstringrequired

UploadedAtdate-timerequired

FileNamestringrequired

FileTypestringrequired

]

Comments

object[]

required

Array [

CommentIdstringrequired

Textstringrequired

CommentAtdate-timerequired

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "Chargeback": {
    "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",
    "ReasonCode": "string",
    "Evidences": [
      {
        "EvidenceId": "string",
        "UploadedAt": "2024-07-29T15:51:28.071Z",
        "FileName": "string",
        "FileType": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": "string",
        "Text": "string",
        "CommentAt": "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": {}
  }
}