Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Create a Card Dispute

post/card_disputes

Request body

amountinteger

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_idstring required

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

explanationstring

The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks.

network'visa' 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.

Example request

{
  "amount": 100,
  "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "network": "visa",
  "visa": {
    "category": "fraud",
    "fraud": {
      "fraud_type": "account_or_credentials_takeover"
    }
  }
}

Response

Card Dispute

amountinteger required

The amount of the dispute.

card_idstring required

The Card that the Card Dispute is associated with.

created_atstring date-time required

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

disputed_transaction_idstring required

The identifier of the Transaction that was disputed.

idstring required

The Card Dispute identifier.

idempotency_keystring nullable required

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.

network'visa' | 'pulse' required

The network that the Card Dispute is associated with.

status'user_submission_required' | 'pending_user_submission_reviewing' | 'pending_user_submission_submitting' | 'pending_user_withdrawal_submitting' | 'pending_response' | 'lost' | 'won' | 'rejected' required

The status of the Card Dispute.

type'card_dispute' required

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

user_submission_required_bystring date-time nullable required

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.

Example response

{
  "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",
  "rejection": null,
  "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",
        "explanation": null,
        "further_information_requested_at": null,
        "further_information_requested_reason": null,
        "status": "pending_reviewing",
        "updated_at": "2020-01-31T23:59:59Z"
      }
    ]
  },
  "win": null,
  "withdrawal": null
}