{
    "payment_schedules": [
        {
            "account_id": "acc123",
            "amount": "100.00",
            "arrangement_id": "arr678",
            "card_debit": {
                "calculation_type": "STATIC",
                "card_scheme": "VISA",
                "payment_frequency": "P1M"
            },
            "digital_wallet": {
                "calculation_type": "STATIC",
                "identifier": "hello@example.com",
                "name": "Main Account Card",
                "payment_frequency": "P1M",
                "provider": "PAYPAL_AU",
                "type": "EMAIL"
            },
            "direct_debit": {
                "account_number": "123456789",
                "bsb": "062000",
                "calculation_type": "BALANCE",
                "is_tokenised": true,
                "payment_frequency": "P1M"
            },
            "fiskil_id": "energy_ps_abcdef123",
            "institution_id": "140",
            "manual_payment": {
                "bill_frequency": "P1M"
            },
            "payment_schedule_u_type": "cardDebit"
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}

GET

/v1/energy/payment-schedules

List all Payment Schedules

Returns the agreed payment schedule and details, if any, for a specific energy account.

Parameters

end_user_idstringrequired

A unique identifier for the End User 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/energy/payment-schedules

curl --request GET \
     --url https://api.fiskil.com/v1/v1/energy/payment-schedules?end_user_id={end_user_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

{
    "payment_schedules": [
        {
            "account_id": "acc123",
            "amount": "100.00",
            "arrangement_id": "arr678",
            "card_debit": {
                "calculation_type": "STATIC",
                "card_scheme": "VISA",
                "payment_frequency": "P1M"
            },
            "digital_wallet": {
                "calculation_type": "STATIC",
                "identifier": "hello@example.com",
                "name": "Main Account Card",
                "payment_frequency": "P1M",
                "provider": "PAYPAL_AU",
                "type": "EMAIL"
            },
            "direct_debit": {
                "account_number": "123456789",
                "bsb": "062000",
                "calculation_type": "BALANCE",
                "is_tokenised": true,
                "payment_frequency": "P1M"
            },
            "fiskil_id": "energy_ps_abcdef123",
            "institution_id": "140",
            "manual_payment": {
                "bill_frequency": "P1M"
            },
            "payment_schedule_u_type": "cardDebit"
        }
    ],
    "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?