FiskilFiskilFiskil DocsFiskil Docs
Log InSign Up
GuidesAPI ReferenceChangelog

Mobile menu

HomeFiskilFiskil
Log InSign Up
Introduction

Getting Started

AuthenticationErrorsPagination

CORE RESOURCES

Linking Accounts

BANKING API

ENERGY API

IDENTITY

Get product details

Returns detailed information about a banking product

AI Actions
GET
/v1/banking/products/{product_id}

Returns detailed information about a banking product

Authorization

Token_header_Authorization
AuthorizationBearer <token>

In: header

Path Parameters

product_idstringrequired

A unique identifier specifying product.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.fiskil.com/v1/banking/products/string"
{
  "product": {
    "additional_information": {
      "additional_bundle_uris": [
        {
          "additional_info_uri": "https://bank.com/additional-info",
          "description": "View more details"
        }
      ],
      "additional_eligibility_uris": [
        {
          "additional_info_uri": "https://bank.com/additional-info",
          "description": "View more details"
        }
      ],
      "additional_fees_and_pricing_uris": [
        {
          "additional_info_uri": "https://bank.com/additional-info",
          "description": "View more details"
        }
      ],
      "additional_overview_uris": [
        {
          "additional_info_uri": "https://bank.com/additional-info",
          "description": "View more details"
        }
      ],
      "additional_terms_uris": [
        {
          "additional_info_uri": "https://bank.com/additional-info",
          "description": "View more details"
        }
      ],
      "bundle_uri": "https://bank.com/bundles",
      "eligibility_uri": "https://bank.com/eligibility",
      "fees_and_pricing_uri": "https://bank.com/fees",
      "overview_uri": "https://bank.com/overview",
      "terms_uri": "https://bank.com/terms"
    },
    "application_uri": "https://bank.com/apply",
    "brand": "BankX",
    "brand_name": "BankX Gold",
    "bundles": [
      {
        "additional_info": "Bundle includes a credit card and savings account with discounted fees.",
        "additional_info_uri": "https://bank.com/bundle-info",
        "description": "A bundle of products with special discounts",
        "name": "Premium Bundle",
        "product_ids": [
          "string"
        ]
      }
    ],
    "card_art": [
      {
        "image_uri": "https://bank.com/card-art.png",
        "title": "Gold Card Image"
      }
    ],
    "constraints": [
      {
        "additional_info": "This product has a maximum balance limit.",
        "additional_info_uri": "https://bank.com/constraint-info",
        "additional_value": "100000",
        "constraint_type": "MAX_BALANCE"
      }
    ],
    "depositRates": [
      {
        "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"
          }
        ]
      }
    ],
    "description": "A premium savings account with no monthly fees",
    "effective_from": "2023-01-01T00:00:00Z",
    "effective_to": "2024-12-31T23:59:59Z",
    "eligibility": [
      {
        "additional_info": "Only available to individuals with an income greater than $50,000.",
        "additional_info_uri": "https://bank.com/eligibility-info",
        "additional_value": "50000.00",
        "eligibility_type": "MIN_INCOME"
      }
    ],
    "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"
      }
    ],
    "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_product_abdef1234",
    "institution_id": "112",
    "is_tailored": false,
    "last_updated": "2023-07-15T10:30:00Z",
    "lendingRates": [
      {
        "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"
          }
        ]
      }
    ],
    "name": "Premium Savings Account",
    "product_category": "TRANS_AND_SAVINGS_ACCOUNTS",
    "product_id": "prod-001"
  }
}
{
  "id": "string",
  "message": "string",
  "name": "string"
}
{
  "id": "string",
  "message": "string",
  "name": "string"
}

Was this page helpful?

List productsGet Transactions