Payee - Data API API Reference

The Payee endpoint provides information about saved payees on an end user's accounts.

Endpoints

Method	Endpoint	Description
`GET`	`/v1/payees`	Get payees for an end user

The Payee Model

Attribute	Type	Description
`id`	string	Unique identifier for the payee
`nickname`	string	Nickname or description for the payee
`type`	string	Type of payee (DOMESTIC, BILLER, INTERNATIONAL)
`account_number`	string	Payee's account number (may be masked)
`bsb`	string	Payee's BSB (for domestic payees)
`biller_code`	string	Biller code (for BPAY payees)
`created_date`	string	When the payee was created

Example Response

{
  "id": "payee_123",
  "nickname": "Rent - ABC Property",
  "type": "DOMESTIC",
  "account_number": "****5678",
  "bsb": "123-456",
  "biller_code": null,
  "created_date": "2022-06-15"
}

Get Payees

Retrieve payee information for an end user.

GET https://api.fiskil.com/v1/payees

Query Parameters

Parameter	Type	Required	Description
`end_user_id`	string	Yes	The ID of the end user
`type`	string	No	Filter by payee type (DOMESTIC, BILLER, INTERNATIONAL)

Example Request

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'

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

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

Example Response

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

Payee Types

Type	Description
`DOMESTIC`	Australian bank account payee
`BILLER`	BPAY biller
`INTERNATIONAL`	International transfer payee

Accounts - Get account details
Scheduled Payments - Get scheduled payments

The Payee endpoint provides information about saved payees on an end user's accounts.

Endpoints

Method	Endpoint	Description
`GET`	`/v1/payees`	Get payees for an end user

The Payee Model

Attribute	Type	Description
`id`	string	Unique identifier for the payee
`nickname`	string	Nickname or description for the payee
`type`	string	Type of payee (DOMESTIC, BILLER, INTERNATIONAL)
`account_number`	string	Payee's account number (may be masked)
`bsb`	string	Payee's BSB (for domestic payees)
`biller_code`	string	Biller code (for BPAY payees)
`created_date`	string	When the payee was created

Example Response

{
  "id": "payee_123",
  "nickname": "Rent - ABC Property",
  "type": "DOMESTIC",
  "account_number": "****5678",
  "bsb": "123-456",
  "biller_code": null,
  "created_date": "2022-06-15"
}

Get Payees

Retrieve payee information for an end user.

GET https://api.fiskil.com/v1/payees

Query Parameters

Parameter	Type	Required	Description
`end_user_id`	string	Yes	The ID of the end user
`type`	string	No	Filter by payee type (DOMESTIC, BILLER, INTERNATIONAL)

Example Request

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'

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

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

Example Response

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

Payee Types

Type	Description
`DOMESTIC`	Australian bank account payee
`BILLER`	BPAY biller
`INTERNATIONAL`	International transfer payee

Accounts - Get account details
Scheduled Payments - Get scheduled payments