Core Resources
Banking Api
Energy Api
Common api
The Accounts API returns the account information.
Accounts Endpoints
Retrieves an account object.
A list of accounts for the end user
Links to be used for pagination
{
"accounts": [
{
"account_id": "262c6cc1-1b35-4f3f-b3d0-98976a86c6ee",
"account_number": "1234567890",
"account_ownership": "ONE_PARTY",
"addresses": [
{
"address_u_type": "simple",
"paf": {
"building_name_1": "Castle",
"building_name_2": "string",
"dpid": "34567890",
"flat_unit_number": "12B",
"flat_unit_type": "U",
"floor_level_number": "7",
"floor_level_type": "FL",
"locality_name": "SYDNEY",
"lot_number": "42",
"postal_delivery_number": 2,
"postal_delivery_number_prefix": "N",
"postal_delivery_number_suffix": "A",
"postal_delivery_type": "PO BOX",
"postcode": "2000",
"state": "NSW",
"street_name": "WALLABY",
"street_suffix": "S",
"street_type": "WAY",
"thoroughfare_number1": 40,
"thoroughfare_number1_suffix": "A",
"thoroughfare_number2": 44,
"thoroughfare_number2_suffix": "A"
},
"simple": {
"address_line1": "42 Wallaby Way",
"address_line2": "string",
"address_line3": "string",
"city": "SYDNEY",
"country": "AUS",
"mailing_name": "Shiny Dental",
"postcode": "2000",
"state": "NSW"
}
}
],
"arrangement_id": "9fafd2ac-5f75-47b6-8287-8046df65b8ff",
"bsb": "633123",
"bundle_name": "Everyday Value",
"creation_date": "2024-09-09",
"credit_card": {
"min_payment_amount": "20.00",
"payment_currency": "AUD",
"payment_due_amount": "92.14",
"payment_due_date": "2024-09-09"
},
"deposit_rate": "0.0419",
"deposit_rates": [
{
"additional_info": "Making regular deposits earns additional interest",
"additional_info_uri": "https://example.bank/info.html",
"additional_value": "Deposit any amount into your account once a month to be eligible",
"application_frequency": "P1M",
"calculation_frequency": "P1D",
"deposit_rate_type": "BONUS",
"rate": " 0.04",
"tiers": [
{
"additional_info": "A fun fact about the tier",
"additional_info_uri": "https://example.bank/tiers.html",
"applicability_conditions": {
"additional_info": "You must have full-time employment",
"additional_info_uri": "https://example.bank/rate-conditions.html"
},
"maximum_value": 100000,
"minimum_value": 0,
"name": "Balance limit",
"rate_application_method": "PER_TIER",
"unit_of_measure": "DOLLAR"
}
]
}
],
"display_name": "Transaction Account",
"features": [
{
"additional_info": "Receive $500 cashback when your loan account is created",
"additional_info_uri": "https://bank.com/feature-info",
"additional_value": "500",
"feature_type": "CASHBACK_OFFER",
"is_activated": true
}
],
"fees": [
{
"accrual_frequency": "P1M",
"accrued_rate": "0.05",
"additional_info": "A fun fact about the fee",
"additional_info_uri": "https://example.bank/fees.html",
"additional_value": "string",
"amount": "10.00",
"balance_rate": "0.002",
"currency": "AUD",
"discounts": [
{
"accrued_rate": "0.02",
"additional_info": "A fun fact about the discount",
"additional_info_uri": "https://example.bank/discount.html",
"additional_value": "1000.00",
"amount": "20.00",
"balance_rate": "0.005",
"description": "A discount on your monthly fee",
"discount_type": "BALANCE",
"eligibility": [
{
"additional_info": "A fun fact about this eligibility requirement",
"additional_info_uri": "https://example.bank/discount-eligibility.html",
"additional_value": "string",
"discount_eligibility_type": "RESIDENCY_STATUS"
}
],
"fee_rate": "0.1",
"transaction_rate": "0.01"
}
],
"fee_type": "WITHDRAWAL",
"name": "Standard withdrawal fee",
"transaction_rate": "0.05"
}
],
"fiskil_id": "bank_account_12345",
"institution_id": "2",
"is_owned": true,
"lending_rate": "0.15",
"lending_rates": [
{
"additional_info": "A fun fact about the rate",
"additional_info_uri": "https://example.bank/lending.html",
"additional_value": "string",
"application_frequency": "P1M",
"calculation_frequency": "P1D",
"comparison_rate": "0.0639",
"interest_payment_due": "IN_ADVANCE,IN_ARREARS",
"lending_rate_type": "VARIABLE",
"loan_purpose": "OWNER_OCCUPIED",
"rate": "0.0639",
"repayment_type": "PRINCIPAL_AND_INTEREST",
"tiers": [
{
"additional_info": "A fun fact about the tier",
"additional_info_uri": "https://example.bank/tiers.html",
"applicability_conditions": {
"additional_info": "You must have full-time employment",
"additional_info_uri": "https://example.bank/rate-conditions.html"
},
"maximum_value": 100000,
"minimum_value": 0,
"name": "Balance limit",
"rate_application_method": "PER_TIER",
"unit_of_measure": "DOLLAR"
}
]
}
],
"loan": {
"loan_end_date": "2025-09-09",
"max_redraw": "10500.00",
"max_redraw_currency": "AUD",
"min_instalment_amount": "300.00",
"min_instalment_currency": "AUD",
"min_redraw": "1000.00",
"min_redraw_currency": "AUD",
"next_instalment_date": "2024-10-09",
"offset_account_enabled": true,
"offset_account_ids": [],
"original_loan_amount": "200000.00",
"original_loan_currency": "AUD",
"original_start_date": "2024-09-09",
"repayment_frequency": "P1M",
"repayment_type": "string"
},
"masked_number": "xxx-xxx xxxxx7890",
"nickname": "My Account",
"open_status": "OPEN",
"product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
"product_name": "Bank Everyday Account",
"specific_account_u_type": "creditCard",
"term_deposit": [
{
"lodgement_date": "2024-09-09",
"maturity_amount": "500.00",
"maturity_currency": "AUD",
"maturity_date": "2025-09-09",
"maturity_instructions": "ROLLED_OVER"
}
]
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/banking/accounts
Returns a list of all linked accounts.
A unique identifier for the End User object.
When the page[before] is specified, backwards pagination is achieved
When the page[after] is specified, forwards pagination is achieved
When the page[size] is specified, no more than page[size] resources will be included in the response's data field. This parameter is set to a sensible default, which varies depending on the endpoint.
curl --request GET \
--url https://api.fiskil.com/v1/v1/banking/accounts?end_user_id={end_user_id}&page[before]={page[before]}&page[after]={page[after]}&page[size]={page[size]} \
--header 'Authorization: Bearer {access_token}' \
--header 'accept: application/json; charset=UTF-8' \
--header 'content-type: application/json; charset=UTF-8'
{
"accounts": [
{
"account_id": "262c6cc1-1b35-4f3f-b3d0-98976a86c6ee",
"account_number": "1234567890",
"account_ownership": "ONE_PARTY",
"addresses": [
{
"address_u_type": "simple",
"paf": {
"building_name_1": "Castle",
"building_name_2": "string",
"dpid": "34567890",
"flat_unit_number": "12B",
"flat_unit_type": "U",
"floor_level_number": "7",
"floor_level_type": "FL",
"locality_name": "SYDNEY",
"lot_number": "42",
"postal_delivery_number": 2,
"postal_delivery_number_prefix": "N",
"postal_delivery_number_suffix": "A",
"postal_delivery_type": "PO BOX",
"postcode": "2000",
"state": "NSW",
"street_name": "WALLABY",
"street_suffix": "S",
"street_type": "WAY",
"thoroughfare_number1": 40,
"thoroughfare_number1_suffix": "A",
"thoroughfare_number2": 44,
"thoroughfare_number2_suffix": "A"
},
"simple": {
"address_line1": "42 Wallaby Way",
"address_line2": "string",
"address_line3": "string",
"city": "SYDNEY",
"country": "AUS",
"mailing_name": "Shiny Dental",
"postcode": "2000",
"state": "NSW"
}
}
],
"arrangement_id": "9fafd2ac-5f75-47b6-8287-8046df65b8ff",
"bsb": "633123",
"bundle_name": "Everyday Value",
"creation_date": "2024-09-09",
"credit_card": {
"min_payment_amount": "20.00",
"payment_currency": "AUD",
"payment_due_amount": "92.14",
"payment_due_date": "2024-09-09"
},
"deposit_rate": "0.0419",
"deposit_rates": [
{
"additional_info": "Making regular deposits earns additional interest",
"additional_info_uri": "https://example.bank/info.html",
"additional_value": "Deposit any amount into your account once a month to be eligible",
"application_frequency": "P1M",
"calculation_frequency": "P1D",
"deposit_rate_type": "BONUS",
"rate": " 0.04",
"tiers": [
{
"additional_info": "A fun fact about the tier",
"additional_info_uri": "https://example.bank/tiers.html",
"applicability_conditions": {
"additional_info": "You must have full-time employment",
"additional_info_uri": "https://example.bank/rate-conditions.html"
},
"maximum_value": 100000,
"minimum_value": 0,
"name": "Balance limit",
"rate_application_method": "PER_TIER",
"unit_of_measure": "DOLLAR"
}
]
}
],
"display_name": "Transaction Account",
"features": [
{
"additional_info": "Receive $500 cashback when your loan account is created",
"additional_info_uri": "https://bank.com/feature-info",
"additional_value": "500",
"feature_type": "CASHBACK_OFFER",
"is_activated": true
}
],
"fees": [
{
"accrual_frequency": "P1M",
"accrued_rate": "0.05",
"additional_info": "A fun fact about the fee",
"additional_info_uri": "https://example.bank/fees.html",
"additional_value": "string",
"amount": "10.00",
"balance_rate": "0.002",
"currency": "AUD",
"discounts": [
{
"accrued_rate": "0.02",
"additional_info": "A fun fact about the discount",
"additional_info_uri": "https://example.bank/discount.html",
"additional_value": "1000.00",
"amount": "20.00",
"balance_rate": "0.005",
"description": "A discount on your monthly fee",
"discount_type": "BALANCE",
"eligibility": [
{
"additional_info": "A fun fact about this eligibility requirement",
"additional_info_uri": "https://example.bank/discount-eligibility.html",
"additional_value": "string",
"discount_eligibility_type": "RESIDENCY_STATUS"
}
],
"fee_rate": "0.1",
"transaction_rate": "0.01"
}
],
"fee_type": "WITHDRAWAL",
"name": "Standard withdrawal fee",
"transaction_rate": "0.05"
}
],
"fiskil_id": "bank_account_12345",
"institution_id": "2",
"is_owned": true,
"lending_rate": "0.15",
"lending_rates": [
{
"additional_info": "A fun fact about the rate",
"additional_info_uri": "https://example.bank/lending.html",
"additional_value": "string",
"application_frequency": "P1M",
"calculation_frequency": "P1D",
"comparison_rate": "0.0639",
"interest_payment_due": "IN_ADVANCE,IN_ARREARS",
"lending_rate_type": "VARIABLE",
"loan_purpose": "OWNER_OCCUPIED",
"rate": "0.0639",
"repayment_type": "PRINCIPAL_AND_INTEREST",
"tiers": [
{
"additional_info": "A fun fact about the tier",
"additional_info_uri": "https://example.bank/tiers.html",
"applicability_conditions": {
"additional_info": "You must have full-time employment",
"additional_info_uri": "https://example.bank/rate-conditions.html"
},
"maximum_value": 100000,
"minimum_value": 0,
"name": "Balance limit",
"rate_application_method": "PER_TIER",
"unit_of_measure": "DOLLAR"
}
]
}
],
"loan": {
"loan_end_date": "2025-09-09",
"max_redraw": "10500.00",
"max_redraw_currency": "AUD",
"min_instalment_amount": "300.00",
"min_instalment_currency": "AUD",
"min_redraw": "1000.00",
"min_redraw_currency": "AUD",
"next_instalment_date": "2024-10-09",
"offset_account_enabled": true,
"offset_account_ids": [],
"original_loan_amount": "200000.00",
"original_loan_currency": "AUD",
"original_start_date": "2024-09-09",
"repayment_frequency": "P1M",
"repayment_type": "string"
},
"masked_number": "xxx-xxx xxxxx7890",
"nickname": "My Account",
"open_status": "OPEN",
"product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
"product_name": "Bank Everyday Account",
"specific_account_u_type": "creditCard",
"term_deposit": [
{
"lodgement_date": "2024-09-09",
"maturity_amount": "500.00",
"maturity_currency": "AUD",
"maturity_date": "2025-09-09",
"maturity_instructions": "ROLLED_OVER"
}
]
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}Was this page helpful?