Skip to main content
POST
/
v1
/
banking
/
customer
/
{customerId}
/
accounts
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "accountId": "412b5d4b-5de6-44b2-ad7d-ae92479d7322",
      "creationDate": "2025-10-01T00:00:00.000Z",
      "displayName": "Savings Account",
      "nickname": "Beach Holiday",
      "openStatus": "OPEN",
      "isOwned": true,
      "accountOwnership": "ONE_PARTY",
      "maskedNumber": "xxxxxxxx1234",
      "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
      "productName": "Consumer Saver",
      "complexAccountType": "INDIVIDUAL",
      "users": [
        {
          "id": 1,
          "email": "[email protected]",
          "isAccountHolder": true
        },
        {
          "id": 2,
          "email": "[email protected]",
          "isAccountHolder": false
        }
      ],
      "bsb": 111222,
      "accountNumber": 44444111122,
      "bundleName": "Basic Account Bundle",
      "depositRate": 0.045,
      "depositRates": [
        {
          "depositRateType": "VARIABLE",
          "rate": 0.045,
          "calculationFrequency": "P1D",
          "applicationFrequency": "P1M",
          "additionalInfo": "The default interest rate will be applied on your balance"
        }
      ],
      "lendingRates": {
        "lendingRateType": "VARIABLE",
        "rate": 0.2,
        "comparisonRate": 0.2,
        "calculationFrequency": "P1D",
        "applicationFrequency": "P1M",
        "additionalInfo": "Overdrafts accumulate interest at a rate of 20% p/a"
      },
      "features": [
        {
          "featureType": "NPP_PAYID",
          "additionalInfo": "You can register your email or phone number for PayID"
        }
      ],
      "fees": [
        {
          "name": "Account keeping fee",
          "feeType": "PERIODIC",
          "amount": "0.20",
          "additionalValue": "P1M"
        }
      ],
      "addresses": [
        {
          "addressUType": "simple",
          "simple": {
            "mailingName": "P Sherman",
            "addressLine1": "42 Wallaby Way",
            "city": "Sydney",
            "postcode": 2000,
            "state": "NSW",
            "country": "AUS"
          }
        }
      ]
    }
  ],
  "links": {
    "first": "page=1&page-size=25&oldest-date=2023-04-24",
    "last": "page=4&page-size=25&oldest-date=2023-04-24",
    "next": "page=3&page-size=25&oldest-date=2023-04-24",
    "prev": "page=1&page-size=25&oldest-date=2023-04-24"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

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

​
customerId
string
required

Unique ID of a customer. This ID must not change for the lifecycle of the customer

Query Parameters

​
product-category
enum<string>

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.)

Available options:
BUSINESS_LOANS,
CRED_AND_CHRG_CARDS,
LEASES,
MARGIN_LOANS,
OVERDRAFTS,
PERS_LOANS,
REGULATED_TRUST_ACCOUNTS,
RESIDENTIAL_MORTGAGES,
TERM_DEPOSITS,
TRADE_FINANCE,
TRANS_AND_SAVINGS_ACCOUNTS,
TRAVEL_CARDS
​
open-status
enum<string>
default:ALL

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed

Available options:
ALL,
CLOSED,
OPEN
​
is-owned
boolean

Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts

​
page
integer

Page of results to request (standard pagination)

​
page-size
integer

Page size to request. Default is 25 (standard pagination)

Body

application/json

Request payload containing list of specific Accounts to obtain data for

​
data
object
required

Response

List of the details of accounts requested

​
data
object
required
​
links
object
required

URL Query parameters to obtain different pages of the response. Fiskil will combine these with the rest of the request URL to build full link URLs in the final response.

Example:
{
  "first": "page=1&page-size=25&oldest-date=2023-04-24",
  "last": "page=4&page-size=25&oldest-date=2023-04-24",
  "next": "page=3&page-size=25&oldest-date=2023-04-24",
  "prev": "page=1&page-size=25&oldest-date=2023-04-24"
}
​
meta
object
required
Example:
{ "totalRecords": 150, "totalPages": 6 }