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 return the funds if appropriate.

The Card Dispute object
{
  "acceptance": null,
  "amount": null,
  "created_at": "2020-01-31T23:59:59Z",
  "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "explanation": "Unauthorized recurring purchase",
  "id": "card_dispute_h9sc95nbl1cgltpp7men",
  "idempotency_key": null,
  "loss": null,
  "rejection": null,
  "status": "pending_reviewing",
  "type": "card_dispute",
  "win": null
}
Attributes
acceptance
dictionary
Nullable

If the Card Dispute's status is accepted, this will contain details of the successful dispute.

amount
integer
Nullable

The amount of the dispute, if provided, or the transaction amount otherwise.

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.

explanation
string

Why you disputed the Transaction in question.

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.

rejection
dictionary
Nullable

If the Card Dispute's status is rejected, this will contain details of the unsuccessful dispute.

status
enum

The results of the Dispute investigation.

type
string

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

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 $'{
    "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
    "explanation": "Unauthorized recurring transaction."
  }'
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.

disputed_transaction_id
string
Required

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

explanation
string
Required

Why you are disputing this Transaction.

2000 character maximum
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.

Sandbox: Advance the state of a Card Dispute

After a Card Dispute is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of pending_reviewing.

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 $'{
    "explanation": "This was a valid recurring transaction",
    "status": "rejected"
  }'
Parameters
card_dispute_id
string
Required

The dispute you would like to action.

explanation
string

Why the dispute was rejected. Not required for accepting disputes.

200 character maximum
status
enum
Required

The status to move the dispute to.