Skip to main content
GET
/
api
/
fdx
/
5
/
accounts
/
{account_id}
Get Account Details
curl --request GET \
  --url https://ob.flinksapp.com/api/fdx/5/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'
{
  "depositAccount": {
    "accountId": "string",
    "accountCategory": "DEPOSIT_ACCOUNT",
    "accountType": "CHECKING",
    "accountNumber": "string",
    "accountNumberDisplay": "string",
    "productName": "string",
    "nickname": "string",
    "status": "OPEN",
    "description": "string",
    "currency": {
      "currencyRate": 1.0,
      "currencyCode": "USD",
      "originalCurrencyCode": "USD"
    },
    "routingTransitNumber": "string",
    "balanceType": "ASSET",
    "interestRate": 1.5,
    "interestRateType": "FIXED",
    "transferIn": true,
    "transferOut": true,
    "lastActivityDate": "2024-01-15",
    "transactionsIncluded": true,
    "balanceAsOf": "2024-01-15T10:30:00Z",
    "currentBalance": 5000.5,
    "availableBalance": 4500.0,
    "annualPercentageYield": 1.25,
    "interestYtd": 25.0,
    "transactions": [
      {
        "accountId": "string",
        "transactionId": "string",
        "postedTimestamp": "2024-01-14T09:00:00Z",
        "transactionTimestamp": "2024-01-14T09:00:00Z",
        "description": "Direct Deposit",
        "debitCreditMemo": "CREDIT",
        "amount": 1500.0,
        "status": "POSTED",
        "transactionType": "DEPOSIT",
        "payee": "Employer Inc."
      }
    ]
  }
}
Use the /api/fdx/v1/accounts/{accountId} endpoint to get information about a particular customer account in FDX format. To successfully call this endpoint, you must first call the /Token endpoint to obtain a valid access_token using:
  • grant_type: authorization_code or refresh_token
  • client_id: {recipient client_id}
  • client_secret: {recipient client_id}
  • redirect_uri: {recipient redirect_uri}
  • code: {with grant type authorization_code}
  • refresh_token: {with grant type refresh_token}

​
How to handle an error response

If you receive an error response, refer to the List of Data Access Errors for more information about the error and how to resolve it.

Response is different for each Data Provider

This endpoint returns different fields for each Data Provider. For more information about the fields that each Data Provider supports, review the Data Provider’s details.
{
  "depositAccount": {
    "accountId": "string",
    "accountCategory": "DEPOSIT_ACCOUNT",
    "accountType": "CHECKING",
    "accountNumber": "string",
    "accountNumberDisplay": "string",
    "productName": "string",
    "nickname": "string",
    "status": "OPEN",
    "description": "string",
    "currency": {
      "currencyRate": 1.0,
      "currencyCode": "USD",
      "originalCurrencyCode": "USD"
    },
    "routingTransitNumber": "string",
    "balanceType": "ASSET",
    "interestRate": 1.5,
    "interestRateType": "FIXED",
    "transferIn": true,
    "transferOut": true,
    "lastActivityDate": "2024-01-15",
    "transactionsIncluded": true,
    "balanceAsOf": "2024-01-15T10:30:00Z",
    "currentBalance": 5000.5,
    "availableBalance": 4500.0,
    "annualPercentageYield": 1.25,
    "interestYtd": 25.0,
    "transactions": [
      {
        "accountId": "string",
        "transactionId": "string",
        "postedTimestamp": "2024-01-14T09:00:00Z",
        "transactionTimestamp": "2024-01-14T09:00:00Z",
        "description": "Direct Deposit",
        "debitCreditMemo": "CREDIT",
        "amount": 1500.0,
        "status": "POSTED",
        "transactionType": "DEPOSIT",
        "payee": "Employer Inc."
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token obtained from the /Token endpoint.

Path Parameters

​
account_id
string
required

The ID of the customer account that you want to retrieve.

Response

Returned when the account details are successfully retrieved.

​
depositAccount
object

Deposit account details, returned for checking/savings accounts.

​
loanAccount
object

Loan account details, returned for loan accounts.

​
locAccount
object

Line of credit account details.

​
investmentAccount
object

Investment account details.

​
annuityAccount
object

Annuity account details.