Developer docs
/
Rebilly API
/
Disputes
/
Create a dispute

Create a dispute

Creates a new dispute.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
Request Body schema: application/json
required

Dispute resource.

transactionId
required
string (TransactionId) <= 50 characters

ID of the transaction.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Dispute amount.

acquirerReferenceNumber
string or null

Acquirer reference number for the dispute.

caseId
string or null

Case ID of the dispute.

reasonCode
required
string

Code used in the chargeback that describes the reason for the dispute.

Enum: "0" "00" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10.1" "10.2" "10.3" "10.4" "10.5" "11.1" "11.2" "11.3" "12" "12.1" "12.2" "12.3" "12.4" "12.5" "12.6" "12.7" "13.1" "13.2" "13.3" "13.4" "13.5" "13.6" "13.7" "13.8" "13.9" "30" "31" "34" "35" "37" "40" "41" "42" "46" "47" "49" "50" "51" "53" "54" "55" "57" "59" "60" "62" "63" "70" "71" "72" "73" "74" "75" "76" "77" "78" "79" "80" "81" "82" "83" "85" "86" "93" "98" "1000" "2700" "2702" "A" "A01" "A02" "A08" "AL" "AP" "AW" "B" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "F10" "F14" "F22" "F24" "F29" "FR1" "FR4" "FR6" "IC" "IN" "IS" "LP" "M01" "M10" "M49" "N" "NA" "NC" "P" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA32" "UA38" "UA99" "bank_cannot_process" "credit_not_processed" "customer_initiated" "debit_not_authorized" "duplicate" "fraudulent" "general" "incorrect_account_details" "insufficient_funds" "pre-chargeback-alert" "product_not_received" "product_unacceptable" "subscription_canceled" "unrecognized"
type
required
string

Type of dispute.

Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" "bank-return"
status
required
string

Status of the dispute.

Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
postedTime
required
string <date-time>

Date and time when the dispute is posted.

deadlineTime
string or null <date-time>

Latest date and time by when a merchant must submit a representment for a dispute. If the deadline is missed, the merchant loses the dispute.

post
/disputes
Request samples
application/json
{
"transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
"currency": "USD",
"amount": 0.1,
"acquirerReferenceNumber": "string",
"caseId": "string",
"reasonCode": "0",
"type": "information-request",
"status": "response-needed",
"postedTime": "2019-08-24T14:15:22Z",
"deadlineTime": "2019-08-24T14:15:22Z"
}
Responses

201

Dispute created.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json
{
"id": "dp_0YVCE8J5F2DE58FV0S8YASW4HK",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
"currency": "USD",
"amount": 0.1,
"acquirerReferenceNumber": "string",
"caseId": "string",
"reasonCode": "string",
"reasonDescription": "string",
"category": "fraud",
"type": "information-request",
"status": "response-needed",
"postedTime": "2019-08-24T14:15:22Z",
"deadlineTime": "2019-08-24T14:15:22Z",
"rawResponse": "string",
"resolvedTime": "2019-08-24T14:15:22Z",
"source": null,
"revision": 0,
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [

],
"_embedded": {
"transaction": { }
}
}