Disputes

Handle disputes (chargebacks and retrievals).

Retrieve a list of disputes

Retrieve a list of disputes.

Request
Security:
query Parameters
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

q
string

The partial search of the text fields.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200A list of disputes was retrieved successfully.
Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
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"
postedTime
required
string <date-time>

Dispute posted time.

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>

Dispute updated time.

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

The links related to resource.

Array of TransactionEmbed (object) non-empty

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

401Unauthorized access, invalid credentials was used.
403Access forbidden.
get/disputes
Request samples
$disputes = $client->disputes()->search([
    'filter' => 'transactionId:testId',
]);
Response samples
application/json
[
  • {
    }
]

Create a dispute

Create a dispute.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Dispute resource.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
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"
postedTime
required
string <date-time>

Dispute posted time.

deadlineTime
string <date-time>

Dispute deadline time.

Responses
201Dispute was created.
Response Schema: application/json
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
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"
postedTime
required
string <date-time>

Dispute posted time.

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>

Dispute updated time.

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

The links related to resource.

Array of TransactionEmbed (object) non-empty

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

401Unauthorized access, invalid credentials was used.
403Access forbidden.
422Invalid 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": [
    ]
}

Retrieve a dispute

Retrieve a dispute with specified identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200Dispute was retrieved successfully.
Response Schema: application/json
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
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"
postedTime
required
string <date-time>

Dispute posted time.

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>

Dispute updated time.

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

The links related to resource.

Array of TransactionEmbed (object) non-empty

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

401Unauthorized access, invalid credentials was used.
403Access forbidden.
404Resource was not found.
get/disputes/{id}
Request samples
$dispute = $client->disputes()->load('disputeId');
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": [
    ]
}

Create or update a Dispute with predefined ID

Create or update a Dispute with predefined identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Dispute resource.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
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"
postedTime
required
string <date-time>

Dispute posted time.

deadlineTime
string <date-time>

Dispute deadline time.

Responses
200Dispute was updated.
Response Schema: application/json
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
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"
postedTime
required
string <date-time>

Dispute posted time.

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>

Dispute updated time.

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

The links related to resource.

Array of TransactionEmbed (object) non-empty

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

201Dispute was created.
Response Schema: application/json
id
string <= 50 characters

The dispute identifier string.

customerId
string

The dispute's customer ID.

transactionId
required
string

The dispute's transaction ID.

currency
required
string 3 characters

ISO 4217 alphabetic currency code.

amount
required
number <double>

The dispute amount.

acquirerReferenceNumber
string

The dispute's acquirer reference number.

caseId
string

The case ID for the dispute.

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" "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" "2" "30" "31" "35" "37" "40" "41" "42" "46" "47" "49" "50" "53" "54" "55" "57" "59" "60" "62" "7" "70" "71" "72" "73" "74" "75" "76" "77" "79" "8" "80" "81" "82" "83" "85" "86" "93" "00" "63" "A01" "A02" "A08" "F10" "F14" "F22" "F24" "F29" "C02" "C04" "C05" "C08" "C14" "C18" "C28" "C31" "C32" "M10" "M49" "P01" "P03" "P04" "P05" "P07" "P08" "P22" "P23" "R03" "R13" "M01" "FR1" "FR4" "FR6" "AL" "AP" "AW" "CA" "CD" "CR" "DA" "DP" "DP1" "EX" "IC" "IN" "IS" "LP" "N" "NA" "NC" "P" "RG" "RM" "RN1" "RN2" "SV" "TF" "TNM" "UA01" "UA02" "UA32" "UA99" "UA03" "UA10" "UA11" "UA12" "UA18" "UA20" "UA21" "UA22" "UA23" "UA28" "UA30" "UA31" "UA38" "duplicate" "fraudulent" "subscription_canceled" "product_unacceptable" "product_not_received" "unrecognized" "credit_not_processed" "customer_initiated" "incorrect_account_details" "insufficient_funds" "bank_cannot_process" "debit_not_authorized" "general" "pre-chargeback-alert" "0" "1" "2" "3" "4" "5" "6" "7" "9" "51" "A" "B"
category
string

The dispute's category.

Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized"
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"
postedTime
required
string <date-time>

Dispute posted time.

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>

Dispute updated time.

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

The links related to resource.

Array of TransactionEmbed (object) non-empty

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

401Unauthorized access, invalid credentials was used.
403Access forbidden.
422Invalid data was sent.
put/disputes/{id}
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": [
    ]
}

Dispute createdWebhook

Request
Security:
Request Body schema: application/json

Dispute webhook request body resource.

disputeId
string

The dispute ID.

eventType
string (GlobalWebhookEventType)

Rebilly webhooks event type.

Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "dispute-modified" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"
object
Array of DisputeLink (object) non-empty

The links related to resource.

Responses
2xxReturn any 2xx status to indicate that the data was received successfully.
Request samples
application/json
{
  • "disputeId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}

Dispute modifiedWebhook

Request
Security:
Request Body schema: application/json

Dispute webhook request body resource.

disputeId
string

The dispute ID.

eventType
string (GlobalWebhookEventType)

Rebilly webhooks event type.

Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "dispute-modified" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "gateway-account-onboarding-completed" "gateway-account-onboarding-failed" "gateway-account-requested" "invoice-abandoned" "invoice-created" "invoice-issued" "invoice-modified" "invoice-paid" "invoice-past-due" "invoice-past-due-reminder" "invoice-reissued" "invoice-voided" "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "lead-source-changed" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "payment-instrument-modified" "renewal-invoice-issued" "renewal-invoice-payment-canceled" "renewal-invoice-payment-declined" "risk-score-changed" "subscription-activated" "subscription-canceled" "subscription-modified" "subscription-reactivated" "subscription-renewal-reminder" "subscription-renewed" "subscription-trial-converted" "subscription-trial-end-reminder" "subscription-trial-ended" "subscription-trial-end-changed" "transaction-amount-discrepancy-found" "transaction-declined" "transaction-discrepancy-found" "transaction-process-requested" "transaction-processed" "transaction-reconciled" "transaction-timeout-resolved" "waiting-gateway-transaction-completed"
object
Array of DisputeLink (object) non-empty

The links related to resource.

Responses
2xxReturn any 2xx status to indicate that the data was received successfully.
Request samples
application/json
{
  • "disputeId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}