Bank of America

opencollection: 1.0.0
info:
  name: Bank of America CashPro API
  version: 1.0.0
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://api.bankofamerica.com/oauth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: List Accounts
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/accounts
      params:
      - name: accountType
        value: ''
        type: query
        description: Filter by account type (checking, savings, etc.)
      - name: currency
        value: ''
        type: query
        description: Filter by currency code (ISO 4217)
    docs: Retrieve a list of accounts associated with the authenticated CashPro client.
  - info:
      name: Get Account Details
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/accounts/:accountId
      params:
      - name: accountId
        value: ''
        type: path
        description: Unique account identifier
    docs: Retrieve detailed information for a specific account including current balance and account metadata.
- info:
    name: Balances
    type: folder
  items:
  - info:
      name: Get Account Balances
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/accounts/:accountId/balances
      params:
      - name: accountId
        value: ''
        type: path
        description: Unique account identifier
      - name: asOf
        value: ''
        type: query
        description: Balance as of date (ISO 8601)
    docs: Retrieve current and available balances for a specific account including intraday balance information.
- info:
    name: Transactions
    type: folder
  items:
  - info:
      name: List Transactions
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/accounts/:accountId/transactions
      params:
      - name: accountId
        value: ''
        type: path
        description: Unique account identifier
      - name: fromDate
        value: ''
        type: query
        description: Start date for transaction history (ISO 8601)
      - name: toDate
        value: ''
        type: query
        description: End date for transaction history (ISO 8601)
      - name: limit
        value: ''
        type: query
        description: Maximum number of transactions to return
      - name: offset
        value: ''
        type: query
        description: Pagination offset
    docs: Retrieve a paginated list of transactions for a specific account within a date range.
- info:
    name: Payments
    type: folder
  items:
  - info:
      name: List Payments
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/payments
      params:
      - name: fromDate
        value: ''
        type: query
        description: Start date filter (ISO 8601)
      - name: toDate
        value: ''
        type: query
        description: End date filter (ISO 8601)
      - name: status
        value: ''
        type: query
        description: Filter by payment status
      - name: paymentType
        value: ''
        type: query
        description: Filter by payment type
    docs: Retrieve a list of payment transactions filtered by date range and status.
  - info:
      name: Initiate Payment
      type: http
    http:
      method: POST
      url: https://api.bankofamerica.com/cashpro/v1/payments
      body:
        type: json
        data: '{}'
    docs: Initiate a payment transaction. Supports over 350 payment types including ACH, wire transfers, SWIFT, checks, and
      real-time payments. The payment type is determined by the paymentType field in the request body.
  - info:
      name: Get Payment Status
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/payments/:paymentId
      params:
      - name: paymentId
        value: ''
        type: path
        description: Unique payment transaction identifier
    docs: Retrieve the current status and details of a specific payment transaction.
  - info:
      name: Cancel Payment
      type: http
    http:
      method: DELETE
      url: https://api.bankofamerica.com/cashpro/v1/payments/:paymentId
      params:
      - name: paymentId
        value: ''
        type: path
        description: Unique payment identifier
    docs: Cancel a pending payment that has not yet been processed.
- info:
    name: Statements
    type: folder
  items:
  - info:
      name: List Statements
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/statements
      params:
      - name: accountId
        value: ''
        type: query
        description: Filter statements by account ID
      - name: year
        value: ''
        type: query
        description: Filter by statement year
    docs: Retrieve a list of available account statements.
  - info:
      name: Get Statement
      type: http
    http:
      method: GET
      url: https://api.bankofamerica.com/cashpro/v1/statements/:statementId
      params:
      - name: statementId
        value: ''
        type: path
        description: Unique statement identifier
    docs: Retrieve a specific account statement by ID.
bundled: true