Core Resources
Banking Api
Energy Api
Common api
The Transaction API allows you to list or retrieve a specific transaction or transactions.
The Transaction API natively supports the categorisation of transactions through the categories object. The Categories Taxonomy CSV is available for download and provides detailed information on all categories supported by Fiskil.
Additionally, you can update the Fiskil predicted category of a specific transaction, which can be useful for correcting categorisation errors or aligning with your business needs.
Transaction Endpoints
Retrieves transaction object.
A list of transactions involving the end user
Links to be used for pagination
{
"transactions": [
{
"account_id": "123456789",
"amount": "100.00",
"apca_number": "012345",
"arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
"biller_code": "123456",
"biller_name": "Electricity Provider",
"category": {
"confidence_level": "VERY_HIGH",
"primary_category": "FOOD_AND_DRINK",
"secondary_category": "FOOD_AND_DRINK_GROCERIES"
},
"crn": "123456789012",
"currency": "AUD",
"description": "Payment for Invoice #1234",
"execution_date_time": "2024-09-10T15:30:00Z",
"extended_data": {
"extension_u_type": "x2p101Payload",
"payee": "PayID123",
"payer": "John Doe",
"service": "X2P1.01",
"x2p101_payload": {
"end_to_end_id": "end-to-end-id-123",
"extended_description": "Extended description of the transaction",
"purpose_code": "PAYMENT_FOR_SERVICES"
}
},
"fiskil_id": "bank_tx_abcdef1234",
"institution_id": "40",
"is_detail_available": true,
"merchant_category_code": "5411",
"merchant_name": "Supermarket",
"posting_date_time": "2024-09-11T09:00:00Z",
"reference": "REF123456",
"status": "POSTED",
"transaction_id": "txn-1234567890",
"type": "PAYMENT",
"value_date_time": "2024-09-11T09:00:00Z"
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/banking/transactions
Returns a list of all transactions based off a given account
A unique identifier for the End User object.
A unique identifier for the Account object.
The start datetime, in RFC3339 format, from which the transaction data is requested. It will first check for posted datetime, and fallback to execution datetime if empty. Transactions without an execution or posted datetime will be excluded from results.
The end datetime, in RFC3339 format, up to which the transaction data is requested. It will first check for posted datetime, and fallback to execution datetime if empty.
Filter to include only transactions with the given status. If unset, transactions of all statuses will be returned
Include only transactions with the specified secondary category code. Optional, but can be specified multiple times for or concatenation. Defaults to include all secondary category codes if omitted.
When the page[after] is specified, backwards pagination is achieved
When the page[after] is specified, forwards pagination is achieved
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.
curl --request GET \
--url https://api.fiskil.com/v1/banking/transactions?end_user_id={end_user_id}&account_id={account_id}&from={from}&to={to}&status={status}&secondary_category={secondary_category}&page[before]={page[before]}&page[after]={page[after]}&page[size]={page[size]} \
--header 'Authorization: Bearer {access_token}' \
--header 'accept: application/json; charset=UTF-8' \
--header 'content-type: application/json; charset=UTF-8'
{
"transactions": [
{
"account_id": "123456789",
"amount": "100.00",
"apca_number": "012345",
"arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
"biller_code": "123456",
"biller_name": "Electricity Provider",
"category": {
"confidence_level": "VERY_HIGH",
"primary_category": "FOOD_AND_DRINK",
"secondary_category": "FOOD_AND_DRINK_GROCERIES"
},
"crn": "123456789012",
"currency": "AUD",
"description": "Payment for Invoice #1234",
"execution_date_time": "2024-09-10T15:30:00Z",
"extended_data": {
"extension_u_type": "x2p101Payload",
"payee": "PayID123",
"payer": "John Doe",
"service": "X2P1.01",
"x2p101_payload": {
"end_to_end_id": "end-to-end-id-123",
"extended_description": "Extended description of the transaction",
"purpose_code": "PAYMENT_FOR_SERVICES"
}
},
"fiskil_id": "bank_tx_abcdef1234",
"institution_id": "40",
"is_detail_available": true,
"merchant_category_code": "5411",
"merchant_name": "Supermarket",
"posting_date_time": "2024-09-11T09:00:00Z",
"reference": "REF123456",
"status": "POSTED",
"transaction_id": "txn-1234567890",
"type": "PAYMENT",
"value_date_time": "2024-09-11T09:00:00Z"
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/banking/transactions/category
Update the predicted category of a specific transaction.
the unique identifier (fiskil_id) of the transaction.
secondary category to override the transaction with. Must be a valid secondary category from the Fiskil taxonomy.
curl --request POST \
--url https://api.fiskil.com/v1/banking/transactions/category \
--header 'Authorization: Bearer {access_token}' \
--header 'accept: application/json; charset=UTF-8' \
--header 'content-type: application/json; charset=UTF-8' \
--data '
{
"fiskil_transaction_id": "{fiskil_transaction_id}",
"secondary_category": "{secondary_category}"
}
'{
"message": "string"
}Was this page helpful?