WePay logo
      Nothing Found

Update a dispute

post/disputes/{id}

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.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the dispute, generated by WePay when the dispute is created.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Request Body schema: application/json
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.

Responses
200
Response Schema: application/json
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.

Value: Description
disputes
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: awaiting_payee_response, awaiting_chargeback_decision, pending_wepay_review, resolved,awaiting_chargeback_decision_with_credit,'awaiting_chargeback_decision_without_credit'.

Enum: Description
awaiting_merchant_response

The merchant has not provided any response to the dispute. If the merchant want to attempt to recoup these funds, they must upload documentation supporting the charge.

pending_wepay_review

WePay is reviewing the dispute and any documentation submitted by the merchant. Once WePay's review is complete, the status will be updated.

… 4 more
type
required
string

Type of dispute.

Enum: Description
inquiry

Some card brands like AmEx will issue an inquiry to get more information about a charge. If inquiries are not responded to, the inquiry will be closed and a dispute will be created.

chargeback

When a chargeback occurs, it means that the card holder or card issuer does not believe the payment should have been made. Merchants can challenge a dispute by uploading documentation.

… 3 more
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: CAD, USD.

required
object

The payment linked to this refund or dispute.

card_brand
required
string
Enum: Description
visa
mastercard
… 4 more
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
400

DISPUTE_CANNOT_BE_FURTHER_MODIFIED, INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "documentation": {
    • "documents": [
      • "docu-abc123",
      • "docu-efg456",
      • "docu-hij789"
      ],
    • "explanation": "lorem ipsum dolores umbridge"
    }
}
Response samples
application/json
{
  • "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"
}