Obtain the agreed payment schedule and details, if any, for a specific energy account.
Some general notes about this end point:
This API describes how the consumer has elected to pay for their account
Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments
Payments that can be initiated by the retailer, based on a consumer’s preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields
Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API
The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header.
You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you must:
Verify the signature
Ensure the token has not expired by checking the exp claim
The sub and iss claims are your data provider subdomain
The aud claim is the URI of the resource being requested (excluding any query parameters)
The jti value is unique
For further detail on security and authentication refer to our Authentication documentation
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fiskil","colors":{"primary":"#191b15","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/light.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=acb4183b4445e3ca4d0a4637752c3943","dark":"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/dark.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=8c629fe8068a14827769da2017e4cc63"},"favicon":"https://mintcdn.com/fiskil/LpdVPOo2gKHc0Bqu/favicon.png?fit=max\u0026auto=format\u0026n=LpdVPOo2gKHc0Bqu\u0026q=85\u0026s=dfe1748146c5e63e3caa317a55fe6f4b","appearance":{"default":"light"},"background":{"decoration":"grid"},"navbar":{"primary":{"type":"button","label":"Connect now","href":"https://www.fiskil.com/contact"}},"footer":{"socials":{"x":"https://twitter.com/Fiskil_","linkedin":"https://www.linkedin.com/company/fiskil"}},"fonts":{"heading":{"family":"Manrope"},"body":{"family":"Figtree"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://www.fiskil.com"},{"anchor":"Support","icon":"headset","href":"https://www.fiskil.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fiskil","hasAudioNarration":false,"actualSubdomain":"fiskil","customDomains":["holder.docs.fiskil.dev"],"gitSource":{"type":"github","owner":"fiskil","repo":"dp_docs_v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae27f24defc6aa028e6aae8","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"CDR","count":44},{"language":"default","tag":"Data Sharing","count":36},{"language":"default","tag":"Docs","count":27},{"language":"default","tag":"Banking","count":15},{"language":"default","tag":"FDX","count":12},{"language":"default","tag":"Energy","count":11},{"language":"default","tag":"Consent Flow","count":10},{"language":"default","tag":"Platform API","count":9},{"language":"default","tag":"Testing CDR","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#navigation-items>button:first-child{margin-bottom:24px}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"],img[src*=\"/icons/cdr\"],svg#Layer_1{background-color:transparent!important}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"]{filter:none!important;-webkit-filter:none!important}img[src$=\"/icons/fdx.svg\"],img[src$=\"icons/fdx.svg\"],img[src*=\"/icons/fdx\"]{background-color:transparent!important;filter:none!important;-webkit-filter:none!important}img[src$=\"/icons/cdr.svg\"],img[src$=\"icons/cdr.svg\"],img[src*=\"/icons/cdr\"],img[src$=\"/icons/fdx.svg\"],img[src$=\"icons/fdx.svg\"],img[src*=\"/icons/fdx\"]{width:20px!important;height:20px!important;vertical-align:middle}"}],"page":{"pagePath":"api-reference/energy/get-agreed-payment-schedule","slug":"/api-reference/energy/get-agreed-payment-schedule","pageMetadata":{"title":"Get Agreed Payment Schedule","description":"Obtain the agreed payment schedule and details, if any, for a specific energy account.\nSome general notes about this end point:\n * This API describes how the consumer has elected to pay for their account\n * Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments\n * Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields\n * Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\n","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/payment-schedule","href":"/api-reference/energy/get-agreed-payment-schedule","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Obtain the agreed payment schedule and details, if any, for a specific energy account.\\nSome general notes about this end point:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"This API describes how the consumer has elected to pay for their account\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Payments that can be initiated by the retailer, based on a consumer’s preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Agreed Payment Schedule","description":"Obtain the agreed payment schedule and details, if any, for a specific energy account.\nSome general notes about this end point:\n * This API describes how the consumer has elected to pay for their account\n * Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments\n * Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields\n * Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\n","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/payment-schedule","href":"/api-reference/energy/get-agreed-payment-schedule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fiskil/23b3382855374c54/sidebar.js"],"openApiReferenceData":{"operation":{"description":"Obtain the agreed payment schedule and details, if any, for a specific energy account.\nSome general notes about this end point:\n * This API describes how the consumer has elected to pay for their account\n * Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments\n * Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields\n * Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\n","operationId":"getPaymentSchedule","parameters":["37f6efdc-f507-4747-ae6d-8400b89ed602","808be17c-b82e-4391-89bb-3fb59d980826"],"responses":{"200":"d494e2eb-b434-49b1-8064-36289a1b295c","404":"d487d785-7d34-418c-82b4-1885983699a8"},"summary":"Get Agreed Payment Schedule","tags":["Energy","Payment Schedule"],"method":"get","type":"path","servers":["8e56edbd-71c3-4c89-9d53-903044920b32"],"security":["5609e27a-91a0-4697-9efe-47e4706ce093"],"path":"/v1/energy/customer/{customerId}/accounts/{accountId}/payment-schedule","baseUrlOptions":["https://api.provider.fiskil.com"],"title":"Get Agreed Payment Schedule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"37f6efdc-f507-4747-ae6d-8400b89ed602":{"description":"Unique ID of a customer. This ID must not change for the lifecycle of the customer","explode":false,"in":"path","name":"customerId","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique ID of a customer. This ID must not change for the lifecycle of the customer","uniqueKey":"","typeLabel":"string"},"style":"simple"},"808be17c-b82e-4391-89bb-3fb59d980826":{"description":"ID of a specific account to obtain data for.","explode":false,"in":"path","name":"accountId","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of a specific account to obtain data for.","uniqueKey":"","typeLabel":"string"},"style":"simple"}},"responses":{"d494e2eb-b434-49b1-8064-36289a1b295c":{"content":{"application/json":{"schema":{"example":{"data":{"paymentSchedules":[{"directDebit":{"bsb":"111222","calculationType":"BALANCE","accountNumber":"12345678","paymentFrequency":"P3M","isTokenised":false},"paymentScheduleUType":"directDebit"}]}},"properties":{"data":{"properties":{"paymentSchedules":{"description":"Array may be empty if no payment schedule exist","items":{"properties":{"paymentScheduleUType":{"description":"The type of object present in this response","enum":["cardDebit","directDebit","manualPayment","digitalWallet"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].paymentScheduleUType","typeLabel":"enum\u003cstring>"},"amount":{"description":"Optional payment amount indicating that a constant payment amount is scheduled to be paid (used in bill smoothing scenarios)","type":"string","x-cds-type":"AmountString","uniqueKey":"data.paymentSchedules.items.[INDEX].amount","typeLabel":"string"},"cardDebit":{"description":"Represents a regular credit card payment schedule. Mandatory if paymentScheduleUType is set to cardDebit","example":{"calculationType":"STATIC","cardScheme":"VISA","paymentFrequency":"paymentFrequency"},"properties":{"cardScheme":{"description":"The type of credit card held on file","enum":["VISA","MASTERCARD","AMEX","DINERS","OTHER","UNKNOWN"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].cardDebit.cardScheme","typeLabel":"enum\u003cstring>"},"paymentFrequency":{"description":"The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)","type":"string","x-cds-type":"ExternalRef","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].cardDebit.paymentFrequency","typeLabel":"string"},"calculationType":{"description":"The mechanism by which the payment amount is calculated. Explanation of values are as follows:\u003cbr/>\u003cul>\u003cli>**STATIC** - Indicates a consistent, static amount, per payment\u003c/li>\u003cli>**BALANCE** - Indicates that the outstanding balance for the account is paid per period\u003c/li>\u003cli>**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm\u003c/li>\u003c/ul>","enum":["STATIC","BALANCE","CALCULATED"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].cardDebit.calculationType","typeLabel":"enum\u003cstring>"}},"required":["calculationType","cardScheme","paymentFrequency"],"type":"object","uniqueKey":"data.paymentSchedules.items.[INDEX].cardDebit","typeLabel":"object"},"directDebit":{"description":"Represents a regular direct debit from a specified bank account. Mandatory if paymentScheduleUType is set to directDebit","example":{"bsb":"111222","calculationType":"BALANCE","accountNumber":"12345678","paymentFrequency":"P3M"},"properties":{"paymentFrequency":{"description":"The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)","type":"string","x-cds-type":"ExternalRef","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit.paymentFrequency","typeLabel":"string"},"calculationType":{"description":"The mechanism by which the payment amount is calculated. Explanation of values are as follows:\u003cbr/>\u003cul>\u003cli>**STATIC** - Indicates a consistent, static amount, per payment\u003c/li>\u003cli>**BALANCE** - Indicates that the outstanding balance for the account is paid per period\u003c/li>\u003cli>**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm\u003c/li>\u003c/ul>","enum":["STATIC","BALANCE","CALCULATED"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit.calculationType","typeLabel":"enum\u003cstring>"},"isTokenised":{"description":"Flag indicating that the account details are tokenised, or held in a closed system, and is not accessible through any other channels. False if absent","type":"boolean","uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit.isTokenised","typeLabel":"boolean"},"bsb":{"description":"The unmasked BSB for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false","type":"string","uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit.bsb","typeLabel":"string"},"accountNumber":{"description":"The unmasked account number for the account to be debited. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. Is required if isTokenised is absent or false","type":"string","uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit.accountNumber","typeLabel":"string"}},"required":["calculationType","paymentFrequency"],"type":"object","x-conditional":["bsb","accountNumber"],"uniqueKey":"data.paymentSchedules.items.[INDEX].directDebit","typeLabel":"object"},"digitalWallet":{"description":"Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet","example":{"calculationType":"STATIC","identifier":"hello@example.com","provider":"PAYPAL_AU","name":"P Sherman","type":"EMAIL","paymentFrequency":"P1M"},"properties":{"name":{"description":"The display name of the wallet as given by the customer, else a default value defined by the data holder","type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.name","typeLabel":"string"},"identifier":{"description":"The identifier of the digital wallet (dependent on type)","type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.identifier","typeLabel":"string"},"type":{"description":"The type of the digital wallet identifier","enum":["EMAIL","CONTACT_NAME","TELEPHONE"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.type","typeLabel":"enum\u003cstring>"},"provider":{"description":"The provider of the digital wallet","enum":["PAYPAL_AU","OTHER"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.provider","typeLabel":"enum\u003cstring>"},"paymentFrequency":{"description":"The frequency that payments will occur. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)","type":"string","x-cds-type":"ExternalRef","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.paymentFrequency","typeLabel":"string"},"calculationType":{"description":"The mechanism by which the payment amount is calculated. Explanation of values are as follows:\u003cbr/>\u003cul>\u003cli>**STATIC** - Indicates a consistent, static amount, per payment\u003c/li>\u003cli>**BALANCE** - Indicates that the outstanding balance for the account is paid per period\u003c/li>\u003cli>**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm\u003c/li>\u003c/ul>","enum":["STATIC","BALANCE","CALCULATED"],"type":"string","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet.calculationType","typeLabel":"enum\u003cstring>"}},"required":["calculationType","identifier","name","paymentFrequency","provider","type"],"type":"object","uniqueKey":"data.paymentSchedules.items.[INDEX].digitalWallet","typeLabel":"object"},"manualPayment":{"description":"Represents a manual payment schedule where the customer pays in response to a delivered statement. Mandatory if paymentScheduleUType is set to manualPayment","example":{"billFrequency":"P3M"},"properties":{"billFrequency":{"description":"The frequency with which a bill will be issued. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)","type":"string","x-cds-type":"ExternalRef","isRequired":true,"uniqueKey":"data.paymentSchedules.items.[INDEX].manualPayment.billFrequency","typeLabel":"string"}},"required":["billFrequency"],"type":"object","uniqueKey":"data.paymentSchedules.items.[INDEX].manualPayment","typeLabel":"object"}},"required":["paymentScheduleUType"],"type":"object","x-conditional":["cardDebit","directDebit","manualPayment","digitalWallet"],"uniqueKey":"data.paymentSchedules.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.paymentSchedules","typeLabel":"object[]"}},"required":["paymentSchedules"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"paymentSchedules":[{"directDebit":{"bsb":"111222","calculationType":"BALANCE","accountNumber":"12345678","paymentFrequency":"P3M","isTokenised":false},"paymentScheduleUType":"directDebit"}]}}}},"exampleType":"generated"}},"description":"The customer's payment schedule","exampleType":"generated"},"d487d785-7d34-418c-82b4-1885983699a8":{"description":"The customer ID in the URL path is invalid or not found","content":{"application/json":{"schema":{"example":{"error":"Customer not found"},"type":"object","properties":{"error":{"type":"string","description":"A message describing what caused the error","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Customer not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5609e27a-91a0-4697-9efe-47e4706ce093":{"bearerAuth":{"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"8e56edbd-71c3-4c89-9d53-903044920b32":{"url":"https://api.provider.fiskil.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the `Authorization` header.\nYou should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you **must**:\n * Verify the signature\n * Ensure the token has not expired by checking the `exp` claim\n * The `sub` and `iss` claims are your data provider subdomain\n * The `aud` claim is the URI of the resource being requested (excluding any query parameters)\n * The `jti` value is unique\nFor further detail on security and authentication refer to our [Authentication](/docs/build/jwt-security) documentation\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/cdr.yaml"},"subdomain":"fiskil","siteName":"Fiskil","title":"Get Agreed Payment Schedule - Fiskil","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T03:44:54.170Z","originalFileLocation":"api-reference/energy/get-agreed-payment-schedule.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Obtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this end point: This API describes how the consumer has elected to pay for their account Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments Payments that can be initiated by the retailer, based on a consumer\u0026#x27;s preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fiskil\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Agreed Payment Schedule - Fiskil\">\u003cmeta data-mint-head property=\"og:description\" content=\"Obtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this end point: This API describes how the consumer has elected to pay for their account Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments Payments that can be initiated by the retailer, based on a consumer\u0026#x27;s preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fiskil\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fiskil.mintlify.site/_mintlify/api/og/v2?division=Energy\u0026amp;title=Get+Agreed+Payment+Schedule\u0026amp;description=Obtain+the+agreed+payment+schedule+and+details%2C+if+any%2C+for+a+specific+energy+account.%0ASome+general+notes+about+this+end+point%3A%0A++*+This+API+describes+how+the+c\u0026amp;theme=fc6062bcca7fed429a4b2900\u0026amp;signature=6f203de9b58d4ea05462397b329361fd821ffa1f980b85547d5b4501c5e766b7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Agreed Payment Schedule - Fiskil\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Obtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this end point: This API describes how the consumer has elected to pay for their account Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments Payments that can be initiated by the retailer, based on a consumer\u0026#x27;s preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fiskil.mintlify.site/_mintlify/api/og/v2?division=Energy\u0026amp;title=Get+Agreed+Payment+Schedule\u0026amp;description=Obtain+the+agreed+payment+schedule+and+details%2C+if+any%2C+for+a+specific+energy+account.%0ASome+general+notes+about+this+end+point%3A%0A++*+This+API+describes+how+the+c\u0026amp;theme=fc6062bcca7fed429a4b2900\u0026amp;signature=6f203de9b58d4ea05462397b329361fd821ffa1f980b85547d5b4501c5e766b7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fiskil/g2S5gqslwo9e4Wqx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fiskil\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#191b15\">\u003clink data-mint-head rel=\"canonical\" href=\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/energy/get-agreed-payment-schedule.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://holder.docs.fiskil.dev/#organization\",\"name\":\"Fiskil\",\"url\":\"https://holder.docs.fiskil.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fiskil/3jtGQNqcSr5N4TNw/logo/light.svg?fit=max\u0026auto=format\u0026n=3jtGQNqcSr5N4TNw\u0026q=85\u0026s=acb4183b4445e3ca4d0a4637752c3943\"}},{\"@type\":\"WebSite\",\"@id\":\"https://holder.docs.fiskil.dev#website\",\"name\":\"Fiskil\",\"url\":\"https://holder.docs.fiskil.dev\",\"publisher\":{\"@id\":\"https://holder.docs.fiskil.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule#webpage\",\"url\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule\",\"name\":\"Get Agreed Payment Schedule\",\"description\":\"Obtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this end point: This API describes how the consumer has elected to pay for their account Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\",\"dateModified\":\"2026-10-26T03:44:54.170Z\",\"isPartOf\":{\"@id\":\"https://holder.docs.fiskil.dev#website\"},\"breadcrumb\":{\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Data Sharing\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/banking/get-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Energy\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-energy-accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Agreed Payment Schedule\",\"item\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule#apireference\",\"headline\":\"Get Agreed Payment Schedule\",\"name\":\"Get Agreed Payment Schedule\",\"description\":\"Obtain the agreed payment schedule and details, if any, for a specific energy account. Some general notes about this end point: This API describes how the consumer has elected to pay for their account Payments initiated by the consumer are classified as manual payments. The billing frequency is captured for manual payments. The consumer may choose to pay on a different schedule/frequency. The payment method and frequency is not captured for manual payments Payments that can be initiated by the retailer, based on a consumer's preferences and permission, include payments based on a direct debit, card debit or digital wallet setup. Each of these requires a payment frequency to be provided along with other relevant fields Information about payment plans related to debt repayments or arrangements due to hardship is not captured within this API\",\"url\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule\",\"mainEntityOfPage\":{\"@id\":\"https://holder.docs.fiskil.dev/api-reference/energy/get-agreed-payment-schedule#webpage\"},\"dateModified\":\"2026-10-26T03:44:54.170Z\",\"publisher\":{\"@id\":\"https://holder.docs.fiskil.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://holder.docs.fiskil.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fiskil\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Fiskil","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://www.fiskil.com"},{"anchor":"Support","icon":"headset","href":"https://www.fiskil.com/contact"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/docs/introduction"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"Custom Schema","icon":"book-open","groups":[{"group":"Define your API","pages":[{"title":"Bring Your Own Data","href":"/api-reference/bring-your-own-data"},{"title":"Custom Schema","href":"/api-reference/open-api-definition"}]},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/byo/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/byo/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/byo/auth-customer-details"}]}]},{"dropdown":"CDR","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fiskil/icons/cdr.svg","groups":[{"group":"Intro","pages":[{"title":"Integration Requirements","href":"/api-reference/cdr/integration-requirements"},{"title":"Frequently Asked Questions","href":"/api-reference/cdr/cdr-faqs"},{"title":"Errors","href":"/api-reference/cdr/errors"},{"title":"Non-Functional Requirements","href":"/api-reference/cdr/cdr-nfrs"}]},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/cdr/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/cdr/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/cdr/auth-customer-details"},{"title":"Legacy CDR Consent Flow APIs","tag":"deprecated","href":"/api-reference/cdr/legacy-auth"}]},{"group":"Data Sharing","pages":[{"group":"Banking","pages":[{"title":"Get Accounts","deprecated":true,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts","href":"/api-reference/banking/get-accounts"},{"title":"Fetch specific accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts","href":"/api-reference/banking/fetch-specific-accounts"},{"title":"Get Account Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}","href":"/api-reference/banking/get-account-detail"},{"title":"Get Balances For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/balances","href":"/api-reference/banking/get-balances-for-specific-accounts"},{"title":"Get Account Balance","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/balance","href":"/api-reference/banking/get-account-balance"},{"title":"Get Transactions For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/transactions","href":"/api-reference/banking/get-transactions-for-account"},{"title":"Get Transaction Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/transactions/{transactionId}","href":"/api-reference/banking/get-transaction-detail"},{"title":"Get Direct Debits For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/direct-debits","href":"/api-reference/banking/get-direct-debits-for-account"},{"title":"Get Direct Debits For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/direct-debits","href":"/api-reference/banking/get-direct-debits-for-specific-accounts"},{"title":"Get Scheduled Payments for Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/payments/scheduled","href":"/api-reference/banking/get-scheduled-payments-for-account"},{"title":"Get Scheduled Payments For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/payments/scheduled","href":"/api-reference/banking/get-scheduled-payments-for-specific-accounts"},{"title":"Get Instalment Plans for Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/accounts/{accountId}/payments/plans","href":"/api-reference/banking/get-instalment-plans-for-account"},{"title":"Get Instalment Plans For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/banking/customer/{customerId}/accounts/payments/plans","href":"/api-reference/banking/get-instalment-plans-for-specific-accounts"},{"title":"Get Payees","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/payees","href":"/api-reference/banking/get-payees"},{"title":"Get Payee Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/banking/customer/{customerId}/payees/{payeeId}","href":"/api-reference/banking/get-payee-detail"}]},{"group":"Energy","pages":[{"title":"Get Energy Accounts","deprecated":true,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts","href":"/api-reference/energy/get-energy-accounts"},{"title":"Fetch specific Energy Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts","href":"/api-reference/energy/fetch-specific-energy-accounts"},{"title":"Get Energy Account Detail","description":"Obtain detailed information for a specific energy account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}","href":"/api-reference/energy/get-energy-account-detail"},{"title":"Get Agreed Payment Schedule","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/payment-schedule","href":"/api-reference/energy/get-agreed-payment-schedule"},{"title":"Get Concessions","description":"Obtain the details of any concessions or arrangements applied to a specific energy account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/concessions","href":"/api-reference/energy/get-concessions"},{"title":"Get Balance For Energy Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/balance","href":"/api-reference/energy/get-balance-for-energy-account"},{"title":"Get Balances For Specific Energy Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/balances","href":"/api-reference/energy/get-balances-for-specific-energy-accounts"},{"title":"Get Invoices For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/invoices","href":"/api-reference/energy/get-invoices-for-account"},{"title":"Get Invoices For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/invoices","href":"/api-reference/energy/get-invoices-for-specific-accounts"},{"title":"Get Billing For Account","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/energy/customer/{customerId}/accounts/{accountId}/billing","href":"/api-reference/energy/get-billing-for-account"},{"title":"Get Billing For Specific Accounts","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/energy/customer/{customerId}/accounts/billing","href":"/api-reference/energy/get-billing-for-specific-accounts"}]},{"group":"Common","pages":[{"title":"Get Customer Detail","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml get /v1/common/customer/{customerId}/detail","href":"/api-reference/common/get-customer-detail"},{"title":"Servicepoint Search (AEMO)","deprecated":null,"version":null,"openapi":"/openapi/cdr.yaml post /v1/common/customer/{customerId}/servicepoints/search","href":"/api-reference/common/servicepoint-search-aemo"}]}]},{"group":"Testing CDR","pages":[{"title":"Testing CDR","sidebarTitle":"Overview","href":"/api-reference/cdr/testing/overview"},{"title":"Set up the UAT environment","href":"/api-reference/cdr/testing/uat-environment"},{"title":"Test personas","href":"/api-reference/cdr/testing/test-personas"},{"group":"Test scenarios","pages":[{"title":"Phase 1: Consent authorisation","href":"/api-reference/cdr/testing/consent-authorisation"},{"title":"Phase 2: Data validation","href":"/api-reference/cdr/testing/data-validation"},{"title":"Phase 3: Error validation","href":"/api-reference/cdr/testing/error-validation"},{"title":"Phase 4: Consent dashboard and revocation","href":"/api-reference/cdr/testing/consent-dashboard"}]},{"title":"Report defects and get support","href":"/api-reference/cdr/testing/reporting-defects"}]}]},{"dropdown":"FDX","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fiskil/icons/fdx.svg","pages":[{"title":"Fiskil FDX API","tag":"v1.0.0","href":"/introduction-fdx"},{"group":"Consent Flow","pages":[{"title":"Search Customers by email address","openapi":"openapi/auth.yml POST /auth/v1/customer/search","href":"/api-reference/fdx/auth-customer-search"},{"title":"List accounts available for sharing","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}/accounts","href":"/api-reference/fdx/auth-customer-accounts"},{"title":"Fetch a Customer's identity details","openapi":"openapi/auth.yml GET /auth/v1/customer/{customerId}","href":"/api-reference/fdx/auth-customer-details"}]},{"group":"Data Sharing","pages":[{"group":"Account Information","pages":[{"title":"Fetch specific accounts","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml post /fdx/v6/customer/{customerId}/accounts","href":"/api-reference/account-information/fetch-specific-accounts"},{"title":"Get detailed information for a specific account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}","href":"/api-reference/account-information/get-detailed-information-for-a-specific-account"}]},{"group":"Personal Information","pages":[{"title":"Get an account's contact information","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/contact","href":"/api-reference/personal-information/get-an-accounts-contact-information"}]},{"group":"Payment Networks Information","pages":[{"title":"Get payment networks supported by the account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/payment-networks","href":"/api-reference/payment-networks-information/get-payment-networks-supported-by-the-account"}]},{"group":"Account Transactions","pages":[{"title":"Search for account transactions","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/transactions","href":"/api-reference/account-transactions/search-for-account-transactions"}]},{"group":"Account Statements","pages":[{"title":"Search for statements","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/statements","href":"/api-reference/account-statements/search-for-statements"},{"title":"Get account statement","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/statements/{statementId}","href":"/api-reference/account-statements/get-account-statement"}]},{"group":"Asset Transfer Networks Information","pages":[{"title":"Get asset transfer details for this account","deprecated":null,"version":null,"openapi":"/openapi/fdx.yml get /fdx/v6/customer/{customerId}/accounts/{accountId}/asset-transfer-networks","href":"/api-reference/asset-transfer-networks-information/get-asset-transfer-details-for-this-account"}]}]}]}]},{"tab":"Platform API","pages":[{"title":"Platform API","href":"/platform-api/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get Agreed Payment Schedule - Fiskil","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}