Get Bank Account

Overview

The Get Bank Account API allows you to retrieve detailed information about a specific bank account associated with a business. This includes account details, status, and metadata. The account number is masked for security.

Resource Access

• HTTP Method: GET
• Endpoint: /v1/businesses/{business_id}/bank_accounts/{bank_account_id}
• Authentication: Bearer token required

Path Parameters

Parameter	Type	Required	Description
business_id	string (UUID)	Yes	Unique identifier for the business
bank_account_id	string (UUID)	Yes	Unique identifier for the bank account

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Content type for the response
Authorization	Bearer {access_token}	Yes	Bearer token for authentication

Response

Success Response (200 OK)

{
  "id": "urn:uuid:bank-account-123",
  "business_id": "urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc",
  "account_number": "****4567",
  "account_type": "checking",
  "bank_name": "Chase",
  "routing_number": "123456789",
  "status": "active",
  "user_data": {
    "nickname": "Primary Checking",
    "purpose": "Operations"
  },
  "created_at": "2022-01-01T00:00:00.000Z",
  "updated_at": "2022-01-01T00:00:00.000Z"
}

Response Fields

Field	Type	Description
id	string (UUID)	Unique identifier for the bank account
business_id	string (UUID)	Business ID this account belongs to
account_number	string	Masked account number for security
account_type	string	Type of bank account
bank_name	string	Name of the bank
routing_number	string	ABA routing number
status	string	Account status
user_data	object	Additional user-defined data
created_at	string (date-time)	Creation timestamp
updated_at	string (date-time)	Last update timestamp

Account Status Values

• pending_verification: Account created but not yet verified
• verified: Account verified and ready for use
• active: Account is active and can be used for transactions
• suspended: Account temporarily suspended
• closed: Account has been closed

Account Type Values

• checking: Personal checking account
• savings: Personal savings account
• business_checking: Business checking account
• business_savings: Business savings account

Error Responses

• 401 Unauthorized: Invalid or missing authentication token
• 403 Forbidden: User does not have access to this bank account
• 404 Not Found: Business or bank account not found

Code Examples

cURL

curl -X GET \
  'https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/bank_accounts/urn:uuid:bank-account-123' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/bank_accounts/urn:uuid:bank-account-123"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/bank_accounts/urn:uuid:bank-account-123';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};

axios.get(url, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error.response.data);
  });

Usage Notes

• Account numbers are always masked in responses for security
• The bank account must belong to the specified business
• Users can only access accounts they have permission to view
• Use this endpoint when you need detailed information about a specific account
• The user_data field contains any additional metadata associated with the account
• Account status determines whether the account can be used for transactions

Interactive API Explorer