WePay logo
      Nothing Found

Get a collection of disputes

get/disputes

The GET /disputes call allows your platform to look up a collection of disputes. 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
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

owner_id
string

Return elements owned by this resource instance.

type
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
payment_id
string

ID of the payment associated with the dispute.

status
string

Status of the dispute. Possible values include: awaiting_merchant_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
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

required
Array of objects unique

An array of dispute objects.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/disputes?page=QVFQNUFBRVhTODFydGc1V1FMMTZwU28rZXJ5L1Q4S3ZqU0JnSDliUklPdm1adEpITUtsanFMMU84aWtjMnl6RDhxakkrZ2xGNzQ2YVFvanEvaXExbUtXUmFVeEtqelF5TTQ0L04vS0NPa3dmS01BWnBvWjI0b0IvQ0I5NzM2OS9icExZSENOTmhhTmhyS1R4RVF2Sk1ucHNyNFErOXdOYXE1R1hPL3BSUXhEY21xb01VT3FDeGxyVnpPclg5S1RIci9PdDF4WXE5RUFndHJ1alN2ODhNSGc0",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "amount": 2200,
      • "create_time": 1519348426,
      • "currency": "USD",
      • "custom_data": null,
      • "documentation": {
        • "documents": [ ],
        • "explanation": ""
        },
      • "fee": 0,
      • "id": "0645172c-c054-11e7-abc4-cec278b6b50a",
      • "owner": {
        • "id": "0ccb661e-c054-11e7-abc4-cec278b6b50a",
        • "path": "/accounts/0ccb661e-c054-11e7-abc4-cec278b6b50a",
        • "resource": "accounts"
        },
      • "path": "/disputes/0645172c-c054-11e7-abc4-cec278b6b50a",
      • "payment": {
        • "id": "14f45de6-c054-11e7-abc4-cec278b6b50a",
        • "path": "/payments/14f45de6-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": "awaiting_merchant_response",
      • "txnr_chargeback_app_fees": null,
      • "txnr_chargeback_merchant": {
        • "id": "1ce52e72-c054-11e7-abc4-cec278b6b50a",
        • "path": "/transaction_records/1ce52e72-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"
      }
    ]
}