Fiskil Docs

Handle Accounts

returns list of banking account Accounts available under the authorised consent

GET
/v1/banking/accounts

returns list of banking account Accounts available under the authorised consent

Query Parameters

end_user_idstringrequired

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

page[size]integer

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. It is capped at 1000.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/banking/accounts?end_user_id=eu_12345&page%5Bbefore%5D=bank_account_asdf1234&page%5Bafter%5D=bank_account_asdf1234&page%5Bsize%5D=100"
{  "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": "string",      "bundle_name": "string",      "creation_date": "string",      "credit_card": {        "min_payment_amount": "20.00",        "payment_currency": "AUD",        "payment_due_amount": "92.14",        "payment_due_date": "2024-09-09"      },      "deposit_rate": "string",      "deposit_rates": [        {          "additional_info": "string",          "additional_info_uri": "string",          "additional_value": "string",          "applicability_conditions": [            {              "additional_info": "string",              "additional_info_uri": "string",              "additional_value": "string",              "rate_applicability_type": "string"            }          ],          "application_frequency": "string",          "application_type": "string",          "calculation_frequency": "string",          "deposit_rate_type": "string",          "rate": "string",          "tiers": [            {              "additional_info": "string",              "additional_info_uri": "string",              "applicability_conditions": [                {                  "additional_info": "string",                  "additional_info_uri": "string",                  "additional_value": "string",                  "rate_applicability_type": "string"                }              ],              "maximum_value": "string",              "minimum_value": "string",              "name": "string",              "rate_application_method": "string",              "unit_of_measure": "string"            }          ]        }      ],      "display_name": "string",      "features": [        {          "additional_info": "string",          "additional_info_uri": "string",          "additional_value": "string",          "feature_type": "string",          "is_activated": "ACTIVATED"        }      ],      "fees": [        {          "additional_info": "string",          "additional_info_uri": "string",          "additional_value": "string",          "currency": "string",          "discounts": [            {              "additional_info": "string",              "additional_info_uri": "string",              "additional_value": "string",              "description": "string",              "discount_method_u_type": "string",              "discount_type": "string",              "eligibility": [                {                  "additional_info": "string",                  "additional_info_uri": "string",                  "additional_value": "string",                  "discount_eligibility_type": "string"                }              ],              "fixed_amount": {                "amount": "string"              },              "rate_based": {                "amount_range": {                  "discount_maximum": "string",                  "discount_minimum": "string"                },                "rate": "string",                "rate_type": "string"              }            }          ],          "fee_cap": "string",          "fee_cap_period": "string",          "fee_method_u_type": "string",          "fee_type": "string",          "fixed_amount": {            "amount": "string"          },          "name": "string",          "rate_based": {            "accrual_frequency": "string",            "amount_range": {              "fee_maximum": "string",              "fee_minimum": "string"            },            "rate": "string",            "rate_type": "string"          },          "variable": {            "fee_maximum": "string",            "fee_minimum": "string"          }        }      ],      "fiskil_id": "bank_account_12345",      "institution_id": "2",      "is_owned": true,      "lending_rate": "string",      "lending_rates": [        {          "additional_info": "string",          "additional_info_uri": "string",          "additional_value": "string",          "applicability_conditions": [            {              "additional_info": "string",              "additional_info_uri": "string",              "additional_value": "string",              "rate_applicability_type": "string"            }          ],          "application_frequency": "string",          "application_type": "string",          "calculation_frequency": "string",          "comparison_rate": "string",          "interest_payment_due": "string",          "lending_rate_type": "string",          "loan_purpose": "string",          "rate": "string",          "repayment_type": "string",          "tiers": [            {              "additional_info": "string",              "additional_info_uri": "string",              "applicability_conditions": [                {                  "additional_info": "string",                  "additional_info_uri": "string",                  "additional_value": "string",                  "rate_applicability_type": "string"                }              ],              "maximum_value": "string",              "minimum_value": "string",              "name": "string",              "rate_application_method": "string",              "unit_of_measure": "string"            }          ]        }      ],      "loan": {        "loan_end_date": "string",        "max_redraw": "string",        "max_redraw_currency": "string",        "min_instalment_amount": "string",        "min_instalment_currency": "string",        "min_redraw": "string",        "min_redraw_currency": "string",        "next_instalment_date": "string",        "offset_account_enabled": true,        "offset_account_ids": [          "string"        ],        "original_loan_amount": "string",        "original_loan_currency": "string",        "original_start_date": "string",        "repayment_frequency": "string",        "repayment_type": "INTEREST_ONLY"      },      "masked_number": "string",      "nickname": "string",      "open_status": "OPEN",      "product_category": "BUSINESS_LOANS",      "product_name": "string",      "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"  }}
{  "id": "string",  "message": "string",  "name": "string"}
{  "id": "string",  "message": "string",  "name": "string"}