The POST /disputes/{id} call allows your platform to update and add custom data to a single dispute. Be sure to subscribe to the disputes.created
Notification event topic in order to programmatically integrate any new Disputes that a merchant receives. Learn more about Disputes in Manage Payment Operations and in the Disputes Deep Dive resource.
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |
object Documentation provided by your merchant to challenge the dispute. | |
Array of objects or null Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects. |
id required | string ID of the dispute, generated by WePay when the dispute is created. | ||||||
resource required | string Helps organize information by identifying the resource type of the object data.
| ||||||
path required | string Path of resource and resource ID. | ||||||
required | object or null Details the owner resource and owner path. | ||||||
create_time required | integer <int64> >= 0 | ||||||
status required | string Status of the dispute. Possible values include:
| ||||||
type required | string Type of dispute.
| ||||||
amount required | integer The amount under dispute. If the dispute amount differs from the transaction amount, there is either a partial dispute or an exchange rate fluctuation. | ||||||
fee required | integer Specifies whether an app fee will be collected and who should pay the app fee. | ||||||
currency required | string ISO 4217 currency code. Possible values include: | ||||||
required | object The payment linked to this refund or dispute. | ||||||
card_brand required | string
| ||||||
required | object The reason a chargeback is being disputed. | ||||||
required | object or null The ultimate resolution to the dispute. | ||||||
required | object or null If a chargeback has occurred, fetch this transaction record to account for the portion of the chargeback debited from the merchant. | ||||||
required | object or null If a chargeback has occurred and has since been reversed, fetch this transaction record to account for the portion of the reversal credited back to the merchant. | ||||||
required | object or null If a chargeback has occurred, fetch this transaction record to account for the chargeback fee charged to the merchant. | ||||||
required | object or null If a chargeback has occurred, fetch this transaction record to account for the portion of the chargeback debited from your platform account balance. | ||||||
required | object or null If a chargeback has occurred and has since been reversed, fetch this transaction record to account for the portion of the reversal credited to your platform account balance. | ||||||
required | object Documentation provided by your merchant to challenge the dispute. | ||||||
required | object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | ||||||
api_version | string |
DISPUTE_CANNOT_BE_FURTHER_MODIFIED, INVALID_PARAMS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "documentation": {
- "documents": [
- "docu-abc123",
- "docu-efg456",
- "docu-hij789"
], - "explanation": "lorem ipsum dolores umbridge"
}
}
{- "amount": 2200,
- "create_time": 1519348426,
- "currency": "USD",
- "custom_data": null,
- "documentation": {
- "documents": [
- "docu-abc123",
- "docu-efg456",
- "docu-hij789"
], - "explanation": "lorem ipsum dolores umbridge"
}, - "fee": 0,
- "id": "47521346-c054-11e7-abc4-cec278b6b50a",
- "owner": {
- "id": "4e46a6c6-c054-11e7-abc4-cec278b6b50a",
- "path": "/accounts/4e46a6c6-c054-11e7-abc4-cec278b6b50a",
- "resource": "accounts"
}, - "path": "/disputes/47521346-c054-11e7-abc4-cec278b6b50a",
- "payment": {
- "id": "532c82aa-c054-11e7-abc4-cec278b6b50a",
- "path": "/payments/532c82aa-c054-11e7-abc4-cec278b6b50a",
- "resource": "payments"
}, - "card_brand": "visa",
- "reason": {
- "reason_code": "RECOGNITION",
- "reason_message": "The payer did not recognize the transaction",
- "details": [
- {
- "detail_code": "11.2",
- "detail_message": "Declined Authorization"
}
]
}, - "resolution": null,
- "resource": "disputes",
- "status": "pending_wepay_review",
- "txnr_chargeback_app_fees": null,
- "txnr_chargeback_merchant": {
- "id": "5c7a7f2e-c054-11e7-abc4-cec278b6b50a",
- "path": "/transaction_records/5c7a7f2e-c054-11e7-abc4-cec278b6b50a",
- "resource": "transaction_records"
}, - "txnr_chargeback_reversal_app_fee": null,
- "txnr_chargeback_reversal_merchant": null,
- "txnr_merchant_chargeback_fee": {
- "id": "f2e5c7a7-c054-11e7-abc4-6b50acec278b",
- "path": "/transaction_records/f2e5c7a7-c054-11e7-abc4-6b50acec278b",
- "resource": "transaction_records"
}, - "type": "chargeback",
- "api_version": "3.0"
}