{
    "balances": [
        {
            "account_id": "123456789",
            "amortised_limit": "5000.00",
            "arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
            "available_balance": "1500.00",
            "credit_limit": "10000.00",
            "currency": "AUD",
            "current_balance": "-250.00",
            "fiskil_id": "bank_balance_12345abcdef",
            "institution_id": "40",
            "purses": [
                {
                    "amount": "100.00",
                    "currency": "USD"
                }
            ]
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}

GET

/v1/banking/balances

List all Balances

Returns a list of all linked balances.

Parameters

end_user_idstringrequired

A unique identifier for the End User object.

account_idstring

A unique identifier for the Account object.

page[before]string

When the page[before] is specified, backwards pagination is achieved

page[after]string

When the page[after] is specified, forwards pagination is achieved

page[size]integer

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.

Request

GET/v1/banking/balances

curl --request GET \
     --url https://api.fiskil.com/v1/v1/banking/balances?end_user_id={end_user_id}&account_id={account_id}&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'

Response

{
    "balances": [
        {
            "account_id": "123456789",
            "amortised_limit": "5000.00",
            "arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
            "available_balance": "1500.00",
            "credit_limit": "10000.00",
            "currency": "AUD",
            "current_balance": "-250.00",
            "fiskil_id": "bank_balance_12345abcdef",
            "institution_id": "40",
            "purses": [
                {
                    "amount": "100.00",
                    "currency": "USD"
                }
            ]
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}

Was this page helpful?