Retrieve a list of disputes.
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 |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
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 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" The dispute's reason code. |
category | string Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized" The dispute's category. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
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 |
$disputes = $client->disputes()->search([ 'filter' => 'transactionId:testId', ]);
[- {
- "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "transaction": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "emails": [
- {
- "label": null,
- "value": null,
- "primary": null
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": null,
- "offerType": null,
- "bumpAmount": null,
- "bumpAmountInUsd": null,
- "customFields": null
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": null,
- "paymentInstruction": null
}
], - "afterAttemptPolicy": "none",
- "afterRetryEndPolicy": "none"
}, - "retriedTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "retriesResult": "approved",
- "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "scheduledTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}
}
]
}
]
Create a dispute.
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
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 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" The dispute's reason code. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
postedTime required | string <date-time> Dispute posted time. |
deadlineTime | string <date-time> Dispute deadline time. |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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 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" The dispute's reason code. |
category | string Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized" The dispute's category. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
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 |
{- "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"
}
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "transaction": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": {
- "method": null
}, - "paymentInstruction": {
- "method": null
}
}
], - "afterAttemptPolicy": "none",
- "afterRetryEndPolicy": "none"
}, - "retriedTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "retriesResult": "approved",
- "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "scheduledTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}
}
]
}
Retrieve a dispute with specified identifier string.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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 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" The dispute's reason code. |
category | string Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized" The dispute's category. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
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 |
$dispute = $client->disputes()->load('disputeId');
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "transaction": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": {
- "method": null
}, - "paymentInstruction": {
- "method": null
}
}
], - "afterAttemptPolicy": "none",
- "afterRetryEndPolicy": "none"
}, - "retriedTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "retriesResult": "approved",
- "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "scheduledTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}
}
]
}
Create or update a Dispute with predefined identifier string.
id required | string <= 50 characters ^[@~\-\.\w]+$ The resource identifier string. |
Organization-Id | string (ResourceId) <= 50 characters Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21 Organization identifier in scope of which need to perform request (if not specified, the default organization will be used). |
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 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" The dispute's reason code. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
postedTime required | string <date-time> Dispute posted time. |
deadlineTime | string <date-time> Dispute deadline time. |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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 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" The dispute's reason code. |
category | string Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized" The dispute's category. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
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 |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
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 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" The dispute's reason code. |
category | string Enum: "fraud" "unrecognized" "product-not-received" "product-unacceptable" "product-not-refunded" "duplicate" "subscription-canceled" "uncategorized" The dispute's category. |
type required | string Enum: "information-request" "first-chargeback" "second-chargeback" "arbitration" "fraud" "ethoca-alert" "verifi-alert" The dispute's type. |
status required | string Enum: "response-needed" "under-review" "forfeited" "won" "lost" "unknown" The dispute's status. |
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 |
{- "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"
}
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "transaction": {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "type": "3ds-authentication",
- "status": "completed",
- "result": "abandoned",
- "amount": 0,
- "currency": "USD",
- "purchaseAmount": 0,
- "purchaseCurrency": "USD",
- "requestAmount": 0,
- "requestCurrency": "USD",
- "parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "childTransactions": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "subscriptionIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "planIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "isRebill": true,
- "rebillNumber": 0,
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "has3ds": true,
- "3ds": {
- "version": "1.0.2",
- "enrolled": "yes",
- "authenticated": "yes",
- "liability": "protected",
- "flow": "frictionless",
- "isDowngraded": false
}, - "retryNumber": 0,
- "isRetry": true,
- "billingDescriptor": "string",
- "description": "string",
- "requestId": "string",
- "hasAmountAdjustment": true,
- "gatewayName": "A1Gateway",
- "customFields": {
- "foo": "bar"
}, - "processedTime": "2019-08-24T14:15:22Z",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "score": 0
}, - "retryInstruction": {
- "attempts": [
- {
- "scheduleInstruction": {
- "method": null
}, - "paymentInstruction": {
- "method": null
}
}
], - "afterAttemptPolicy": "none",
- "afterRetryEndPolicy": "none"
}, - "retriedTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "retriesResult": "approved",
- "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "scheduledTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}
}
]
}
Dispute webhook request body resource.
disputeId | string The dispute ID. |
eventType | string (GlobalWebhookEventType) Enum: "aml-list-possibly-matched" "customer-created" "customer-merged" "customer-one-time-password-requested" "customer-updated" "dispute-created" "experian-check-performed" "gateway-account-downtime-ended" "gateway-account-downtime-started" "gateway-account-limit-reached" "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" "nsf-response-received" "offsite-payment-completed" "order-completed" "payment-card-created" "payment-card-expiration-reminder" "payment-card-expired" "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" Rebilly webhooks event type. |
object | |
Array of DisputeLink (object) non-empty The links related to resource. |
{- "disputeId": "string",
- "eventType": "aml-list-possibly-matched",
- "_embedded": {
- "dispute": {
- "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"
}
}, - "_links": [
- {
- "rel": "dispute",
- "href": "string"
}
]
}