Financial Accounts API

List financial accounts for a given account_token or business_account_token

Input Parameters

• account_token

  • Type: uuid
  • Description: List financial accounts for a given account_token or business_account_token.

• business_account_token

  • Type: uuid
  • Description: List financial accounts for a given business_account_token.

• type

  • Type: string
  • Enum: ISSUING, OPERATING, RESERVE, SECURITY, EARLY_DIRECT_DEPOSIT_FLOAT

Responses

200 OK

• data
  • Type: array of objects (required)
  • Object:
    • token
      • Type: uuid (required)
      • Description: Globally unique identifier for the account
    • created
      • Type: date-time (required)
    • updated
      • Type: date-time (required)
    • type
      • Type: Instance Financial Account Type
    • routing_number
      • Type: string | null
    • account_number
      • Type: string | null
    • nickname
      • Type: string | null (required)
    • account_token
      • Type: uuid | null (required)
    • status
      • Type: string (required)
      • Enum: OPEN, CLOSED, SUSPENDED, PENDING
    • substatus
      • Type: null
    • user_defined_status
      • Type: string | null (required)
    • is_for_benefit_of
      • Type: boolean (required)
    • credit_configuration
      • Type: object | null (required)
    • has_more
      • Type: boolean (required)

Error Responses

400 Bad Request

• A parameter in the query does not match the valid queries for the endpoint.

401 Unauthorized

• User has not been authenticated.
• Invalid or missing API key.
• API key is not active.
• API key not associated with any user.
• Please provide API key in Authorization header.