/{accountId} - GET

get https://cubi-sandbox-api.customersbank.com/accounts/v1/{accountId}

Get an account

Responses

Response body

object

uuid

The ID (uuid) of the account. Should be used, instead of account number, when accessing resources in GET urls

ibsAccountNumber

string

required

The account number. This is considered PII and should be protected

name

string

required

The name of the account

searchable

boolean

Indicates if the account is searchable by other partners for address book linking

controlType

string

Single Dual

modifiedAt

date-time

Last modified timestamp

createdAt

date-time

Created timestamp

partnerId

uuid

deprecated

The ID of the partner who owns the account

version

string | null

deprecated

Obsolete

isFrozen

boolean

Indicates if the account is frozen

isDeleted

boolean

deprecated

Obsolete

availableBalance

double

Amount available, which is typically total balance minus holds

balance

double

Total balance, before holds

state

string

Closed Active Restricted

additionalBalances

object

relatedAvailableBalance

double

The total available balance of related accounts

totalAccessibleBalance

double

The total accessible balance, which is calculated as available balance + related available balance

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cubi-sandbox-api.customersbank.com/accounts/v1/accountId \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "id": "string",
3
  "ibsAccountNumber": "string",
4
  "name": "string",
5
  "searchable": true,
6
  "controlType": "Single",
7
  "modifiedAt": "string",
8
  "createdAt": "string",
9
  "partnerId": "string",
10
  "version": "string",
11
  "isFrozen": true,
12
  "isDeleted": true,
13
  "availableBalance": 0,
14
  "balance": 0,
15
  "state": "Closed",
16
  "additionalBalances": {
17
    "relatedAvailableBalance": 0,
18
    "totalAccessibleBalance": 0
19
  }
20
}

200OK

400BadRequest

401Unauthorized

403Forbidden

404NotFound

422UnprocessableEntity

500InternalServerError