Fiskil

https://docs.fiskil.com
Admin
Fiskil is a Data API platform that provides secure, consent-driven access to consumer banking and...
Tokens:161,533
Snippets:1,927
Trust Score:6.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Products Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/products

Examples of how to request product data using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/products?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/products?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const products = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/products',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

products = response.json()
```

--------------------------------

### List Accounts Request Examples

Source: https://docs.fiskil.com/llms-full.txt

Examples of how to perform a GET request to the accounts endpoint using different programming environments.

```bash
curl --request GET \
  --url 'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const accounts = await response.json();
```

--------------------------------

### Retrieve Instalment Plans via GET

Source: https://docs.fiskil.com/llms-full.txt

Use this request to obtain instalment plans for a specific account, ordered by creation date in descending order.

```bash
curl -X GET "https://api.fiskil.com/v1/banking/customer/{customerId}/accounts/{accountId}/payments/plans" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Customer Detail Request

Source: https://docs.fiskil.com/llms-full.txt

Example request for retrieving detailed customer information using a GET method.

```bash
curl -X GET "https://api.fiskil.com/v1/common/customer/{customerId}/detail" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Energy Balances Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/energy-balances

Examples of how to request energy balances using cURL, Node.js, and Python.

```bash
curl --request GET \
  --url 'https://api.fiskil.com/v1/energy-balances?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/energy-balances?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const balances = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/energy-balances',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

balances = response.json()
```

--------------------------------

### GET /banking/products/id v2 Response Example

Source: https://docs.fiskil.com/data-api/changelog/upgrade-guide

Example JSON response for the v2 endpoint, demonstrating string-based tier bounds and array-based applicability conditions.

```json
{
  "deposit_rates": [
    {
      "additional_info": "Applicable to currency NZD",
      "additional_info_uri": "https://www.commbank.com.au/business/international/international-payments/foreign-currency-accounts.html#rates",
      "application_frequency": "P1M",
      "application_type": "PERIODIC",
      "calculation_frequency": "P1D",
      "deposit_rate_type": "VARIABLE",
      "rate": "0",
      "tiers": [
        {
          "maximum_value": "59999.99",
          "minimum_value": "0.00",
          "name": "Amount",
          "rate_application_method": "WHOLE_BALANCE",
          "unit_of_measure": "DOLLAR"
        }
      ],
      "applicability_conditions": [
        {
          "rate_applicability_type": "NEW_CUSTOMER",
          "additional_value": "NZD",
          "additional_info": "Applicable to currency NZD",
          "additional_info_uri": "https://www.commbank.com.au/business/international/international-payments/foreign-currency-accounts.html#rates"
        }
      ]
    }
  ], 
  "lending_rates": [
    {
        "additional_info": "Investment - Principal and Interest repayment type with Package",
        "additional_info_uri": "https://www.commbank.com.au/content/dam/commbank/personal/apply-online/download-printed-forms/home-loan-update-002842.pdf",
        "additional_value": "P1Y",
        "application_frequency": "P1M",
        "application_type": "PERIODIC",
        "calculation_frequency": "P1D",
        "comparison_rate": "0.0857",
        "interest_payment_due": "IN_ARREARS",
        "lending_rate_type": "FIXED",
        "loan_purpose": "INVESTMENT",
        "rate": "0.0654",
        "repayment_type": "PRINCIPAL_AND_INTEREST",
        "tiers": [
            {
                "maximum_value": "99999999.00",
                "minimum_value": "10000",
                "name": "BALANCE",
                "rate_application_method": "WHOLE_BALANCE",
                "unit_of_measure": "DOLLAR"
            }
        ]
    }
  ]
}
```

--------------------------------

### Get Balances Example Response

Source: https://docs.fiskil.com/data-api/api-reference/balance

A sample response containing a list of account balance objects.

```json
{
  "data": [
    {
      "account_id": "acc_123456789",
      "current_balance": 5432.10,
      "available_balance": 5432.10,
      "credit_limit": null,
      "currency": "AUD",
      "as_of": "2023-01-15T10:30:00Z"
    },
    {
      "account_id": "acc_987654321",
      "current_balance": 12500.00,
      "available_balance": 12500.00,
      "credit_limit": null,
      "currency": "AUD",
      "as_of": "2023-01-15T10:30:00Z"
    },
    {
      "account_id": "acc_credit_001",
      "current_balance": -1250.50,
      "available_balance": 3749.50,
      "credit_limit": 5000.00,
      "currency": "AUD",
      "as_of": "2023-01-15T10:30:00Z"
    }
  ]
}
```

--------------------------------

### Get Scheduled Payments Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/scheduled-payments

Examples of how to request scheduled payments using cURL, Node.js, and Python.

```bash
curl --request GET \
  --url 'https://api.fiskil.com/v1/scheduled-payments?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/scheduled-payments?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const scheduledPayments = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/scheduled-payments',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

scheduled_payments = response.json()
```

--------------------------------

### 404 Not Found Request Example

Source: https://docs.fiskil.com/data-holder/api-reference/cdr-reference/errors

Example of a GET request targeting a non-existent resource ID.

```http
GET /v1/energy/customer/customer-id/accounts/not-a-real-account
```

--------------------------------

### Retrieve Plans Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/plans

Examples for fetching plan data using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/plans?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/plans?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const plans = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/plans',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

plans = response.json()
```

--------------------------------

### Get Payees Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/payee

Examples of how to request payee data using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/payees?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/payees?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const payees = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/payees',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

payees = response.json()
```

--------------------------------

### List All Accounts Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/accounts

Examples of how to request the list of accounts using different programming environments.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/accounts?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const accounts = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/accounts',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

accounts = response.json()
```

--------------------------------

### Install Link SDK

Source: https://docs.fiskil.com/data-api/guides/ai-tools

Command to install the Fiskil Link SDK package.

```bash
npm install @fiskil/link
```

--------------------------------

### Get Direct Debits Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/direct-debits

Examples of how to request direct debit data using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/direct-debits?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/direct-debits?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const directDebits = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/direct-debits',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

direct_debits = response.json()
```

--------------------------------

### Get Invoices Example Response

Source: https://docs.fiskil.com/data-api/api-reference/invoices

A sample response body containing a list of invoice objects.

```json
{
  "data": [
    {
      "id": "inv_123",
      "account_id": "energy_acc_123",
      "invoice_number": "INV-2023-001234",
      "issue_date": "2023-01-01",
      "due_date": "2023-01-15",
      "period_start": "2022-12-01",
      "period_end": "2022-12-31",
      "total_amount": 185.50,
      "currency": "AUD",
      "status": "PAID"
    },
    {
      "id": "inv_124",
      "account_id": "energy_acc_123",
      "invoice_number": "INV-2023-001235",
      "issue_date": "2023-02-01",
      "due_date": "2023-02-15",
      "period_start": "2023-01-01",
      "period_end": "2023-01-31",
      "total_amount": 198.75,
      "currency": "AUD",
      "status": "UNPAID"
    }
  ]
}
```

--------------------------------

### Create End User Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/end-user

Examples for creating an end user using cURL, Node.js, and Python.

```curl
curl --request POST \
  --url https://api.fiskil.com/v1/end-users \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8' \
  --header 'content-type: application/json; charset=UTF-8' \
  --data '{
    "email": "john@example.com",
    "name": "John Doe",
    "phone": "+614123456789"
  }'
```

```javascript
const response = await fetch('https://api.fiskil.com/v1/end-users', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {access_token}',
    'accept': 'application/json; charset=UTF-8',
    'content-type': 'application/json; charset=UTF-8'
  },
  body: JSON.stringify({
    email: 'john@example.com',
    name: 'John Doe',
    phone: '+614123456789'
  })
});

const result = await response.json();
console.log(result.end_user_id);
```

```python
import requests

response = requests.post(
    'https://api.fiskil.com/v1/end-users',
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8',
        'content-type': 'application/json; charset=UTF-8'
    },
    json={
        'email': 'john@example.com',
        'name': 'John Doe',
        'phone': '+614123456789'
    }
)

result = response.json()
print(result['end_user_id'])
```

--------------------------------

### Get Billing For Specific Accounts Request

Source: https://docs.fiskil.com/llms-full.txt

Example request for retrieving billing data for authorized accounts using a POST method.

```bash
curl -X POST "https://api.fiskil.com/v1/energy/customer/{customerId}/accounts/billing" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
```

--------------------------------

### List Consents Request Examples

Source: https://docs.fiskil.com/data-api/api-reference/consents

Examples of how to request the list of consents using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/consent?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5&active=true' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/consent?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5&active=true',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const consents = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/consent',
    params={
        'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5',
        'active': 'true'
    },
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

consents = response.json()
```

--------------------------------

### Search for Statements Request Example

Source: https://docs.fiskil.com/llms-full.txt

Example cURL command to retrieve account statements using an authorization token.

```bash
curl -X GET "https://api.fiskil.com/fdx/v6/customer/{customerId}/accounts/{accountId}/statements" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### fiskil_getting_started

Source: https://docs.fiskil.com/data-api/guides/ai-tools/mcp

Provides a 6-step guided onboarding workflow for new developers integrating with Fiskil APIs.

```APIDOC
## fiskil_getting_started

### Description
A recommended workflow for new developers integrating with Fiskil APIs, covering authentication, end-user creation, session management, SDK embedding, webhooks, and data fetching.
```

--------------------------------

### Get Instalment Plans for Account

Source: https://docs.fiskil.com/llms.txt

Obtain instalment plans for a single specified account.

```APIDOC
## GET /data-holder/api-reference/cdr-reference/listInstalmentPlans

### Description
Obtain instalment plans for a single specified account. The response must be ordered by plan creationDate in descending order.

### Method
GET

### Endpoint
/data-holder/api-reference/cdr-reference/listInstalmentPlans
```

--------------------------------

### Create step-by-step guides

Source: https://docs.fiskil.com/llms-full.txt

Use the Steps and Step components to structure sequential instructions.

```jsx
<Steps>
<Step>
## First step

Content for the first step goes here.
</Step>
<Step>
## Second step

Content for the second step goes here.
</Step>
</Steps>
```

--------------------------------

### Create a loan product

Source: https://docs.fiskil.com/data-holder/platform-api/examples

Demonstrates how to construct the product payload and send a POST request to the Fiskil API.

```Python
import requests

url = "https://api.fiskil.com/v1/data-provider/cdr/products"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}
payload = {
    "additional_information": {
        "eligibility_uri": "https://www.bank.com/legal/secured-personal-loan-target-market-determination/",
        "fees_and_pricing_uri": "https://www.bank.com/legal/credit-fees-guide/"
    },
    "brand": "Your Bank",
    "brand_name": "Your Bank Brand",
    "description": "Secured personal loan with personalised interest rates.",
    "is_tailored": False,
    "name": "Personal Loan",
    "product_category": "PERS_LOANS",
    "fees": [
        {"name": "Establishment fee", "fixed_amount": {"amount": "295.00"}, "fee_type": "UPFRONT", "fee_method_u_type": "fixedAmount"},
        {"name": "Late Payment Fee", "fixed_amount": {"amount": "0.00"}, "fee_type": "EVENT", "fee_method_u_type": "fixedAmount"},
        {"name": "Early Repayment Fee", "fixed_amount": {"amount": "0.00"}, "fee_type": "EVENT", "fee_method_u_type": "fixedAmount"}
    ],
    "eligibility": [
        {"eligibility_type": "NATURAL_PERSON", "additional_value": "Not available for joint borrowers"},
        {"eligibility_type": "RESIDENCY_STATUS", "additional_value": "Australian Citizen or Permanent Resident"},
        {"eligibility_type": "MIN_AGE", "additional_value": "18"}
    ],
    "constraints": [
        {"constraint_type": "MIN_LIMIT", "additional_value": "10000.00"},
        {"constraint_type": "MAX_LIMIT", "additional_value": "100000.00"}
    ],
    "lending_rates": [{
        "lending_rate_type": "FIXED",
        "comparison_rate": "0.1217",
        "repayment_type": "PRINCIPAL_AND_INTEREST",
        "rate": "0.1174",
        "additional_value": "P7Y",
        "application_type": "MATURITY",
        "interest_payment_due": "IN_ARREARS",
        "tiers": [
            {
                "maximumValue": "250000.00",
                "minimumValue": "5000.00",
                "name": "Amount",
                "unitOfMeasure": "DOLLAR"
            }
        ]
    }],
    "features": [
        {"feature_type": "OTHER", "additional_info": "No ongoing fees", "additional_value": "No ongoing fees"},
        {"feature_type": "OTHER", "additional_info": "No early repayment fees", "additional_value": "No early repayment fees"},
        {"feature_type": "OTHER", "additional_info": "Pay weekly, fortnightly or monthly", "additional_value": "Repayment frequency"}
    ]
}

response = requests.post(url, json=payload, headers=headers)
```

```TypeScript
const url = "https://api.fiskil.com/v1/data-provider/cdr/products";
const headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <token>"
};
const payload = {
  additional_information: {
    eligibility_uri: "https://www.bank.com/legal/secured-personal-loan-target-market-determination/",
    fees_and_pricing_uri: "https://www.bank.com/legal/credit-fees-guide/"
  },
  brand: "Your Bank",
  brand_name: "Your Bank Brand",
  description: "Secured personal loan with personalised interest rates.",
  is_tailored: false,
  name: "Personal Loan",
  product_category: "PERS_LOANS",
  fees: [
    { name: "Establishment fee", fixed_amount: { amount: "295.00" }, fee_type: "UPFRONT", fee_method_u_type: "fixedAmount" },
    { name: "Late Payment Fee", fixed_amount: { amount: "0.00" }, fee_type: "EVENT", fee_method_u_type: "fixedAmount" },
    { name: "Early Repayment Fee", fixed_amount: { amount: "0.00" }, fee_type: "EVENT", fee_method_u_type: "fixedAmount" }
  ],
  eligibility: [
    { eligibility_type: "NATURAL_PERSON", additional_value: "Not available for joint borrowers" },
    { eligibility_type: "RESIDENCY_STATUS", additional_value: "Australian Citizen or Permanent Resident" },
    { eligibility_type: "MIN_AGE", additional_value: "18" }
  ],
  constraints: [
    { constraint_type: "MIN_LIMIT", additional_value: "10000.00" },
    { constraint_type: "MAX_LIMIT", additional_value: "100000.00" }
  ],
  lending_rates: [{
    lending_rate_type: "FIXED",
    comparison_rate: "0.1217",
    repayment_type: "PRINCIPAL_AND_INTEREST",
    rate: "0.1174",
    additional_value: "P7Y",
    application_type: "MATURITY",
    interest_payment_due: "IN_ARREARS",
    tiers: [
      {
        maximumValue: "250000.00",
        minimumValue: "5000.00",
        name: "Amount",
        unitOfMeasure: "DOLLAR"
      }
    ]
  }],
  features: [
    { feature_type: "OTHER", additional_info: "No ongoing fees", additional_value: "No ongoing fees" },
    { feature_type: "OTHER", additional_info: "No early repayment fees", additional_value: "No early repayment fees" },
    { feature_type: "OTHER", additional_info: "Pay weekly, fortnightly or monthly", additional_value: "Repayment frequency" }
  ]
};

const response = await fetch(url, {
  method: "POST",
  headers,
  body: JSON.stringify(payload)
});
```

--------------------------------

### Product Model Example Response

Source: https://docs.fiskil.com/data-api/api-reference/products

A sample JSON response structure for a product object.

```json
{
  "id": "prod_123",
  "account_id": "acc_123456789",
  "name": "Complete Freedom Account",
  "description": "Everyday transaction account with no monthly fees",
  "category": "TRANS_AND_SAVINGS_ACCOUNTS",
  "features": [
    "No monthly account keeping fees",
    "Unlimited transactions",
    "Free ATM withdrawals"
  ],
  "fees": [
    {
      "name": "International transaction fee",
      "amount": 3.00,
      "currency": "AUD"
    }
  ],
  "interest_rates": [
    {
      "rate": 0.01,
      "type": "VARIABLE",
      "description": "Base interest rate"
    }
  ]
}
```

--------------------------------

### Example Request

Source: https://docs.fiskil.com/llms-full.txt

A cURL command to retrieve payment networks for a specific account using an authorization token.

```bash
curl -X GET "https://api.fiskil.com/fdx/v6/customer/{customerId}/accounts/{accountId}/payment-networks" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get institution request

Source: https://docs.fiskil.com/llms-full.txt

Example cURL request to fetch an institution by its ID.

```bash
curl -X GET "https://api.fiskil.com/institutions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Get Payees Example Response

Source: https://docs.fiskil.com/data-api/api-reference/payee

A sample response containing a list of payee objects.

```json
{
  "data": [
    {
      "id": "payee_123",
      "nickname": "Rent - ABC Property",
      "type": "DOMESTIC",
      "account_number": "****5678",
      "bsb": "123-456",
      "biller_code": null,
      "created_date": "2022-06-15"
    },
    {
      "id": "payee_456",
      "nickname": "Electricity",
      "type": "BILLER",
      "account_number": null,
      "bsb": null,
      "biller_code": "12345",
      "created_date": "2022-08-20"
    }
  ]
}
```

--------------------------------

### Get Concessions Example Response

Source: https://docs.fiskil.com/data-api/api-reference/concessions

A paginated response containing a list of concession objects.

```json
{
  "data": [
    {
      "id": "conc_123",
      "account_id": "energy_acc_123",
      "type": "GOVERNMENT",
      "display_name": "Low Income Household Rebate",
      "start_date": "2023-01-01",
      "end_date": null,
      "percentage": null,
      "fixed_amount": 285.00
    },
    {
      "id": "conc_456",
      "account_id": "energy_acc_123",
      "type": "RETAILER",
      "display_name": "Pay On Time Discount",
      "start_date": "2023-01-01",
      "end_date": "2024-01-01",
      "percentage": 10,
      "fixed_amount": null
    }
  ]
}
```

--------------------------------

### Get Payees Request

Source: https://docs.fiskil.com/llms-full.txt

Example cURL request to retrieve a list of pre-registered payees for a customer.

```bash
curl -X GET "https://api.fiskil.com/v1/banking/customer/{customerId}/payees" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

--------------------------------

### Install Link SDK

Source: https://docs.fiskil.com/data-api/guides/link-widget/integrating-the-link-sdk

Use npm or pnpm to add the Link SDK package to your Node.js project.

```bash
npm install @fiskil/link
# or
pnpm add @fiskil/link
```

--------------------------------

### Identity API Response Example

Source: https://docs.fiskil.com/data-api/api-reference/identity

A sample JSON response structure for the GET /v1/identity endpoint.

```json
{
  "end_user_id": "482c0e2b-5866-46b1-b795-220b7bba45b5",
  "type": "PERSON",
  "first_name": "John",
  "last_name": "Smith",
  "middle_names": ["William"],
  "organisation_name": null,
  "date_of_birth": "1985-06-15",
  "addresses": [
    {
      "type": "RESIDENTIAL",
      "street": "123 Example Street",
      "suburb": "Sydney",
      "state": "NSW",
      "postcode": "2000",
      "country": "AU"
    }
  ],
  "emails": [
    {
      "type": "PRIMARY",
      "address": "john.smith@example.com"
    }
  ],
  "phones": [
    {
      "type": "MOBILE",
      "number": "+61412345678"
    }
  ]
}
```

--------------------------------

### POST /v1/data-provider/cdr/products

Source: https://docs.fiskil.com/data-holder/platform-api/createProduct

Creates a new product in the system.

```APIDOC
## POST /v1/data-provider/cdr/products

### Description
Creates a new product record.

### Method
POST

### Endpoint
https://api.fiskil.com/v1/data-provider/cdr/products

### Request Body
- **brand** (string) - Required - The brand of the product.
- **description** (string) - Required - A description of the product.
- **is_tailored** (boolean) - Required - Indicates if the product is tailored.
- **name** (string) - Required - The name of the product.
- **product_category** (string) - Required - The category of the product (e.g., BUSINESS_LOANS).

### Request Example
{
  "brand": "string",
  "description": "string",
  "is_tailored": true,
  "name": "string",
  "product_category": "BUSINESS_LOANS"
}

### Response
#### Success Response (200)
- **product_id** (string) - The unique identifier of the created product.

#### Response Example
{
  "product_id": "string"
}
```

--------------------------------

### Get Direct Debits Example Response

Source: https://docs.fiskil.com/data-api/api-reference/direct-debits

The JSON structure returned when querying for multiple direct debits.

```json
{
  "data": [
    {
      "id": "dd_123",
      "account_id": "acc_123456789",
      "authorised_entity": "Netflix Australia",
      "last_debit_date": "2023-01-15",
      "last_debit_amount": 22.99
    },
    {
      "id": "dd_456",
      "account_id": "acc_123456789",
      "authorised_entity": "Spotify",
      "last_debit_date": "2023-01-10",
      "last_debit_amount": 11.99
    }
  ]
}
```

--------------------------------

### Initialize Link SDK with UMD/CDN

Source: https://docs.fiskil.com/data-api/guides/link-widget/integrating-the-link-sdk

Use this pattern when including the SDK directly in HTML via a script tag. The global FiskilLink object provides the link method.

```html
<!-- Include the SDK from the Fiskil CDN -->
<script src="https://cdn.jsdelivr.net/npm/@fiskil/link@0.1.6-beta/dist/fiskil-link.umd.js"></script>
<script>
  // Launch the consent flow with your auth_session_id
  const flow = FiskilLink.link('auth_session_id');

  // Handle the result
  flow
    .then((result) => {
      console.log('Consent complete:', result.consentID);
      // Use consentID to fetch data from Fiskil APIs
    })
    .catch((err) => {
      console.error('Consent failed:', err);
    });

  // You can also close the flow programmatically if needed:
  // flow.close();
</script>
```

--------------------------------

### Authenticated HTTP Request with JWT

Source: https://docs.fiskil.com/data-holder/guides/build/jwt-security

Example of an HTTP GET request using a Bearer token in the Authorization header.

```http
GET /v1/energy/customer/bob/accounts HTTP/2
Host: data-api.acme-company.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImVjZDdjMjEyLWM0YmQtNGRhNi04ZjhkLTgyNjUxODdiNDIwMCJ9.eyJpc3MiOiJodHRwczovL2Nkci5hY21lLWVuZXJneS5jb20iLCJzdWIiOiJodHRwczovL2Nkci5hY21lLWVuZXJneS5jb20iLCJhdWQiOiJodHRwczovL2RhdGEtYXBpLmFjbWU... (truncated)
```

--------------------------------

### get_code_examples

Source: https://docs.fiskil.com/data-api/guides/ai-tools/mcp

Retrieves copy-paste code examples for common Fiskil integration patterns in various programming languages.

```APIDOC
## get_code_examples

### Description
Retrieves code examples for specific integration topics and programming languages.

### Parameters
#### Query Parameters
- **topic** (string) - Required - Integration topic: `auth`, `end-users`, `auth-session`, `link-sdk`, `webhooks`, `banking`, `energy`, or `all`
- **language** (string) - Optional - Programming language: `typescript`, `python`, `javascript`, or `curl`
```

--------------------------------

### Get DER Data Requests

Source: https://docs.fiskil.com/data-api/api-reference/der

Example requests to retrieve DER data using cURL, Node.js, and Python.

```curl
curl --request GET \
  --url 'https://api.fiskil.com/v1/der?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/der?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const der = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/der',
    params={'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5'},
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

der = response.json()
```

--------------------------------

### Retrieve Usage Data Requests

Source: https://docs.fiskil.com/data-api/api-reference/usage

Examples of how to request usage data using different programming environments.

```bash
curl --request GET \
  --url 'https://api.fiskil.com/v1/usage?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5&from_date=2023-01-01&to_date=2023-01-31' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'accept: application/json; charset=UTF-8'
```

```javascript
const response = await fetch(
  'https://api.fiskil.com/v1/usage?end_user_id=482c0e2b-5866-46b1-b795-220b7bba45b5&from_date=2023-01-01&to_date=2023-01-31',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer {access_token}',
      'accept': 'application/json; charset=UTF-8'
    }
  }
);

const usage = await response.json();
```

```python
import requests

response = requests.get(
    'https://api.fiskil.com/v1/usage',
    params={
        'end_user_id': '482c0e2b-5866-46b1-b795-220b7bba45b5',
        'from_date': '2023-01-01',
        'to_date': '2023-01-31'
    },
    headers={
        'Authorization': 'Bearer {access_token}',
        'accept': 'application/json; charset=UTF-8'
    }
)

usage = response.json()
```

--------------------------------

### Launch the Link Widget

Source: https://docs.fiskil.com/data-api/guides/link-widget

Initializes the consent flow using an auth session ID and handles the resulting consent ID or potential errors.

```javascript
import { link } from '@fiskil/link';

const flow = link('auth_session_id');

try {
  const result = await flow;
  console.log('Success! Consent ID:', result.consentID);
} catch (err) {
  console.error('Link error:', err);
}
```

--------------------------------

### Get Scheduled Payments Example Response

Source: https://docs.fiskil.com/data-api/api-reference/scheduled-payments

A successful response containing a list of scheduled payments for the requested end user.

```json
{
  "data": [
    {
      "id": "sp_123",
      "account_id": "acc_123456789",
      "payee_reference": "Rent Payment",
      "amount": 1500.00,
      "currency": "AUD",
      "frequency": "MONTHLY",
      "next_payment_date": "2023-02-01",
      "status": "ACTIVE"
    },
    {
      "id": "sp_456",
      "account_id": "acc_123456789",
      "payee_reference": "Car Loan",
      "amount": 450.00,
      "currency": "AUD",
      "frequency": "FORTNIGHTLY",
      "next_payment_date": "2023-01-20",
      "status": "ACTIVE"
    }
  ]
}
```

--------------------------------

### Opt into v2 with a header

Source: https://docs.fiskil.com/data-api/changelog/upgrade-guide

Use the X-Fiskil-Version header to specify the API version for a request.

```bash
curl https://api.fiskil.com/v1/banking/products/{product_id} \
  -H 'X-Fiskil-Version: v2' \
  -H 'Authorization: Bearer {token}'
```

--------------------------------

### Get DER Data Example Response

Source: https://docs.fiskil.com/data-api/api-reference/der

A sample JSON response containing a list of DER devices for a service point.

```json
{
  "data": [
    {
      "service_point_id": "NMI123456789",
      "account_id": "energy_acc_123",
      "approved_capacity": 5.0,
      "available_phases": 1,
      "devices": [
        {
          "device_type": "SOLAR",
          "manufacturer": "SunPower",
          "model": "X22-360",
          "capacity": 6.6,
          "install_date": "2022-03-15",
          "status": "ACTIVE"
        },
        {
          "device_type": "BATTERY",
          "manufacturer": "Tesla",
          "model": "Powerwall 2",
          "capacity": 13.5,
          "install_date": "2022-03-15",
          "status": "ACTIVE"
        }
      ]
    }
  ]
}
```

--------------------------------

### Create loan product via cURL

Source: https://docs.fiskil.com/data-holder/platform-api/examples

Use this POST request to register a new loan product. Ensure the Authorization header includes a valid bearer token.

```bash
curl -X POST https://api.fiskil.com/v1/data-provider/cdr/products \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "additional_information": {
    "eligibility_uri": "https://www.bank.com/legal/secured-personal-loan-target-market-determination/",
    "fees_and_pricing_uri": "https://www.bank.com/legal/credit-fees-guide/"
  },
  "brand": "Your Bank",
  "brand_name": "Your Bank Brand",
  "description": "Secured personal loan with personalised interest rates.",
  "is_tailored": false,
  "name": "Personal Loan",
  "product_category": "PERS_LOANS",
  "fees": [
    {
      "name": "Establishment fee",
      "fixed_amount": { "amount": "295.00" },
      "fee_type": "UPFRONT",
      "fee_method_u_type": "fixedAmount"
    },
    {
      "name": "Late Payment Fee",
      "fixed_amount": { "amount": "0.00" },
      "fee_type": "EVENT",
      "fee_method_u_type": "fixedAmount"
    },
    {
      "name": "Early Repayment Fee",
      "additional_info": "No penalty for extra repayments or early payout",
      "fixed_amount": { "amount": "0.00" },
      "fee_type": "EVENT",
      "fee_method_u_type": "fixedAmount"
    }
  ],
  "eligibility": [
    {
      "eligibility_type": "NATURAL_PERSON",
      "additional_value": "Not available for joint or non-individual borrowers"
    },
    {
      "eligibility_type": "RESIDENCY_STATUS",
      "additional_value": "Australian Citizen or Permanent Resident"
    },
    {
      "eligibility_type": "MIN_AGE",
      "additional_value": "18"
    }
  ],
  "constraints": [
    { "constraint_type": "MIN_LIMIT", "additional_value": "10000.00" },
    { "constraint_type": "MAX_LIMIT", "additional_value": "100000.00" }
  ],
  "lending_rates": [
    {
      "lending_rate_type": "FIXED",
      "comparison_rate": "0.1217",
      "repayment_type": "PRINCIPAL_AND_INTEREST",
      "rate": "0.1174",
      "additional_info": "Available for 1 to 7 years.",
      "additional_value": "P7Y",
      "application_type": "MATURITY",
      "interest_payment_due": "IN_ARREARS",
      "loan_purpose": "OTHER",
      "tiers": [
        {
          "maximumValue": "250000.00",
          "minimumValue": "5000.00",
          "name": "Amount",
          "unitOfMeasure": "DOLLAR"
        }
      ]
    }
  ],
  "features": [
    {
      "feature_type": "OTHER",
      "additional_info": "No monthly or annual account keeping fees",
      "additional_value": "No ongoing fees"
    },
    {
      "feature_type": "OTHER",
      "additional_info": "Extra repayments or early payout without penalty",
      "additional_value": "No early repayment fees"
    },
    {
      "feature_type": "OTHER",
      "additional_info": "Pay weekly, fortnightly or monthly via direct debit",
      "additional_value": "Repayment frequency"
    }
  ]
}'
```
Tokens:
Raw