Dispute createdWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Dispute webhook request body resource.

disputeId
string

ID of the dispute.

eventType
string

Type of webhook event.

Enum: "dispute-created" "dispute-modified"
object

Embedded objects.

object (Dispute)
currency
required
string = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Dispute amount.

transactionId
required
string

ID of the disputed transaction.

postedTime
required
string <date-time>

Date and time when the dispute is posted.

type
required
string

Type of dispute.

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

Status of the dispute.

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

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

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

ID of the dispute.

customerId
string <= 50 characters

ID of the customer who is disputing a transaction.

acquirerReferenceNumber
string

Acquirer reference number for the dispute.

caseId
string

Case ID of the dispute.

category
string

Category of dispute.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
deadlineTime
string <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.

rawResponse
string

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

resolvedTime
string <date-time>

Date and time when the dispute is resolved.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "dispute"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "disputeId": "string",
  • "eventType": "dispute-created",
  • "_embedded": {
    },
  • "_links": [
    ]
}