v1
latestOpenAPI 3.1.02026-07-2483219318.4 KBAccounts
Get Accounts
Get a list of the accounts that the user has shared with your application.
ℹ️
The format for the returned account depends on the permissions you have!
ℹ️
The one-off API account schema is similar, but not identical to the enduring API account schema. In particular, note the differences in account type.
get/accounts/{code}
Path parameters
codestring required
The one-off authorization code, provided to your application by redirection to your redirect_uri upon the user's successful completion of the authorization flow.
Headers
Content-Typestring
Response
Successful response.
Example response
{
"items": [
{
"_id": "oneoff_acc_1111111111111111111111111",
"_connection": "conn_cjgaawozb000001nyd111xixr",
"name": "Demo Account",
"balance": {
"current": 99.9,
"available": 99.9,
"limit": 1000
},
"type": "DEPOSITORY",
"attributes": [
"TRANSACTIONS"
],
"formatted_account": "12-1234-1234567-12",
"meta": {
"holder": "MR DEMO HOLDER & MS DEMO HOLDER",
"nickname": "Sam's Savings",
"product_name": "Super Saver",
"loan_details": {
"purpose": "HOME",
"type": "TABLE",
"interest": {
"rate": 4.5,
"type": "FIXED",
"expires_at": "2021-01-01T12:00:00.000Z"
},
"interest_only_expires_at": "2021-01-01T12:00:00.000Z",
"term": {
"years": 30,
"months": 5
},
"matures_at": "2021-01-01T12:00:00.000Z",
"initial_principal": 100000,
"repayment": {
"frequency": "MONTHLY",
"next_date": "2021-01-01T12:00:00.000Z",
"next_amount": 1000
}
}
}
}
]
}