import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const accounts = await client.data.accounts.list({ sessionId: 'sessionId' });
console.log(accounts.accounts);{
"accounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"financialAddress": [
{
"type": "iban",
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
}
],
"bankId": "<string>",
"bankName": "<string>",
"currency": "<string>",
"accountName": "<string>"
}
]
}Retrieves the list of accounts for a given data session.
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const accounts = await client.data.accounts.list({ sessionId: 'sessionId' });
console.log(accounts.accounts);{
"accounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"financialAddress": [
{
"type": "iban",
"iban": {
"iban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"sortCode": {
"sortCode": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bankCode": {
"code": "<string>",
"accountNumber": "<string>",
"accountHolderName": "<string>"
},
"bban": {
"bban": "<string>",
"accountHolderName": "<string>",
"bic": "<string>"
},
"wallet": {
"address": "<string>"
}
}
],
"bankId": "<string>",
"bankName": "<string>",
"currency": "<string>",
"accountName": "<string>"
}
]
}API key for authentication
The ID of the data session to retrieve accounts for.
Returns the list of bank accounts for the given data session
Array of bank accounts for the given data session
Show child attributes
The ID of the account.
Financial address details of the account
Show child attributes
iban, sort_code, bank_code, bban, wallet The ID of the bank.
The name of the bank.
The currency of the account.
3The name of the account.
Was this page helpful?