/
Create a dispute

Create a dispute

Request

Creates a new dispute.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Dispute resource.

transactionIdstring, <= 50 characters(TransactionId)required

ID of the disputed transaction.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
currencystring, = 3 characters(CurrencyCode)required

Currency code in ISO 4217 format.

Example:"USD"
amountnumber, (double)required

Dispute amount.

acquirerReferenceNumberstring or null, <= 255 characters

Acquirer reference number for the dispute.

caseIdstring or null, <= 100 characters

Case ID of the dispute.

reasonCodestring, <= 255 charactersrequired

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

Enum:"0""00""1""2""3""4""5""6""7""8"
typestringrequired

Type of dispute.

Enum:"information-request""first-chargeback""second-chargeback""arbitration""fraud""ethoca-alert""verifi-alert""bank-return""paypal-claim""representment"
statusstringrequired

Status of the dispute.

Enum:"response-needed""under-review""forfeited""won""lost""unknown"
postedTimestring, (date-time)required

Date and time when the dispute is posted.

deadlineTimestring 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.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/disputes \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "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

Dispute created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the dispute.

Example:"dp_0YVCE8J5F2DE58FV0S8YASW4HK"
customerIdstring or null, <= 50 charactersread-only

ID of the customer who is disputing a transaction.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
transactionIdstring or null, <= 50 characters

ID of the disputed transaction.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
amountnumber, (double)

Dispute amount.

acquirerReferenceNumberstring or null

Acquirer reference number for the dispute.

caseIdstring or null

Case ID of the dispute.

reasonCodestring or null, <= 255 characters

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

reasonDescriptionstring or null, <= 512 charactersread-only

Description of the reason for the dispute.

categorystringread-only

Category of dispute.

Enum:"fraud""authorization""processing-errors""consumer-disputes""uncategorized""bank-return"
typestring

Type of dispute.

Enum:"information-request""first-chargeback""second-chargeback""arbitration""fraud""ethoca-alert""verifi-alert""bank-return""paypal-claim""representment"
statusstring

Status of the dispute.

Enum:"response-needed""under-review""forfeited""won""lost""unknown"
postedTimestring, (date-time)

Date and time when the dispute is posted.

deadlineTimestring 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.

rawResponsestring or nullread-only

Raw response from the payment gateway that processed the disputed transaction.

resolvedTimestring or null, (date-time)read-only

Date and time when the dispute is resolved.

sourcestring or nullread-only

Source of the dispute.

Enum:null"api""manual""sftp""webhook"
revisionintegerread-only

Number of times the dispute data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "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": {},
    "customer": {}
  }
}