List Card Disputes

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "created_at.after": {
      "type": "string",
      "format": "date-time",
      "description": "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp."
    },
    "created_at.before": {
      "type": "string",
      "format": "date-time",
      "description": "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp."
    },
    "created_at.on_or_after": {
      "type": "string",
      "format": "date-time",
      "description": "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp."
    },
    "created_at.on_or_before": {
      "type": "string",
      "format": "date-time",
      "description": "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp."
    },
    "cursor": {
      "type": "string",
      "description": "Return the page of entries after this one."
    },
    "limit": {
      "type": "integer",
      "description": "Limit the size of the list that is returned. The default (and maximum) is 100 objects."
    },
    "status.in": {
      "type": "array",
      "description": "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.",
      "items": {
        "type": "string",
        "enum": [
          "pending_reviewing",
          "accepted",
          "rejected"
        ]
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A list of Card Dispute objects",
  "required": [
    "data",
    "next_cursor"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "The contents of the list.",
      "items": {
        "type": "object",
        "description": "If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.",
        "required": [
          "id",
          "explanation",
          "status",
          "created_at",
          "disputed_transaction_id",
          "acceptance",
          "rejection",
          "type"
        ],
        "properties": {
          "acceptance": {
            "type": "object",
            "description": "If the Card Dispute's status is `accepted`, this will contain details of the successful dispute.",
            "required": [
              "accepted_at",
              "card_dispute_id",
              "transaction_id"
            ],
            "properties": {
              "accepted_at": {
                "type": "string",
                "format": "date-time",
                "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted."
              },
              "card_dispute_id": {
                "type": "string",
                "description": "The identifier of the Card Dispute that was accepted."
              },
              "transaction_id": {
                "type": "string",
                "description": "The identifier of the Transaction that was created to return the disputed funds to your account."
              }
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created."
          },
          "disputed_transaction_id": {
            "type": "string",
            "description": "The identifier of the Transaction that was disputed."
          },
          "explanation": {
            "type": "string",
            "description": "Why you disputed the Transaction in question."
          },
          "id": {
            "type": "string",
            "description": "The Card Dispute identifier."
          },
          "rejection": {
            "type": "object",
            "description": "If the Card Dispute's status is `rejected`, this will contain details of the unsuccessful dispute.",
            "required": [
              "explanation",
              "rejected_at",
              "card_dispute_id"
            ],
            "properties": {
              "card_dispute_id": {
                "type": "string",
                "description": "The identifier of the Card Dispute that was rejected."
              },
              "explanation": {
                "type": "string",
                "description": "Why the Card Dispute was rejected."
              },
              "rejected_at": {
                "type": "string",
                "format": "date-time",
                "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was rejected."
              }
            }
          },
          "status": {
            "type": "string",
            "description": "The results of the Dispute investigation.",
            "enum": [
              "pending_reviewing",
              "accepted",
              "rejected"
            ]
          },
          "type": {
            "type": "string",
            "description": "A constant representing the object's type. For this resource it will always be `card_dispute`.",
            "enum": [
              "card_dispute"
            ]
          }
        }
      }
    },
    "next_cursor": {
      "type": "string",
      "description": "A pointer to a place in the list."
    }
  }
}