Retrieve a dispute

Retrieves an Issuing Dispute object.

Parameters

No parameters.

Returns

Returns an Issuing Dispute object if a valid identifier was provided.

GET /v1/issuing/disputes/:id

curl https://api.stripe.com/v1/issuing/disputes/idp_1MykdxFtDWhhyHE1BFAV3osZ \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ",
  "object": "issuing.dispute",
  "amount": 100,
  "created": 1681947753,
  "currency": "usd",
  "evidence": {
    "fraudulent": {
      "additional_documentation": null,
      "dispute_explanation": null,
      "explanation": "This transaction is fraudulent.",
      "uncategorized_file": null
    },
    "reason": "fraudulent"
  },
  "livemode": false,
  "metadata": {},
  "status": "unsubmitted",
  "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"
}

List all disputes

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Parameters

transactionstring
Select the Issuing dispute for the given transaction.

More parameters

createdobject

ending_beforestring

limitinteger

starting_afterstring

statusenum

Returns

A dictionary with a data property that contains an array of up to limit disputes, starting after dispute starting_after. Each entry in the array is a separate Issuing Dispute object. If no more disputes are available, the resulting array will be empty.

GET /v1/issuing/disputes

curl -G https://api.stripe.com/v1/issuing/disputes \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/issuing/disputes",
  "has_more": false,
  "data": [
    {
      "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ",
      "object": "issuing.dispute",
      "amount": 100,
      "created": 1681947753,
      "currency": "usd",
      "evidence": {
        "fraudulent": {
          "additional_documentation": null,
          "dispute_explanation": null,
          "explanation": "This transaction is fraudulent.",
          "uncategorized_file": null
        },
        "reason": "fraudulent"
      },
      "livemode": false,
      "metadata": {},
      "status": "unsubmitted",
      "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"
    }
  ]
}

Submit a dispute

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Parameters

metadataobject
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.

Returns

Returns an Issuing Dispute object in submitted status if submission succeeds.

POST /v1/issuing/disputes/:id/submit

curl -X POST https://api.stripe.com/v1/issuing/disputes/idp_1MykdxFtDWhhyHE1BFAV3osZ/submit \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ",
  "object": "issuing.dispute",
  "amount": 100,
  "created": 1681947753,
  "currency": "usd",
  "evidence": {
    "fraudulent": {
      "additional_documentation": null,
      "dispute_explanation": null,
      "explanation": "This transaction is fraudulent.",
      "uncategorized_file": null
    },
    "reason": "fraudulent"
  },
  "livemode": false,
  "metadata": {},
  "status": "submitted",
  "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"
}

Funding Instructions

Funding Instructions contain reusable bank account and routing information. Push funds to these addresses via bank transfer to top up Issuing Balances.

Endpoints

POST/v1/issuing/funding_instructions

GET/v1/issuing/funding_instructions

POST/v1/test_helpers/issuing/fund_balance