Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Card Disputes

If unauthorized activity occurs on a card, you can create a Card Dispute and we’ll work with the card networks to return the funds if appropriate.

The Card Dispute object
{
  "amount": 1000,
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "created_at": "2020-01-31T23:59:59Z",
  "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "id": "card_dispute_h9sc95nbl1cgltpp7men",
  "idempotency_key": null,
  "loss": null,
  "network": "visa",
  "status": "pending_response",
  "type": "card_dispute",
  "user_submission_required_by": null,
  "visa": {
    "network_events": [],
    "required_user_submission_category": null,
    "user_submissions": [
      {
        "accepted_at": null,
        "amount": 1000,
        "attachment_files": [],
        "category": "chargeback",
        "chargeback": {
          "authorization": null,
          "category": "fraud",
          "consumer_canceled_merchandise": null,
          "consumer_canceled_recurring_transaction": null,
          "consumer_canceled_services": null,
          "consumer_counterfeit_merchandise": null,
          "consumer_credit_not_processed": null,
          "consumer_damaged_or_defective_merchandise": null,
          "consumer_merchandise_misrepresentation": null,
          "consumer_merchandise_not_as_described": null,
          "consumer_merchandise_not_received": null,
          "consumer_non_receipt_of_cash": null,
          "consumer_original_credit_transaction_not_accepted": null,
          "consumer_quality_merchandise": null,
          "consumer_quality_services": null,
          "consumer_services_misrepresentation": null,
          "consumer_services_not_as_described": null,
          "consumer_services_not_received": null,
          "fraud": {
            "fraud_type": "lost"
          },
          "processing_error": null
        },
        "created_at": "2020-01-31T23:59:59Z",
        "further_information_requested_at": null,
        "further_information_requested_reason": null,
        "status": "pending_reviewing",
        "updated_at": "2020-01-31T23:59:59Z"
      }
    ]
  },
  "win": null
}
Attributes
amount
integer

The amount of the dispute.

card_id
string

The Card that the Card Dispute is associated with.

More about Cards.
created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

disputed_transaction_id
string

The identifier of the Transaction that was disputed.

More about Transactions.
id
string

The Card Dispute identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

loss
dictionary
Nullable

If the Card Dispute’s status is lost, this will contain details of the lost dispute.

network
string

The network that the Card Dispute is associated with.

status
enum

The status of the Card Dispute.

type
string

A constant representing the object’s type. For this resource it will always be card_dispute.

user_submission_required_by
string
Nullable

The ISO 8601 date and time at which the user submission is required by. Present only if status is user_submission_required and a user submission is required by a certain time. Otherwise, this will be nil.

visa
dictionary
Nullable

Card Dispute information for card payments processed over Visa’s network. This field will be present in the JSON response if and only if network is equal to visa.

win
dictionary
Nullable

If the Card Dispute’s status is won, this will contain details of the won dispute.

List Card Disputes
curl \
  --url "${INCREASE_URL}/card_disputes" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status.in
array of strings

Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create a Card Dispute
curl -X "POST" \
  --url "${INCREASE_URL}/card_disputes" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 100,
    "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
    "network": "visa",
    "visa": {
      "category": "fraud",
      "fraud": {
        "fraud_type": "account_or_credentials_takeover"
      }
    }
  }'
Parameters
amount
integer

The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.

attachment_files
array

The files to be attached to the initial dispute submission.

disputed_transaction_id
string
Required

The Transaction you wish to dispute. This Transaction must have a source_type of card_settlement.

More about Transactions.
network
enum
Required

The network of the disputed transaction. Details specific to the network are required under the sub-object with the same identifier as the network.

visa
dictionary

The Visa-specific parameters for the dispute. Required if and only if network is visa.

Retrieve a Card Dispute
curl \
  --url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_dispute_id
string
Required

The identifier of the Card Dispute.

More about Card Disputes.
Submit a User Submission for a Card Dispute
curl -X "POST" \
  --url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/submit_user_submission" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "network": "visa",
    "visa": {
      "category": "merchant_prearbitration_decline",
      "merchant_prearbitration_decline": {
        "reason": "The pre-arbitration received from the merchantdoes not explain how they obtained permission to charge the card."
      }
    }
  }'
Parameters
card_dispute_id
string
Required

The identifier of the Card Dispute to submit a user submission for.

More about Card Disputes.
amount
integer

The adjusted monetary amount of the part of the transaction that is being disputed. This is optional and will default to the most recent amount provided. If provided, the amount must be less than or equal to the amount of the transaction.

attachment_files
array

The files to be attached to the user submission.

network
enum
Required

The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.

visa
dictionary

The Visa-specific parameters for the dispute. Required if and only if network is visa.

Withdraw a Card Dispute
curl -X "POST" \
  --url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/withdraw" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_dispute_id
string
Required

The identifier of the Card Dispute to withdraw.

More about Card Disputes.
Sandbox: Advance the state of a Card Dispute

After a Card Dispute is created in production, the dispute will initially be in a pending_user_submission_reviewing state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/action" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "network": "visa",
    "visa": {
      "accept_user_submission": {},
      "action": "accept_user_submission"
    }
  }'
Parameters
card_dispute_id
string
Required

The dispute you would like to action.

More about Card Disputes.
network
enum
Required

The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network.

visa
dictionary

The Visa-specific parameters for the taking action on the dispute. Required if and only if network is visa.