Create a dispute

Create a dispute.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Dispute resource.

currency
required
string = 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

transactionId
required
string

The dispute's transaction ID.

postedTime
required
string <date-time>

Dispute posted time.

type
required
string

The dispute's type.

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

The dispute's status.

Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
reasonCode
required
string

The dispute's reason code.

Enum: "1000" "10.1" "10.2" "10.3" "10.4" "10.5" "11.1" "11.2" "11.3" "12" … 156 more
acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

deadlineTime
string <date-time>

Dispute deadline time.

Responses
201

Dispute was created.

Response Headers
Location
string <uri>

The location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
currency
required
string = 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

transactionId
required
string

The dispute's transaction ID.

postedTime
required
string <date-time>

Dispute posted time.

type
required
string

The dispute's type.

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

The dispute's status.

Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
reasonCode
required
string

The dispute's reason code.

Enum: "1000" "10.1" "10.2" "10.3" "10.4" "10.5" "11.1" "11.2" "11.3" "12" … 156 more
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
deadlineTime
string <date-time>

Dispute deadline time.

rawResponse
string

Dispute raw response from gateway.

resolvedTime
string <date-time>

Dispute resolved time.

createdTime
string <date-time>

Dispute created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of Self (object) or TransactionLink (object) non-empty

The links related to resource.

Array (non-empty)
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
Array of TransactionEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

Array (non-empty)
Any of:

Transaction object.

object (Transaction)
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/disputes
Request samples
application/json
{
  • "transactionId": "string",
  • "currency": "USD",
  • "amount": 0,
  • "acquirerReferenceNumber": "string",
  • "caseId": "string",
  • "reasonCode": "1000",
  • "type": "information-request",
  • "status": "response-needed",
  • "postedTime": "2019-08-24T14:15:22Z",
  • "deadlineTime": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "customerId": "string",
  • "transactionId": "string",
  • "currency": "USD",
  • "amount": 0,
  • "acquirerReferenceNumber": "string",
  • "caseId": "string",
  • "reasonCode": "1000",
  • "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",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "_embedded": [
    ]
}