Retrieve a sweep

v1.0.0

The /bank_transfer/sweep/get endpoint fetches information about the sweep corresponding to the given sweep_id.

Input

{
  "type": "object",
  "description": "Defines the request schema for `/bank_transfer/sweep/get`",
  "required": [
    "sweep_id"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
    },
    "secret": {
      "type": "string",
      "description": "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
    },
    "sweep_id": {
      "type": "string",
      "description": "Identifier of the sweep."
    }
  }
}

Output

{
  "type": "object",
  "description": "BankTransferSweepGetResponse defines the response schema for `/bank_transfer/sweep/get`",
  "required": [
    "request_id",
    "sweep"
  ],
  "properties": {
    "request_id": {
      "type": "string",
      "description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
    },
    "sweep": {
      "type": "object",
      "description": "BankTransferSweep describes a sweep transfer.",
      "required": [
        "amount",
        "created_at",
        "id",
        "iso_currency_code"
      ],
      "properties": {
        "amount": {
          "type": "string",
          "description": "The amount of the sweep."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "The datetime when the sweep occurred, in RFC 3339 format."
        },
        "id": {
          "type": "string",
          "description": "Identifier of the sweep."
        },
        "iso_currency_code": {
          "type": "string",
          "description": "The currency of the sweep, e.g. \"USD\"."
        }
      }
    }
  }
}