List External Accounts

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "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": [
          "active",
          "archived"
        ]
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A list of External Account objects",
  "required": [
    "data",
    "next_cursor"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "The contents of the list.",
      "items": {
        "type": "object",
        "description": "External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.",
        "required": [
          "id",
          "created_at",
          "description",
          "status",
          "routing_number",
          "account_number",
          "funding",
          "verification_status",
          "type"
        ],
        "properties": {
          "account_number": {
            "type": "string",
            "description": "The destination account number."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External Account was created."
          },
          "description": {
            "type": "string",
            "description": "The External Account's description for display purposes."
          },
          "funding": {
            "type": "string",
            "description": "The type of the account to which the transfer will be sent.",
            "enum": [
              "checking",
              "savings",
              "other"
            ]
          },
          "id": {
            "type": "string",
            "description": "The External Account's identifier."
          },
          "routing_number": {
            "type": "string",
            "description": "The American Bankers' Association (ABA) Routing Transit Number (RTN)."
          },
          "status": {
            "type": "string",
            "description": "The External Account's status.",
            "enum": [
              "active",
              "archived"
            ]
          },
          "type": {
            "type": "string",
            "description": "A constant representing the object's type. For this resource it will always be `external_account`.",
            "enum": [
              "external_account"
            ]
          },
          "verification_status": {
            "type": "string",
            "description": "If you have verified ownership of the External Account.",
            "enum": [
              "unverified",
              "pending",
              "verified"
            ]
          }
        }
      }
    },
    "next_cursor": {
      "type": "string",
      "description": "A pointer to a place in the list."
    }
  }
}