Core Resources
Banking Api
Energy Api
Common api
The Scheduled Payments API returns the payment details for an account.
Scheduled Payments Endpoints
Retrieve schedule payment object.
A list of scheduled payments that the end user has set up
Links to be used for pagination
{
"scheduled_payments": [
{
"arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
"fiskil_id": "bank_sp_abcdef1234",
"from": {
"account_id": "123456789"
},
"institution_id": "40",
"nickname": "Monthly Rent",
"payee_reference": "REF123456",
"payer_reference": "PAY123456",
"payment_set": [
{
"amount": "100.00",
"currency": "AUD",
"is_amount_calculated": true,
"to": {
"account_id": "987654321",
"biller": {
"biller_code": "123456",
"biller_name": "Electricity Co.",
"crn": "987654321"
},
"digital_wallet": {
"identifier": "user@example.com",
"name": "John Doe",
"provider": "PAYPAL_AU",
"type": "EMAIL"
},
"domestic": {
"account": {
"account_name": "John Doe",
"account_number": "12345678",
"bsb": "062000"
},
"card": {
"card_number": "4111111111111111"
},
"pay_id": {
"identifier": "user@example.com",
"name": "John Doe",
"type": "EMAIL"
},
"payee_account_u_type": "account"
},
"international": {
"bank_details": {
"account_number": "1234567890",
"bank_address": {
"address": "123 Bank St",
"name": "Bank of America"
},
"beneficiary_bank_bic": "BOFAUS3N",
"chip_number": "987654321",
"country": "USA",
"fed_wire_number": "123456789",
"legal_entity_identifier": "5493001KJTIIGC8Y1R12",
"routing_number": "021000021",
"sort_code": "404040"
},
"beneficiary_details": {
"country": "USA",
"message": "Payment for invoice #12345",
"name": "Jane Doe"
}
},
"nickname": "John Doe",
"payee_id": "PAYEE123456",
"payee_reference": "PAYEE_REF123",
"to_utype": "accountId"
}
}
],
"recurrence": {
"event_based": {
"description": "Payment due when invoice received"
},
"interval_schedule": {
"final_payment_date": "2025-12-31",
"intervals": [
{
"day_in_interval": "P1D",
"interval": "P1W"
}
],
"non_business_day_treatment": "AFTER",
"payments_remaining": 5
},
"last_week_day": {
"final_payment_date": "2025-12-31",
"interval": "P1M",
"last_week_day": "FRI",
"non_business_day_treatment": "ON",
"payments_remaining": 10
},
"next_payment_date": "2024-09-30",
"once_off": {
"payment_date": "2024-12-25"
},
"recurrence_utype": "intervalSchedule"
},
"scheduled_payment_id": "SP123456",
"status": "ACTIVE"
}
],
"links": {
"next": "https://api.fiskil.com/v1/accounts?page[after]=x",
"prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
}
}/v1/banking/payments/scheduled
Gets scheduled payments for a specific account.
A unique identifier for the End User object.
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/v1/banking/payments/scheduled?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'
{
"scheduled_payments": [
{
"arrangement_id": "90bfd779-e8eb-4e9f-87b3-5191ba7332c2",
"fiskil_id": "bank_sp_abcdef1234",
"from": {
"account_id": "123456789"
},
"institution_id": "40",
"nickname": "Monthly Rent",
"payee_reference": "REF123456",
"payer_reference": "PAY123456",
"payment_set": [
{
"amount": "100.00",
"currency": "AUD",
"is_amount_calculated": true,
"to": {
"account_id": "987654321",
"biller": {
"biller_code": "123456",
"biller_name": "Electricity Co.",
"crn": "987654321"
},
"digital_wallet": {
"identifier": "user@example.com",
"name": "John Doe",
"provider": "PAYPAL_AU",
"type": "EMAIL"
},
"domestic": {
"account": {
"account_name": "John Doe",
"account_number": "12345678",
"bsb": "062000"
},
"card": {
"card_number": "4111111111111111"
},
"pay_id": {
"identifier": "user@example.com",
"name": "John Doe",
"type": "EMAIL"
},
"payee_account_u_type": "account"
},
"international": {
"bank_details": {
"account_number": "1234567890",
"bank_address": {
"address": "123 Bank St",
"name": "Bank of America"
},
"beneficiary_bank_bic": "BOFAUS3N",
"chip_number": "987654321",
"country": "USA",
"fed_wire_number": "123456789",
"legal_entity_identifier": "5493001KJTIIGC8Y1R12",
"routing_number": "021000021",
"sort_code": "404040"
},
"beneficiary_details": {
"country": "USA",
"message": "Payment for invoice #12345",
"name": "Jane Doe"
}
},
"nickname": "John Doe",
"payee_id": "PAYEE123456",
"payee_reference": "PAYEE_REF123",
"to_utype": "accountId"
}
}
],
"recurrence": {
"event_based": {
"description": "Payment due when invoice received"
},
"interval_schedule": {
"final_payment_date": "2025-12-31",
"intervals": [
{
"day_in_interval": "P1D",
"interval": "P1W"
}
],
"non_business_day_treatment": "AFTER",
"payments_remaining": 5
},
"last_week_day": {
"final_payment_date": "2025-12-31",
"interval": "P1M",
"last_week_day": "FRI",
"non_business_day_treatment": "ON",
"payments_remaining": 10
},
"next_payment_date": "2024-09-30",
"once_off": {
"payment_date": "2024-12-25"
},
"recurrence_utype": "intervalSchedule"
},
"scheduled_payment_id": "SP123456",
"status": "ACTIVE"
}
],
"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?