Direct Debits

The Direct Debits API returns the debit details for an account.

Direct Debit Endpoints

get/v1/banking/acccounts/direct-debits

The Direct Debit model

Retrieve direct debit object.

Attributes

Expand all
direct_debits
arrayrequired

A list of direct debits the end user has set up

Show child attributes
Show child attributes
Response
{
    "direct_debits": [
        {
            "account_id": "123456789",
            "arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
            "authorised_entity": {
                "abn": "12345678901",
                "acn": "123456789",
                "arbn": "123456789",
                "description": "Payment for utilities",
                "financial_institution": "Bank of Example"
            },
            "fiskil_id": "bank_dd_12345abcdef",
            "institution_id": "40",
            "last_debit_amount": "100.00",
            "last_debit_date_time": "2024-09-10T15:30:00Z"
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}
GET

/v1/banking/acccounts/direct-debits

Get Debits

Gets direct debits for a specific 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/banking/acccounts/direct-debits
curl --request GET \
     --url https://api.fiskil.com/v1/v1/banking/acccounts/direct-debits?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
{
    "direct_debits": [
        {
            "account_id": "123456789",
            "arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
            "authorised_entity": {
                "abn": "12345678901",
                "acn": "123456789",
                "arbn": "123456789",
                "description": "Payment for utilities",
                "financial_institution": "Bank of Example"
            },
            "fiskil_id": "bank_dd_12345abcdef",
            "institution_id": "40",
            "last_debit_amount": "100.00",
            "last_debit_date_time": "2024-09-10T15:30:00Z"
        }
    ],
    "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?