Skip to main content
GET
/
fdx
/
v6
/
customer
/
{customerId}
/
accounts
/
{accountId}
Get detailed information for a specific account
curl --request GET \
  --url https://your-company.com/fdx/v6/customer/{customerId}/accounts/{accountId} \
  --header 'Authorization: Bearer <token>'
{
  "accountCategory": "DEPOSIT_ACCOUNT",
  "accountId": "someLongTermUniqueIDString",
  "productName": "Premier Account",
  "status": "OPEN",
  "currency": {
    "currencyCode": "CAD"
  },
  "accountType": "SAVINGS",
  "currentBalance": 1399.02,
  "availableBalance": 1399.02,
  "accountNumberDisplay": "4321",
  "nickname": "<string>"
}

Authorizations

​
Authorization
string
header
required

The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header. You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you must:

  • Verify the signature
  • Ensure the token has not expired by checking the exp claim
  • The sub and iss claims are your data provider subdomain
  • The aud claim is the URI of the resource being requested (excluding any query parameters)
  • The jti value is unique For further detail on security and authentication refer to our Authentication documentation

Path Parameters

​
accountId
string
required

Account identifier, found in the GET /accounts endpoint response.

Note: If the status of the accountId provided is RESTRICTED, you can send a 200 response with an empty body to indicate that no payment networks are available at this time.

Value for a unique identifier

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

​
customerId
string
required

Unique identifier for the user the account belongs to. This will be the user that authorized the data sharing.

Value for a unique identifier

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

Response

The full details of an investment, loan, deposit, or line of credit account

Full details of a deposit account. You should use a decimal amount with two places (to represent fractional values of the base currency) for all monetary amounts. For example, "currentBalance": 192.00.

The accountType field for deposit accounts may be set to any of the account types listed below.

​
accountCategory
enum<string>
required

The category of account. For example, annuity, commercial, deposit, insurance, investment, loan, or line of credit.

Available options:
DEPOSIT_ACCOUNT
Example:

"DEPOSIT_ACCOUNT"

​
accountId
string
required

Long-term persistent identity of the account, though not an account number. This identity must be unique within your organization.

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

​
productName
string
required

Marketed product name for this account. Used in UIs to assist in account selection

Example:

"Premier Account"

​
status
enum<string>
required

Account status

Available options:
CLOSED,
DELINQUENT,
NEGATIVECURRENTBALANCE,
OPEN,
PAID,
PENDINGCLOSE,
PENDINGOPEN,
RESTRICTED
Example:

"OPEN"

​
currency
Currency entity · object
required

Currency of the account balances

Example:
{ "currencyCode": "CAD" }
​
accountType
enum<string>
required

The account type.

Available options:
CHECKING,
SAVINGS,
CD,
ESCROW,
MONEYMARKET,
OTHERDEPOSIT
Example:

"SAVINGS"

​
currentBalance
number
required

The total amount of money in the account (sum of all posted/cleared transactions, not including pending transactions).

Example:

1399.02

​
availableBalance
number
required

The money in the account available to spend (sum of all transactions, plus or minus pending transactions).

Example:

1399.02

​
accountNumberDisplay
string

Account display number for the end user's handle at the owning financial institution. The last 4 digits of this masked number should correspond to the last 4 digits of the account number.

Example:

"4321"

​
nickname
string

Account nickname