Get balance of your Bank Transfer account

v1.0.0

Use the /bank_transfer/balance/get endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.

The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.

Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.

Input

{
  "type": "object",
  "description": "Defines the request schema for `/bank_transfer/balance/get`",
  "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."
    },
    "origination_account_id": {
      "type": "string",
      "description": "If multiple origination accounts are available, `origination_account_id` must be used to specify the account for which balance will be returned."
    },
    "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."
    }
  }
}

Output

{
  "type": "object",
  "description": "Defines the response schema for `/bank_transfer/balance/get`",
  "required": [
    "balance",
    "origination_account_id",
    "request_id"
  ],
  "properties": {
    "balance": {
      "type": "object",
      "description": "Information about the balance of a bank transfer",
      "required": [
        "available",
        "transactable"
      ],
      "properties": {
        "available": {
          "type": "string",
          "description": "The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts."
        },
        "transactable": {
          "type": "string",
          "description": "The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance."
        }
      }
    },
    "origination_account_id": {
      "type": "string",
      "description": "The ID of the origination account that this balance belongs to."
    },
    "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."
    }
  }
}