Skip to main content
GET
/
banking
/
v1
/
us
/
accounts
/
{id}
Retrieve US Bank Account
curl --request GET \
  --url https://api.example.com/banking/v1/us/accounts/{id}/ \
  --header 'api-key: <api-key>'
{
  "id": "<string>",
  "currency": {
    "id": "<string>",
    "name": "<string>",
    "code": "<string>",
    "symbol": "<string>"
  },
  "account_number": "<string>",
  "bank_info": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user": 123,
  "title": "<string>",
  "classification": "NULL",
  "type": "NULL",
  "reference": "<string>",
  "account_name": "<string>",
  "business_name": "<string>",
  "current_balance": "<string>",
  "product_type": "<string>",
  "credit_limit": "<string>",
  "transaction_count": "<string>",
  "status": "NULL"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
id
string
required

A unique value identifying this account.

Response

200 - application/json
​
id
string
required
​
currency
object
required
​
account_number
string
required
Maximum string length: 255
​
bank_info
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
user
integer | null
​
title
string | null

Optional title of the account.

Maximum string length: 255
​
classification

indicate the classification of the account as personal, business or other wise

  • NULL - Default
  • PERSONAL - Personal
  • BUSINESS - Business
Available options:
NULL,
PERSONAL,
BUSINESS
​
type
  • NULL - Default
  • SAVINGS - Savings
  • CURRENT - Current
  • DEPOSIT - Deposit
Available options:
NULL,
SAVINGS,
CURRENT,
DEPOSIT
​
reference
string | null
Maximum string length: 255
​
account_name
string | null
Maximum string length: 255
​
business_name
string | null
Maximum string length: 255
​
current_balance
string | null
​
product_type
string | null
​
credit_limit
string | null
​
transaction_count
string | null
​
status
  • NULL - Default
  • ACTIVE - Active
  • INACTIVE - Inactive
  • DORMANT - Dormant
  • CLOSED - Closed
  • ESCHEAT - Escheat
  • CHARGEOFF - Chargeoff
Available options:
NULL,
ACTIVE,
INACTIVE,
DORMANT,
CLOSED,
ESCHEAT,
CHARGEOFF