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

ChargebackCreationDate date-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"

RefDisputeId stringrequired

Merchant reference id given for this dispute

DueDateForEvidence date-time

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

InstallmentPlanNumber stringrequired

Associated installment plan number. Optional if RefOrderNumber is specified

RefOrderNumber stringrequired

Optional if InstallmentPlanNumber is specified

Amount numberrequired

Chargeback amount

Currency stringrequired

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

ReasonCode stringrequired

Chargeback reason code. See codes

TransactionSplititReference stringrequired

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 [

Code string

Message string

AdditionalInfo string

]

StatusCode int32required
TraceId string
IsSuccess booleanrequired

Chargeback

object

required

Id stringrequired

DisputeCreatedDate date-timerequired

DueDate date-timerequired

InstallmentPlanNumber stringrequired

InstallmentNumber int64required

PlanStatus stringrequired

TransactionId stringrequired

MerchantName stringrequired

TotalPlanAmount

object

required

Amount numberrequired

CurrencyCode stringrequired

DisputeAmount

object

required

Amount numberrequired

CurrencyCode stringrequired

Status DisputeStatus (string)required

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

PlanActivatedDate date-time

ReasonCode stringrequired

Evidences

object[]

required

Array [

EvidenceId stringrequired

UploadedAt date-timerequired

FileName stringrequired

FileType stringrequired

]

Comments

object[]

required

Array [

CommentId stringrequired

Text stringrequired

CommentAt date-timerequired

]

Example (from schema)

{
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "AdditionalInfo": "string"
    }
  ],
  "StatusCode": 0,
  "TraceId": "string",
  "IsSuccess": true,
  "Chargeback": {
    "Id": "string",
    "DisputeCreatedDate": "2024-06-06T16:41:09.406Z",
    "DueDate": "2024-06-06T16:41:09.406Z",
    "InstallmentPlanNumber": "string",
    "InstallmentNumber": 0,
    "PlanStatus": "string",
    "TransactionId": "string",
    "MerchantName": "string",
    "TotalPlanAmount": {
      "Amount": 0,
      "CurrencyCode": "string"
    },
    "DisputeAmount": {
      "Amount": 0,
      "CurrencyCode": "string"
    },
    "Status": "Open",
    "PlanActivatedDate": "2024-06-06T16:41:09.406Z",
    "ReasonCode": "string",
    "Evidences": [
      {
        "EvidenceId": "string",
        "UploadedAt": "2024-06-06T16:41:09.406Z",
        "FileName": "string",
        "FileType": "string"
      }
    ],
    "Comments": [
      {
        "CommentId": "string",
        "Text": "string",
        "CommentAt": "2024-06-06T16:41:09.406Z"
      }
    ]
  }
}

401

Response Headers

application/json

Schema

Schema

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

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

TraceId string

Error

object

Code string

Message string

AdditionalInfo string

ExtraData

object

property name* string

Example (from schema)

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

Loading...