Skip to main content
← OG Developer Resources

Open Gateway API

Biza OG API (OpenAPI Client) (2.1.0)

Download OpenAPI specification:Download

Biza.io: hello@biza.io URL: https://biza.io/ License: Commercial

This is the OpenAPI specification for the Open Gateway

Agreement

APIs related to individual agreements

List Agreements

Retrieve a list of agreements

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

query Parameters
agreementStatus
Array of strings (EnumAgreementCDRSharingStatusV1)
Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED"
Example: agreementStatus=ACTIVE

Filter the agreements by these statuses

revision
string (EnumRevisionTypeV1)
Enum: "LATEST" "ACTIVATED"
Example: revision=LATEST

When there are multiple revisions, only return the most current

CDRArrangementId
string

Unique identifier, shared amongst all revisions of a CDR Sharing arrangement

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Get Agreement Detail

Obtain information about a specific agreement

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Terminate an Agreement

Initiates an agreement termination. As agreements can be many different types this has various meanings. For CDR Sharing Arrangements this triggers the revocation action from the Data Recipient to the Data Holder.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Get Agreement History

Obtain historical information about a specific agreement

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
agreementStatus
Array of strings (EnumAgreementCDRSharingStatusV1)
Items Enum: "PRIMED" "INIT" "ACTIVE" "EXPIRED" "REVOKED"
Example: agreementStatus=ACTIVE

Filter the agreements by these statuses

revision
string (EnumRevisionTypeV1)
Enum: "LATEST" "ACTIVATED"
Example: revision=LATEST

When there are multiple revisions, only return the most current

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Agreement Template

APIs related to agreement templates

List Agreement Templates

Retrieve a list of agreement templates

Authorizations:
TokenBasedAuth
query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Create an Agreement Template

Create a new Agreement Template

Authorizations:
TokenBasedAuth
header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json
required

Request payload for creating a new agreement template

version
required
string

Payload Version

description
required
string

Meaningful agreement template description that explains the purpose of the template, but not shown to consumers.

collection_scopes
required
Array of strings

Mandatory scopes you required from a consumer.

collection_durations
required
Array of strings (EnumAgreementTemplateDuration)
Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M"
collection_purpose
required
string

Describes the purpose behind collection.

use_durations
required
Array of strings (EnumAgreementTemplateDuration)
Items Enum: "P1D" "P1M" "P3M" "P6M" "P12M"
use_purpose
required
string

Describes how/for what the data collected will be used.

direct_marketing_shown
boolean
Default: true

Should the marketing consent be asked for.

allowed_redirect_uris
required
Array of strings

List of valid software product hosts.

data_handling_default
required
string
Enum: "DEIDENTIFY" "DELETE"

A default option for how this software product handles redundant data. This still allows for the user to change how they want the software product to handle redundant data.

agreementEndCallbackUrl
required
string
Default: ""

The POST URL webhook that will be called to post data deletion request with a jwt payload

data_holder_industry
Array of strings (EnumParticipantCapabilityV1)
Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY"

Responses

Request samples

Content type
application/json
Example
{
  • "version": "V1",
  • "description": "Template for basic data sharing",
  • "collection_scopes": [
    ],
  • "collection_durations": [
    ],
  • "collection_purpose": "To allow for the testing of data holder CDR sharing API's",
  • "use_durations": [
    ],
  • "use_purpose": "To allow for the testing of data holder CDR sharing API's",
  • "direct_marketing_shown": true,
  • "allowed_redirect_uris": [],
  • "data_handling_default": "DEIDENTIFY",
  • "agreementEndCallbackUrl": "https://software-product.com.au/data/delete",
  • "data_holder_industry": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "53e14d6c-1af4-4dc3-bd7a-18e7cccc5034"
}

Delete an Agreement Template

Deletes an agreement template with a given id

Authorizations:
TokenBasedAuth
path Parameters
id
required
string <uuid>

Unique Agreement Template Identifier

header Parameters
x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

CDR: Actions

Actions to be executed against CDR based participants

Prime a CDR Sharing Arrangement (V1)

Prime a CDR Sharing Agreement

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json

Request payload for a priming a CDR Sharing agreement

version
required
string

Payload Version

required
object (AgreementPrimeCDRSharingRequestV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json
{}

CDR: Banking

APIs reflecting those made available via the Consumer Data Right for the Banking sector

Get Accounts

Obtain a list of accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.

open-status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.

is-owned
boolean

Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Account Detail

Obtain detailed information on a single account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V3",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Account Balance

Obtain the balance for a single specified account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Scheduled Payments for Account

Obtain scheduled, outgoing payments for a specific account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Direct Debits For Account

Obtain direct debit authorisations for a specific account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Transactions For Account

Obtain transactions for a specific account. Some general notes that apply to all end points that retrieve transactions:

  • Where multiple transactions are returned, transactions should be ordered according to effective date in descending order
  • As the date and time for a transaction can alter depending on status and transaction type two separate date/times are included in the payload. There are still some scenarios where neither of these time stamps is available. For the purpose of filtering and ordering it is expected that the data holder will use the "effective" date/time which will be defined as:
    • Posted date/time if available, then
    • Execution date/time if available, then
    • A reasonable date/time nominated by the data holder using internal data structures
  • For transaction amounts it should be assumed that a negative value indicates a reduction of the available balance on the account while a positive value indicates an increase in the available balance on the account
  • For aggregated transactions (ie. groups of sub transactions reported as a single entry for the account) only the aggregated information, with as much consistent information across the subsidiary transactions as possible, is required to be shared
Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

min-amount
string

Filter transactions to only transactions with amounts higher than or equal to this amount.

max-amount
string

Filter transactions to only transactions with amounts less than or equal to this amount.

text
string

Filter transactions to only transactions where this string value is found as a substring of either the reference or description fields. Format is arbitrary ASCII string. This parameter is optionally implemented by data holders. If it is not implemented then a response should be provided as normal without text filtering applied and an additional boolean field named isQueryParamUnsupported should be included in the meta object and set to true (whether the text parameter is supplied or not)

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Transaction Detail

Obtain detailed information on a transaction for a specific account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

transactionId
required
string

ID of the transaction obtained from a previous call to one of the other transaction endpoints.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Instalment Plans for Account

Obtain the active and/or inactive instalment plans for a specific account. The plans returned MUST be ordered according to plan creationDate in descending order.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
plan-status
string (EnumBankingInstalmentPlanStatusV1)
Default: "ACTIVE"
Enum: "ACTIVE" "INACTIVE" "ALL"

Used to filter results on the status field. Values can be ACTIVE, INACTIVE or ALL. If absent then ACTIVE is assumed. An ACTIVE plan is one in which one or more scheduled instalments has not yet been paid (i.e. isPaid is false). An INACTIVE plan is one in which all scheduled instalments have been paid (i.e. isPaid is true for every entry in the schedule).

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

Get Instalment Plans Bulk

Obtain the active and/or inactive instalment plans across all accounts the customer has authorised access to. The plans returned MUST be ordered according to plan creationDate in descending order.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
plan-status
string (EnumBankingInstalmentPlanStatusV1)
Default: "ACTIVE"
Enum: "ACTIVE" "INACTIVE" "ALL"

Used to filter results on the status field. Values can be ACTIVE, INACTIVE or ALL. If absent then ACTIVE is assumed. An ACTIVE plan is one in which one or more scheduled instalments has not yet been paid (i.e. isPaid is false). An INACTIVE plan is one in which all scheduled instalments have been paid (i.e. isPaid is true for every entry in the schedule).

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

Get Payees

Obtain a list of pre-registered payees

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
type
string
Default: "ALL"
Enum: "ALL" "BILLER" "DIGITAL_WALLET" "DOMESTIC" "INTERNATIONAL"

Filter on the payee type field. In addition to normal type field values, ALL can be specified to retrieve all payees. If absent the assumed value is ALL.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Payee Detail

Obtain detailed information on a single payee. Note that the payee sub-structure should be selected to represent the payment destination only rather than any known characteristics of the payment recipient

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

payeeId
required
string

The ID used to locate the details of a particular payee.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Scheduled Payments Bulk

Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.

open-status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.

is-owned
boolean

Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Scheduled Payments For Specific Accounts

Obtain scheduled payments for a specified list of accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Bulk Direct Debits

Obtain direct debit authorisations for multiple, filtered accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.

open-status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.

is-owned
boolean

Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Direct Debits For Specific Accounts

Obtain direct debit authorisations for a specified list of accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
Example
{}

Get Bulk Balances

Obtain balances for multiple, filtered accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.

open-status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.

is-owned
boolean

Filters accounts based on whether they are owned by the authorised customer. true for owned accounts, false for unowned accounts and absent for all accounts.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Balances For Specific Banking Accounts

Obtain balances for a specified list of accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
Example
{}

CDR: Common

Common APIs made available within the Consumer Data Right

Get Customer

Obtain basic information on the customer that has authorised the current session. Conventions In the customer payloads relevant conventions are explained here, in one place. Given Names firstName represents the first of a person's given names middleNames represents a collection of given names if the person has more than one given name Where a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the firstName field to return the single string of given names and an empty middleNames array. For example, a person whose given names are "John Paul Winston" but the data holder cannot determine what is the first name, can return "firstName": "John Paul Winston".

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Customer Detail

Obtain detailed information on the authorised customer within the current session.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

CDR: Energy

APIs reflecting those made available via the Consumer Data Right for the Energy sector

Get Energy Accounts

Obtain the list of energy accounts available under the authorised consent

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
open-status
string (EnumAccountOpenStatusWithAllV1)
Default: "ALL"
Enum: "ALL" "CLOSED" "OPEN"

Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

Get Energy Account Detail

Obtain detailed information for a specific energy account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V2",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Energy Account Payment Schedule

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

Some general notes about this endpoint:

  • 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
Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Energy Account Concessions

Obtain the details of any concessions or arrangements applied to a specific energy account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Balance For Energy Account

Obtain the current balance for a specific energy account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Billing for Energy Account

Obtain the billing transactions for a specific account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Energy Account Invoices

Obtain the invoices for a specific account

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

accountId
required
string

ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List endpoint.

query Parameters
oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Bulk Invoices

Obtain the invoices for all accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Invoices For Specific Energy Accounts

Obtain invoices for a specified set of energy accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Bulk Billing

Obtain billing transactions for all accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Billing for Specific Energy Accounts

Obtain billing for a specified set of accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
oldest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or after this date/time. Format is aligned to DateTimeString common type.

If absent defaults to the following dependent on call:

  • Banking: newest-time minus 90 days
  • Energy: newest-time minus 12 months
newest-time
string <date-time>

Constrain the transaction history request to transactions with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Bulk Balances for Energy

Obtain the current balance for all energy accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

Get Balances For Specific Energy Accounts

Obtain the current balances for a specified list of energy accounts

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Accounts to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{}

Get Electricity Service Points

Obtain a list of service points owned by the customer that has authorised the current session

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{}

Get Bulk DER

Obtain DER data for all service points associated with the customer

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get DER For Specific Service Points

Obtain DER data for a specific set of service points

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Service Points to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Bulk Service Point Usage

Obtain usage data for all service points associated with the customer

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
interval-reads
string (EnumElectricityMeterReadIntervalReadTypeV1)
Default: "NONE"
Enum: "NONE" "MIN_30" "FULL"
Example: interval-reads=NONE

Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE

oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

Get Usage For Specific Service Points

Obtain the electricity usage data for a specific set of service points

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

query Parameters
oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

interval-reads
string (EnumElectricityMeterReadIntervalReadTypeV1)
Default: "NONE"
Enum: "NONE" "MIN_30" "FULL"
Example: interval-reads=NONE

Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Request Body schema: application/json
required

Request payload containing list of specific Service Points to obtain data for

required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/json
{}

Get Electricity Service Point Detail

Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

servicePointId
required
string

ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get DER For Electricity Service Point

Obtain a list of DER data from a particular service point

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

servicePointId
required
string

ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId.

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Usage For Electricity Service Point

Obtain a list of electricity usage data from a particular service point

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

servicePointId
required
string

ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data endpoint. Note that it is not a nationalMeteringId.

query Parameters
oldest-date
string <date>

Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type

newest-date
string <date>

Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type

interval-reads
string (EnumElectricityMeterReadIntervalReadTypeV1)
Default: "NONE"
Enum: "NONE" "MIN_30" "FULL"
Example: interval-reads=NONE

Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{}

CDR: Public

Publicly available APIs made available within the Consumer Data Right

Get Banking Products

Obtain a list of products that are currently openly offered to the market Will be implemented in a future release. See Biza Developer guides for future plans.

Note that the results returned by this end point are expected to be ordered in descending order according to lastUpdated

Conventions

In the product reference payloads there are a number of recurring conventions that are explained here, in one place.

Arrays Of Features

In the product detail payload there are a number of arrays articulating generic features, constraints, prices, etc. The intent of these arrays is as follows:

  • Each element in an array has the same structure so that clients can reliably interpret the payloads
  • Each element as a type element that is an enumeration of the specific aspect of a product being described, such as types of fees.
  • Each element has a field name additionalValue. This is a generic field with contents that will vary based on the type of object being described. The contents of this field for the ADDITIONAL_CARDS feature is the number of cards allowed while the contents of this field for the MAX_LIMIT constraint would be the maximum credit limit allowed for the product.
  • An element in these arrays of the same type may appear more than once. For instance, a product may offer two separate loyalty programs that the customer can select from. A fixed term mortgage may have different rates for different term lengths.
  • An element in these arrays may contain an additionalInfo and additionalInfoUri field. The additionalInfo field is used to provide displayable text clarifying the purpose of the element in some way when the product is presented to a customer. The additionalInfoUri provides a link to externally hosted information specifically relevant to that feature of the product.
  • Depending on the type of data being represented there may be additional specific fields.

URIs To More Information

As the complexities and nuances of a financial product can not easily be fully expressed in a data structure without a high degree of complexity it is necessary to provide additional reference information that a potential customer can access so that they are fully informed of the features and implications of the product. The payloads for product reference therefore contain numerous fields that are provided to allow the product holder to describe the product more fully using a web page hosted on their online channels.

These URIs do not need to all link to different pages. If desired, they can all link to a single hosted page and use difference HTML anchors to focus on a specific topic such as eligibility or fees.

Linkage To Accounts

From the moment that a customer applies for a product and an account is created the account and the product that spawned it will diverge. Rates and features of the product may change and a discount may be negotiated for the account.

For this reason, while productCategory is a common field between accounts and products, there is no specific ID that can be used to link an account to a product within the regime.

Similarly, many of the fields and objects in the product payload will appear in the account detail payload but the structures and semantics are not identical as one refers to a product that can potentially be originated and one refers to an account that actual has been instantiated and created along with the associated decisions inherent in that process.

Dates

It is expected that data consumers needing this data will call relatively frequently to ensure the data they have is representative of the current offering from a bank. To minimise the volume and frequency of these calls the ability to set a lastUpdated field with the date and time of the last update to this product is included. A call for a list of products can then be filtered to only return products that have been updated since the last time that data was obtained using the updated-since query parameter.

In addition, the concept of effective date and time has also been included. This allows for a product to be marked for obsolescence, or introduction, from a certain time without the need for an update to show that a product has been changed. The inclusion of these dates also removes the need to represent deleted products in the payload. Products that are no long offered can be marked not effective for a few weeks before they are then removed from the product set as an option entirely.

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

query Parameters
effective
string (EnumEffectiveWithAllV1)
Default: "CURRENT"
Enum: "ALL" "CURRENT" "FUTURE"
Example: effective=CURRENT

Allows for the filtering of results based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT'

updated-since
string <date-time>

Only include items that have been updated after the specified date and time. If absent defaults to include all items.

brand
string

Filter results based on a specific brand. If absent defaults to include all plans.

product-category
string (EnumBankingProductCategoryV2)
Enum: "BUSINESS_LOANS" "BUY_NOW_PAY_LATER" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRANS_AND_SAVINGS_ACCOUNTS" "TRAVEL_CARDS"
Example: product-category=TRANS_AND_SAVINGS_ACCOUNTS

Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{}

Get Banking Product Detail

Obtain detailed information on a single product offered openly to the market. Will be implemented in a future release. See Biza Developer guides for future plans.

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

productId
required
string

ID of the specific product requested

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V3",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Outages

Obtain a list of scheduled outages for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

Get Status

Obtain a health check status for the implementation. Will be implemented in a future release. See Biza Developer guides for future plans.

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": { },
  • "validationErrors": [
    ],
  • "data": {
    }
}

DCR

APIs related to Dynamic Client Registration

Dynamic Client Registration

Perform a Dynamic Client Registration for a specified participant contained within a specified directory

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json

Request payload for a Dynamic Client Registration

version
required
string

Payload Version

required
object (ActionCDRRegistrationV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json
{}

Get a Client Registration

Get a Client Registration for a specified participant contained within a specified directory

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

clientId
required
string

Unique Client Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{}

Update a Client Registration

Update a Dynamic Client Registration for a specified participant contained within a specified directory

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

clientId
required
string

Unique Client Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json

Request payload for a Dynamic Client Registration

version
required
string

Payload Version

required
object (ActionCDRRegistrationV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json
{}

Delete a Client Registration

Delete a Client Registration for a specified participant contained within a specified directory

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

clientId
required
string

Unique Client Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Directory

APIs related to directory availability and participants

List Directories

Retrieve a list of directories available

Authorizations:
TokenBasedAuth
query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "meta": {
    },
  • "data": {
    }
}

List Participants

Obtain a collated list of participants available

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

query Parameters
capabilities
Array of strings (EnumParticipantCapabilityV2)
Items Enum: "CDS_AU_DATA_SHARING_BANKING" "CDS_AU_DATA_SHARING_ENERGY" "CDS_AU_DATA_SHARING_TELCO" "CDS_AU_PRD_BANKING" "CDS_AU_PLAN_ENERGY" "CDS_AU_DATA_SHARING_NON_BANK_LENDING" "CDS_AU_PRD_NON_BANK_LENDING"
Example: capabilities=CDS_AU_DATA_SHARING_BANKING

Filter the participants by these capabilities

page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
Example
{
  • "version": "V1",
  • "meta": {
    },
  • "data": {
    }
}

DR+ Energy Account Switch

DR+ Energy Account Switch Apis

Get Energy Switch Status

Retrieve the status of an Energy Account Switch

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

switchId
required
string

Global unique identifier of an energy switch

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{}

List Energy Switches

Endpoint to list energy account switch actions

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{}

Get Energy Switch Request

Retrieve an Energy Account Switch request

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

actionId
required
string

Global unique identifier of an action

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    },
  • "meta": {
    }
}

Initiate Energy Switch

Endpoint to initiate an energy account opening via the DataRight+ framework

Authorizations:
TokenBasedAuth
path Parameters
directoryId
required
string <uuid>

Unique Directory Identifier

participantId
required
string <uuid>

Unique Participant Identifier

header Parameters
x-v
required
string (EnumRequestInitiateEnergySwitchV1)
Value: "V1"
Example: V1

Supported Request Version

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json
required

Initiate Energy Account Switch

version
required
string

Payload Version

required
object (RequestInitiateEnergySwitchDataV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    },
  • "meta": {
    }
}

DR+ Data Sharing

DR+ Data Sharing Apis

Get Sharing Request

Retrieve the status of Arrangement V2

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

agreementId
required
string <uuid>

Unique Agreement Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

x-fapi-auth-date
string
Example: Thu, 16 Jan 2020 16:50:15 GMT

The time when the customer last logged in to the Data Recipient Software Product as described in FAPI-1.0-Baseline. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.

x-fapi-customer-ip-address
string
Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

The customer's original IP address if the customer is currently logged in to the Data Recipient Software Product. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.

x-cds-client-headers
string
Example: TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY=

The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the Data Recipient Software Product. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Responses

Response samples

Content type
application/json
{
  • "version": "V2",
  • "data": {
    },
  • "meta": {
    }
}

Illion

Illion Credit Report APIs

List Credit Reports

List Illion credit report(s) for a given principal.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Create Credit Report

Creates an Illion credit report for a given principal.

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Request Body schema: application/json

Request payload for Create Credit report

version
required
string

Payload Version

required
object (CreateIllionCreditReportV1)

Responses

Request samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

Response samples

Content type
application/json

Get Credit Report By Id

Get an Illion credit report by id, for a given principal

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

reportId
required
string <uuid>

Unique Credit Report Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Principal

APIs related to specific principals

List Principals

Retrieve a list of principals

Authorizations:
TokenBasedAuth
query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{}

Get Principal Detail

Obtain information about a specific principal

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{
  • "version": "V1",
  • "data": {
    }
}

List Principal Users

Obtain a list of users for a specific principal

Authorizations:
TokenBasedAuth
path Parameters
principalId
required
string

Unique Principal Identifier

query Parameters
page
integer >= 1
Default: 1

Page of results to request (standard pagination).

page-size
integer >= 1
Default: 25

Page size to request. Default is 25 (standard pagination).

header Parameters
x-v
required
string

Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers

x-min-v
string

Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable.

x-fapi-interaction-id
string <uuid>
Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8

An RFC4122 UUID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a RFC4122 UUID value is required to be provided in the response header to track the interaction.

Responses

Response samples

Content type
application/json
{}

Callback

APIs that OG calls back to reach out to software products

CDR end of life

CDR end of life callback. This is the endpoint OG calls to let the software product do any CDR end of life activities. Example - data deletion.

Software product MUST verify the JWT signature before using it.

OG's JWKS URL - https://<OG_PUBLIC_URI>/<Software Product id>/jwks

Request Body schema: application/jwt
required

JWT signed by OG with claims required to complete any CDR arrangement end of life activities. Claims include

  • iss - Issuer
  • aud - Audience - Software product
  • nbf - Token activation time
  • iat - Token issued time
  • exp - Token expiry - 60 seconds from the issued time
  • cdrArrangementId - arrangement id recognised in the CDR eco-system
  • interactionId - unique id sent by OG, which can be used by the software products to dedupe requests from OG
  • principalId - Principal Id of the User/Client
  • softwareProductId - Unique Id of the Software product
string <JWT>

Responses