Get account by ID
Endpoint
GET/v2/account/{id}
Link
Request
Path Parameters
id
string
Account ID to retrieve.
Yes
"UhcPVBEpjmtR"
Headers
Authorization
Bearer <JWT>
Yes
Accept
application/json
Yes
Response (200 OK)
Returns an Account entity v2 object in JSON format.
Response Fields
id
string
Unique account identifier.
"UhcPVBEpjmtR"
customer
object
Customer details:
- id: Customer ID
- name: Full name
- email: Contact email
- phone: Phone number
- status: Customer status (NEW, ACCEPT, etc.)
{ "id": "DqCsgSE-4e95-ViYbNI", "status": "ACCEPT" }
isDefault
boolean
Whether this is the user’s default account (true/false).
true
name
string
Account name.
"Business Account"
status
string
Current account status:
- NEW
- ACCEPTED
- REJECTED
- BANNED
- PROCESSING
"ACCEPTED"
balance
object
Balance details:
- balance: Available funds
- hold: Restricted funds (see Money Object below)
–
currencyIso
string
Account currency code (ISO 4217).
"USD"
requisites
array
Bank/payment details:
- title: Section title (e.g., "Bank Account")
- items[]: Key-value pairs (e.g., IBAN, SWIFT)
See Requisites Example
createdAt
string
Creation timestamp (ISO 8601).
"2024-01-15T10:30:00Z"
updatedAt
string
Last update timestamp (ISO 8601).
"2024-01-20T14:45:00Z"
Money Object
Nested under balance and hold:
currencyCode
string
3-letter ISO currency code.
"USD"
units
string
Whole units (e.g., dollars). Negative values indicate debts.
"100" (= $100)
nanos
integer
Fractional units (1 nano = 10^-9 units). Use for cents/micro-currencies.
500000000 (= $0.50)
Example:
json
Error Cases
Invalid Account ID:
json
Missing Authorization:
json
Notes
Requisites: May be empty if no bank details are linked.
Hold Balance: Shows funds temporarily unavailable (e.g., during transactions).
Timestamps: Use ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
Examples
Real request
Real response
Last updated

