Direct Debits - Data API API Reference

The Direct Debits endpoint provides information about direct debit arrangements on an end user's accounts.

Endpoints

Method	Endpoint	Description
`GET`	`/v1/direct-debits`	Get direct debits for an end user

The Direct Debit Model

Attribute	Type	Description
`id`	string	Unique identifier for the direct debit
`account_id`	string	ID of the account the direct debit is on
`authorised_entity`	string	Name of the entity authorized to debit
`last_debit_date`	string	Date of the last debit
`last_debit_amount`	number	Amount of the last debit

Example Response

{
  "id": "dd_123",
  "account_id": "acc_123456789",
  "authorised_entity": "Netflix Australia",
  "last_debit_date": "2023-01-15",
  "last_debit_amount": 22.99
}

Get Direct Debits

Retrieve direct debit information for an end user.

GET https://api.fiskil.com/v1/direct-debits

Query Parameters

Parameter	Type	Required	Description
`end_user_id`	string	Yes	The ID of the end user
`account_id`	string	No	Filter by specific account ID

Example Request

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'

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();

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()

Example Response

{
  "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
    }
  ]
}

Use Cases

Subscription Detection: Identify recurring subscriptions for budgeting apps
Bill Management: Help users track and manage their regular payments
Affordability Assessment: Understand recurring financial commitments

Accounts - Get account details
Transactions - See the actual debit transactions
Scheduled Payments - Get scheduled payments

The Direct Debits endpoint provides information about direct debit arrangements on an end user's accounts.

Endpoints

Method	Endpoint	Description
`GET`	`/v1/direct-debits`	Get direct debits for an end user

The Direct Debit Model

Attribute	Type	Description
`id`	string	Unique identifier for the direct debit
`account_id`	string	ID of the account the direct debit is on
`authorised_entity`	string	Name of the entity authorized to debit
`last_debit_date`	string	Date of the last debit
`last_debit_amount`	number	Amount of the last debit

Example Response

{
  "id": "dd_123",
  "account_id": "acc_123456789",
  "authorised_entity": "Netflix Australia",
  "last_debit_date": "2023-01-15",
  "last_debit_amount": 22.99
}

Get Direct Debits

Retrieve direct debit information for an end user.

GET https://api.fiskil.com/v1/direct-debits

Query Parameters

Parameter	Type	Required	Description
`end_user_id`	string	Yes	The ID of the end user
`account_id`	string	No	Filter by specific account ID

Example Request

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'

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();

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()

Example Response

{
  "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
    }
  ]
}

Use Cases

Subscription Detection: Identify recurring subscriptions for budgeting apps
Bill Management: Help users track and manage their regular payments
Affordability Assessment: Understand recurring financial commitments

Accounts - Get account details
Transactions - See the actual debit transactions
Scheduled Payments - Get scheduled payments