Skip to main content

Create a Chargeback

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 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 string REQUIRED

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 string REQUIRED

Associated installment plan number. Optional if RefOrderNumber is specified

RefOrderNumber string REQUIRED

Optional if InstallmentPlanNumber is specified

Amount number REQUIRED

Chargeback amount

Currency string REQUIRED

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

ReasonCode string REQUIRED

Chargeback reason code. See codes

TransactionSplititReference string REQUIRED

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
Schema OPTIONAL
Errors object[] OPTIONAL
Code string OPTIONAL
Message string OPTIONAL
AdditionalInfo string OPTIONAL
StatusCode int32
TraceId string OPTIONAL
IsSuccess boolean
Chargeback object
Id string
DisputeCreatedDate date-time
DueDate date-time
InstallmentPlanNumber string
InstallmentNumber int64
PlanStatus string
TransactionId string
MerchantName string
TotalPlanAmount object
Amount number
CurrencyCode string
DisputeAmount object
Amount number
CurrencyCode string
Status DisputeStatus

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

PlanActivatedDate date-time OPTIONAL
ReasonCode string
Evidences object[]
EvidenceId string
UploadedAt date-time
FileName string
FileType string
Comments object[]
CommentId string
Text string
CommentAt date-time
401
Schema OPTIONAL
TraceId string OPTIONAL
Error object OPTIONAL
Code string OPTIONAL
Message string OPTIONAL
AdditionalInfo string OPTIONAL
ExtraData object OPTIONAL
403
Schema OPTIONAL
TraceId string OPTIONAL
Error object OPTIONAL
Code string OPTIONAL
Message string OPTIONAL
AdditionalInfo string OPTIONAL
ExtraData object OPTIONAL
404
Schema OPTIONAL
TraceId string OPTIONAL
Error object OPTIONAL
Code string OPTIONAL
Message string OPTIONAL
AdditionalInfo string OPTIONAL
ExtraData object OPTIONAL
500
Schema OPTIONAL
TraceId string OPTIONAL
Error object OPTIONAL
Code string OPTIONAL
Message string OPTIONAL
AdditionalInfo string OPTIONAL
ExtraData object OPTIONAL