Update a dispute

POST

/v1/disputes/{id}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

evidence

object (Dispute Evidence)

required

access_activity_log

string

optional

Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.

billing_address

string

optional

The billing address provided by the customer.

cancellation_policy

string

optional

(ID of a file upload) Your subscription cancellation policy, as shown to the customer.

cancellation_policy_disclosure

string

optional

An explanation of how and when the customer was shown your refund policy prior to purchase.

cancellation_rebuttal

string

optional

A justification for why the customer’s subscription was not canceled.

customer_communication

string

optional

(ID of a file upload) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.

customer_email_address

string

optional

The email address of the customer.

customer_name

string

optional

Customer name.

customer_purchase_ip

string

optional

The IP address that the customer used when making the purchase.

customer_signature

string

optional

(ID of a file upload) A relevant document or contract showing the customer’s signature.

duplicate_charge_documentation

string

optional

(ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.

duplicate_charge_explanation

string

optional

An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.

duplicate_charge_id

string

optional

The ID for the prior charge which appears to be a duplicate of the disputed charge.

product_description

string

optional

A description of the product or service that was sold.

receipt

string

optional

(ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.

refund_policy

string

optional

(ID of a file upload) Your refund policy, as shown to the customer.

refund_policy_disclosure

string

optional

Documentation demonstrating that the customer was shown your refund policy prior to purchase.

refund_refusal_explanation

string

optional

A justification for why the customer is not entitled to a refund.

service_date

string

optional

The date on which the customer received or began receiving the purchased service, in a clear human-readable format.

service_documentation

string

optional

(ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.

shipping_address

string

optional

The address to which a physical product was shipped. You should try to include as complete address information as possible.

shipping_carrier

string

optional

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.

shipping_date

string

optional

The date on which a physical product began its route to the shipping address, in a clear human-readable format.

shipping_documentation

string

optional

(ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer’s full shipping address, if possible.

shipping_tracking_number

string

optional

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

uncategorized_file

string

optional

(ID of a file upload) Any additional evidence or statements.

uncategorized_text

string

optional

Any additional evidence or statements.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

submit

boolean

optional

Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true (the default).

Example

{
    "evidence": {
        "access_activity_log": "string",
        "billing_address": "string",
        "cancellation_policy": "string",
        "cancellation_policy_disclosure": "string",
        "cancellation_rebuttal": "string",
        "customer_communication": "string",
        "customer_email_address": "string",
        "customer_name": "string",
        "customer_purchase_ip": "string",
        "customer_signature": "string",
        "duplicate_charge_documentation": "string",
        "duplicate_charge_explanation": "string",
        "duplicate_charge_id": "string",
        "product_description": "string",
        "receipt": "string",
        "refund_policy": "string",
        "refund_policy_disclosure": "string",
        "refund_refusal_explanation": "string",
        "service_date": "string",
        "service_documentation": "string",
        "shipping_address": "string",
        "shipping_carrier": "string",
        "shipping_date": "string",
        "shipping_documentation": "string",
        "shipping_tracking_number": "string",
        "uncategorized_file": "string",
        "uncategorized_text": "string"
    },
    "metadata": {},
    "submit": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apitest.wooshpay.com/v1/disputes/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "evidence": {
        "access_activity_log": "string",
        "billing_address": "string",
        "cancellation_policy": "string",
        "cancellation_policy_disclosure": "string",
        "cancellation_rebuttal": "string",
        "customer_communication": "string",
        "customer_email_address": "string",
        "customer_name": "string",
        "customer_purchase_ip": "string",
        "customer_signature": "string",
        "duplicate_charge_documentation": "string",
        "duplicate_charge_explanation": "string",
        "duplicate_charge_id": "string",
        "product_description": "string",
        "receipt": "string",
        "refund_policy": "string",
        "refund_policy_disclosure": "string",
        "refund_refusal_explanation": "string",
        "service_date": "string",
        "service_documentation": "string",
        "shipping_address": "string",
        "shipping_carrier": "string",
        "shipping_date": "string",
        "shipping_documentation": "string",
        "shipping_tracking_number": "string",
        "uncategorized_file": "string",
        "uncategorized_text": "string"
    },
    "metadata": {},
    "submit": true
}'

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object.

object

string

optional

"dispute"

amount

integer

optional

Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).

charge

string

optional

ID of the charge that was disputed.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code, in lowercase. Must be a supported currency.

evidence

object (Dispute Evidence)

optional

Evidence provided to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review.

access_activity_log

string

optional

billing_address

string

optional

The billing address provided by the customer.

cancellation_policy

string

optional

(ID of a file upload) Your subscription cancellation policy, as shown to the customer.

cancellation_policy_disclosure

string

optional

An explanation of how and when the customer was shown your refund policy prior to purchase.

cancellation_rebuttal

string

optional

A justification for why the customer’s subscription was not canceled.

customer_communication

string

optional

customer_email_address

string

optional

The email address of the customer.

customer_name

string

optional

Customer name.

customer_purchase_ip

string

optional

The IP address that the customer used when making the purchase.

customer_signature

string

optional

(ID of a file upload) A relevant document or contract showing the customer’s signature.

duplicate_charge_documentation

string

optional

duplicate_charge_explanation

string

optional

An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.

duplicate_charge_id

string

optional

The ID for the prior charge which appears to be a duplicate of the disputed charge.

product_description

string

optional

A description of the product or service that was sold.

receipt

string

optional

(ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.

refund_policy

string

optional

(ID of a file upload) Your refund policy, as shown to the customer.

refund_policy_disclosure

string

optional

Documentation demonstrating that the customer was shown your refund policy prior to purchase.

refund_refusal_explanation

string

optional

A justification for why the customer is not entitled to a refund.

service_date

string

optional

The date on which the customer received or began receiving the purchased service, in a clear human-readable format.

service_documentation

string

optional

(ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.

shipping_address

string

optional

The address to which a physical product was shipped. You should try to include as complete address information as possible.

shipping_carrier

string

optional

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.

shipping_date

string

optional

The date on which a physical product began its route to the shipping address, in a clear human-readable format.

shipping_documentation

string

optional

shipping_tracking_number

string

optional

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

uncategorized_file

string

optional

(ID of a file upload) Any additional evidence or statements.

uncategorized_text

string

optional

Any additional evidence or statements.

evidence_details

object

optional

due_by

integer

optional

Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer’s bank or credit card company doesn’t allow a response for this particular dispute.

has_evidence

boolean

optional

Whether evidence has been staged for this dispute.

past_due

boolean

optional

Whether the last evidence submission was submitted past the due date. Defaults to false if no evidence submissions have occurred. If true, then delivery of the latest evidence is not guaranteed.

submission_count

integer

optional

The number of times evidence has been submitted. Typically, you may only submit evidence once.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

payment_intent

string

optional

ID of the PaymentIntent that was disputed.

status

enum<string>

optional

Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.

Allowed values:

warning_needs_responsewarning_under_reviewwarning_closedneeds_responseunder_reviewcharge_refundedwonlostearly_dispute_warningearly_dispute_resolved

reason_type

string

optional

Visa and MasterCard organized their reason codes into four categories. While American Express and Discover each use additional categories to help categorize their reason codes, customer dispute categorization is moving towards the four category standard.

reason_description

string

optional

The detailed description of the dispute reason.

reason_code

string

optional

Reason codes are alphanumeric strings of text provided in a chargeback notification as a means of explaining the cause for the dispute.

Example

{
    "id": "dp_xxxxxxxxxxxxxxxxxx",
    "object": "dispute",
    "amount": 1000,
    "balance_transactions": [],
    "created": 1669643926,
    "currency": "eur",
    "evidence": {
        "access_activity_log": null,
        "billing_address": null,
        "cancellation_policy": null,
        "cancellation_policy_disclosure": null,
        "cancellation_rebuttal": null,
        "customer_communication": null,
        "customer_email_address": null,
        "customer_name": null,
        "customer_purchase_ip": null,
        "customer_signature": null,
        "duplicate_charge_documentation": null,
        "duplicate_charge_explanation": null,
        "duplicate_charge_id": null,
        "product_description": null,
        "receipt": null,
        "refund_policy": null,
        "refund_policy_disclosure": null,
        "refund_refusal_explanation": null,
        "service_date": null,
        "service_documentation": null,
        "shipping_address": null,
        "shipping_carrier": null,
        "shipping_date": null,
        "shipping_documentation": null,
        "shipping_tracking_number": null,
        "uncategorized_file": null,
        "uncategorized_text": null
    },
    "evidence_details": {
        "due_by": 1671321599,
        "has_evidence": false,
        "past_due": false,
        "submission_count": 0
    },
    "livemode": false,
    "metadata": {},
    "status": "warning_needs_response"
}

Retrieve a dispute

Close a dispute