This section provides documentation for essential API calls that retrieve lists of accounts and details for individual accounts. By following these guidelines, you can effectively retrieve and utilize financial data to power your applications and services.
Get List of Accounts
To retrieve a comprehensive list of accounts associated with a customer, you can use the following API call:
API Endpoint: /api/v1/accounts
Method: GET
Request Headers:
Authorization: Bearer {accessToken}Content-Type: application/json(if required)
Response:
{
"accounts": [
{
"accountId": "acc123",
"accountType": "Savings",
"balance": {
"currency": "USD",
"amount": 5000.00
},
"owner": {
"customerId": "cust456",
"name": "John Doe"
}
},
{
"accountId": "acc456",
"accountType": "Checking",
"balance": {
"currency": "USD",
"amount": 2500.00
},
"owner": {
"customerId": "cust456",
"name": "John Doe"
}
}
// Additional accounts...
]
}
Get a Single Account Details
To retrieve detailed information for a specific account, use the following API call:
API Endpoint: /api/v1/accounts/{accountId}
Method: GET
Path Parameter:
accountId: The unique identifier of the account.
Request Headers:
Authorization: Bearer {accessToken}Content-Type: application/json(if required)
Response:
{
"accountId": "acc123",
"accountType": "Savings",
"balance": {
"currency": "USD",
"amount": 5000.00
},
"owner": {
"customerId": "cust456",
"name": "John Doe"
},
"transactions": [
{
"transactionId": "txn789",
"date": "2024-06-20T12:00:00Z",
"amount": -100.00,
"description": "Withdrawal - ATM"
},
{
"transactionId": "txn790",
"date": "2024-06-19T15:30:00Z",
"amount": 2000.00,
"description": "Deposit - Salary"
}
// Additional transactions...
]
}
0 Comments