Adapter API (Secure)
HaaS Data Adapter API Secure (OpenAPI Client) (2.4.0)
Download OpenAPI specification:Download
This is the OpenAPI specification consumed by the HaaS Data Adapter Client for Authenticated endpoints and corresponds to CDS version 1.36.0.1. Please consult the appropriate implementation guides to identify which ones must be implemented for your scenario.
This contains the APIs related to the retrieval of information related to the Common namespace within the Data Standards
Get User
Essentially a simplified GetCustomer call. To be used as a replacement for GetCustomer in the Consent Flow. Also used in the Consent Management Dashboard as a way of knowing about the Power of Attorney situations that may exist.
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetUserVersion) Enum: "V0" "V1" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
Request Body schema: application/jsonrequired
Get User Request
| version | string Default: "V0" |
| userId required | string <= 512 characters The internal user ID of the user. This should be an ID that doesn't change over the life of the user. |
| principalId required | string <= 512 characters The internal identifier of the entity being shared via CDR. It is the ID that will be supplied to the data sharing calls for customer details, listing accounts, etc. |
Responses
Request samples
- Payload
{- "version": "V0",
- "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567",
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355"
}Response samples
- 200
- 400
- 404
- 422
- 451
{- "version": "V0",
- "principalName": "Doe Pty Ltd",
- "customerUType": "person",
- "name": "First Last",
- "lastName": "Last",
- "firstName": "First",
- "updatedAt": "2018-11-13T20:20:39+00:00",
- "role": "Chief Financial Officer",
- "vulnerable": false,
- "authorityToOperate": [
- {
- "principalId": "ad383b27-22d5-4da8-beb8-2fcf65029f0d",
- "userId": "4e9cfa0b-5790-41de-8fbe-7e4caec817af",
- "type": "POWER_OF_ATTORNEY"
}
]
}Get Customer
Retrieve a specific customer based on identifier
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetCustomerVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 404
- 451
{- "version": "V0",
- "data": {
- "id": "164063905f23916d5ebe671b7f89ebaa083b7e9125b2d3ae6be2a10e3cb3ba22",
- "customerType": "PERSON",
- "organisation": {
- "name": "Acme Pty Ltd",
- "tradingName": "string",
- "abn": "string",
- "acn": "string",
- "agentFirstName": "string",
- "agentLastName": "Doe",
- "agentRole": "Unspecified",
- "establishmentDate": "2019-08-24",
- "industryCode": "string",
- "acncRegistered": true,
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "legalName": "string",
- "organisationType": "COMPANY",
- "registeredCountry": "AUS",
- "physicalAddresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}, - "purpose": "MAIL"
}
]
}, - "person": {
- "firstName": "string",
- "lastName": "Doe",
- "lastUpdateTime": "2019-08-24T14:15:22Z",
- "middleNames": [ ],
- "occupationCode": "string",
- "prefix": "string",
- "suffix": "string",
- "emailAddresses": [
- {
- "address": "john@doe.com",
- "isPreferred": true,
- "purpose": "HOME"
}
], - "phoneNumbers": [ ],
- "physicalAddresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}, - "purpose": "MAIL"
}
]
}
}
}This contains the APIs related to the retrieval of information related to the Banking namespace within the Data Standards
Request Banking Transaction Detail List
Request Banking Transaction Detail List through an Asynchronous request
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v required | string (EnumResponseRequestBankingTransactionDetailListVersion) Value: "V1" Example: V1 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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/jsonrequired
Request Banking Transaction Detail list
| version required | string Default: "V1" |
required | object (RequestBankingTransactionDetailListDataV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "userId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "accountIds": [
- "7b2604da-0810-4ad4-8c74-7ce0487ed26e",
- "67d542f5-e0ec-4df5-821e-4dbf02c4403f"
], - "oldestTime": "2023-07-01T15:43:00.123456Z",
- "newestTime": "2024-06-30T15:43:00.123456Z",
- "minAmount": "string",
- "maxAmount": "string"
}
}Response samples
- 200
- 400
- 404
- 422
- 451
{- "version": "V1",
- "data": {
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "userId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "accountIds": [
- "7b2604da-0810-4ad4-8c74-7ce0487ed26e",
- "67d542f5-e0ec-4df5-821e-4dbf02c4403f"
], - "oldestTime": "2023-07-01T15:43:00.123456Z",
- "newestTime": "2024-06-30T15:43:00.123456Z",
- "minAmount": "string",
- "maxAmount": "string"
}, - "meta": {
- "actionId": "9fe3f97e-c22c-4516-b6ed-05c0486db195",
- "status": "PROCESSING",
- "statusDescription": "Job Received, contacting internal systems to formulate response.",
- "creationDateTime": "2024-02-31T08:14:25Z",
- "lastUpdated": "2024-08-31T08:14:25Z"
}
}Get Banking Transaction Detail List Status
Retrieve banking transaction detail action status
Authorizations:
path Parameters
| actionId required | string Example: a3d7bcf7-fea4-45a4-b350-ab4c56d47f83 Global unique identifier of an action |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v required | string (EnumResponseGetBankingTransactionDetailListStatusVersion) Value: "V1" Example: V1 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 422
- 451
{- "version": "V1",
- "data": {
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "userId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "accountIds": [
- "7b2604da-0810-4ad4-8c74-7ce0487ed26e",
- "67d542f5-e0ec-4df5-821e-4dbf02c4403f"
], - "oldestTime": "2023-07-01T15:43:00.123456Z",
- "newestTime": "2024-06-30T15:43:00.123456Z",
- "minAmount": "string",
- "maxAmount": "string"
}, - "meta": {
- "actionId": "9fe3f97e-c22c-4516-b6ed-05c0486db195",
- "status": "PROCESSING",
- "statusDescription": "Job Received, contacting internal systems to formulate response.",
- "creationDateTime": "2024-02-31T08:14:25Z",
- "lastUpdated": "2024-08-31T08:14:25Z"
}
}Retrieve Banking Transaction Detail List
Retrieve banking transaction detail records
Authorizations:
path Parameters
| actionId required | string Example: a3d7bcf7-fea4-45a4-b350-ab4c56d47f83 Global unique identifier of an action |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v required | string (EnumResponseRetrieveBankingTransactionDetailListVersionV3) Enum: "V1" "V2" "V3" Example: V1 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 422
- 451
{- "version": "V1",
- "data": [
- {
- "id": "964e06a838a236f3883cb5b19369ddcf63f95f746f7f4035b7d1f67063800298",
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "amount": 55.66,
- "amountType": "PAYMENT",
- "currency": "AUD",
- "description": "Payment for furniture accessories",
- "reference": "",
- "status": "POSTED",
- "executionDateTime": "2019-08-24T14:15:22Z",
- "postingDateTime": "2019-08-24T14:15:22Z",
- "valueDateTime": "2019-08-24T14:15:22Z",
- "transactionType": "BPAY",
- "bpay": {
- "billerCode": "string",
- "billerName": "string",
- "crn": "string"
}, - "creditCard": {
- "merchantCategoryCode": "5021",
- "merchantName": "Freedom Furniture"
}, - "directDeposit": {
- "bsb": "999999"
}, - "x2p101": {
- "payee": "string",
- "payer": "string",
- "endToEndId": "string",
- "extendedDescription": "An extended description about the X2P1.01 payment",
- "purposeCode": "string"
}
}
], - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}List Payees
Retrieve a list of payees for a specific customer identifier
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListBankingPayeesVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 404
- 451
{- "version": "V0",
- "data": [
- {
- "id": "9c13b416c0eea9b8e11643842bbfe4342e49c22c2e62c4eb9fc812b6a6a70aba",
- "creationDate": "2019-08-24",
- "description": "string",
- "nickname": "Jeff Johnson",
- "payeeType": "DOMESTIC",
- "bpay": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": "100 Wiltock Place, London, GB",
- "name": "ACME Bank"
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "digitalWallet": {
- "name": "My Digital Wallet",
- "identifier": "user@digital.wallet.com",
- "type": "EMAIL",
- "provider": "OTHER"
}
}
]
}List Payments
Retrieve a list of payments for a specific customer
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListBankingPaymentsVersion) Enum: "V0" "V1" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 404
- 451
{- "version": "V0",
- "data": [
- {
- "id": "93612111d3c4a52a54c97cf0177542ff317f779ea675db01c9b172ed40f8fdf9",
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "paymentType": "DIRECT_DEBIT",
- "directDebit": {
- "authorisedEntity": {
- "abn": "54 624 797 655",
- "acn": "624 797 655",
- "arbn": "000 000 123",
- "description": "Biza Pty Ltd",
- "financialInstitution": "ACME Bank"
}, - "lastDebitAmount": 0,
- "lastDebitDateTime": "2019-08-24T14:15:22Z"
}, - "scheduledPayment": {
- "from": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay"
}, - "nickname": "string",
- "payeeReference": "Payment for Football Membership",
- "payerReference": "Payment for Football Membership",
- "paymentSet": [
- {
- "amount": "151.33",
- "currency": "string",
- "isAmountCalculated": true,
- "to": {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "biller": {
- "billerCode": "12345",
- "billerName": "BPAY Electricity Co",
- "crn": "XXXXXXXXXXXX1234"
}, - "domestic": {
- "account": {
- "accountName": "Woolie Jumpers Shop",
- "accountNumber": "1234123423",
- "bsb": "123-123"
}, - "card": {
- "cardNumber": "XXXX-XXXX-XXXX-1234"
}, - "payId": {
- "identifier": "hello@biza.io",
- "name": "Biza Pty Ltd",
- "type": "EMAIL"
}, - "payeeAccountUType": "payId"
}, - "international": {
- "bankDetails": {
- "accountNumber": "12341234",
- "bankAddress": {
- "address": null,
- "name": null
}, - "beneficiaryBankBIC": "ACMEAUSYHOM",
- "chipNumber": "12341234",
- "country": "AUS",
- "fedWireNumber": "12939281",
- "legalEntityIdentifier": "549300TGFLH2QZV80T70",
- "routingNumber": "18281828",
- "sortCode": "01"
}, - "beneficiaryDetails": {
- "country": "AUS",
- "message": "Payment Received",
- "name": "Woolie Jumpers International"
}
}, - "payeeId": "8a0e108e03d1b05f049d4bd4f612e314517bb967fa907b76029e17b6f42d2131",
- "nickname": "John Doe",
- "payeeReference": "Dinner Payback",
- "toUType": "domestic"
}
}
], - "recurrence": {
- "eventBased": {
- "description": "Overdraw Charge"
}, - "intervalSchedule": {
- "finalPaymentDate": "2023-05-01",
- "intervals": [
- {
- "dayInInterval": "P1D",
- "interval": "P5D"
}
], - "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "lastWeekDay": {
- "finalPaymentDate": "2023-05-01",
- "interval": "P1D",
- "lastWeekDay": "MON",
- "nonBusinessDayTreatment": "ON",
- "paymentsRemaining": 1
}, - "nextPaymentDate": "2022-09-13",
- "onceOff": {
- "paymentDate": "2022-08-11"
}, - "recurrenceUType": "intervalSchedule"
}, - "status": "ACTIVE"
}
}
]
}List Banking Accounts
Retrieve a list of accounts for a specific customer based on identifier
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| accountIds | Array of strings Filter results based on a set of account identifiers |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListBankingAccountsVersionV3) Enum: "V0" "V1" "V2" "V3" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 451
{- "version": "V0",
- "data": [
- {
- "id": "28d05b54b88d191b04fa44b47a0afa8b83a34c8987dc76d21cb2c36b907f265c",
- "internalId": "string",
- "accountCustomers": [
- {
- "customerId": "string",
- "principalId": "string",
- "userId": "string",
- "owner": false,
- "relationship": "OWNER",
- "vulnerable": true
}
], - "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productName": "ACME Savings Maximiser",
- "bundleName": "Great Bundle Savings",
- "creationDate": "2019-08-24",
- "displayName": "ACME Savings Account",
- "nickname": "Holiday Fund",
- "status": "OPEN",
- "bsb": 999999,
- "accountNumber": "1231234",
- "balances": [
- {
- "currentBalance": 16.88,
- "availableBalance": 11.45,
- "creditLimit": 0,
- "amortisedLimit": 0,
- "currency": "string"
}
], - "addresses": [
- {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS",
- "isActivated": true
}
], - "depositRate": 0.02,
- "depositRates": [
- {
- "additionalInfo": "A great deposit rate",
- "additionalValue": "Type specific value, see docs",
- "applicationFrequency": "P30D",
- "calculationFrequency": "P1D",
- "depositRateType": "FIXED",
- "rate": 0.02,
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
], - "fees": [
- {
- "accrualFrequency": "P1D",
- "accruedRate": 0.02,
- "additionalInfo": "Additional Fee Information",
- "additionalValue": "Type specific value, see docs",
- "amount": 10.01,
- "balanceRate": 0.023,
- "currency": "AUD",
- "discounts": [
- {
- "accruedRate": 0.012,
- "additionalInfo": "Discount Information",
- "additionalValue": "Type specific value, see docs",
- "amount": 29,
- "balanceRate": 0.012,
- "description": "A discount applied to valued customers",
- "discountType": "BALANCE",
- "eligibility": [
- {
- "additionalInfo": "Eligibility criteria explanation",
- "additionalValue": "Type specific value, see docs",
- "discountEligibilityType": "BUSINESS"
}
], - "feeRate": 0.012,
- "transactionRate": 0.012
}
], - "feeType": "EXIT",
- "name": "Fee Name",
- "transactionRate": 0.0023
}
], - "lendingRate": 0.02,
- "lendingRates": [
- {
- "additionalInfo": "string",
- "additionalValue": "string",
- "applicationFrequency": "string",
- "calculationFrequency": "string",
- "comparisonRate": 0.02,
- "interestPaymentDue": "IN_ARREARS",
- "lendingRateType": "FIXED",
- "loanPurpose": "OWNER_OCCUPIED",
- "rate": 0.02,
- "repaymentType": "PRINCIPAL_AND_INTEREST",
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
], - "accountType": "LOAN",
- "creditCard": {
- "minPaymentAmount": "10.00",
- "paymentCurrency": "AUD",
- "paymentDueAmount": "10.00",
- "paymentDueDate": "2022-05-01"
}, - "loan": {
- "loanEndDate": "2035-06-01",
- "maxRedraw": "1000.00",
- "maxRedrawCurrency": "AUD",
- "minInstalmentAmount": "122.22",
- "minInstalmentCurrency": "AUD",
- "minRedraw": "500.00",
- "minRedrawCurrency": "AUD",
- "nextInstalmentDate": "2022-10-02",
- "offsetAccountEnabled": false,
- "offsetAccountIds": [
- "string"
], - "originalLoanAmount": "526000.00",
- "originalLoanCurrency": "AUD",
- "originalStartDate": "2021-06-01",
- "repaymentFrequency": "P1M",
- "repaymentType": "PRINCIPAL_AND_INTEREST"
}, - "termDeposit": [
- {
- "lodgementDate": "2022-01-01",
- "maturityAmount": "string",
- "maturityCurrency": "string",
- "maturityDate": "2024-01-01",
- "maturityInstructions": "PAID_OUT_AT_MATURITY"
}
], - "jointAccountSharingStatus": "PRE_APPROVAL"
}
]
}List Banking Transactions
Retrieve a list of transactions based on customer and account identifiers. 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
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
| accountId required | string Unique Account Identifier |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| transactionIds | Array of strings Filter results based on a set of transaction identifiers |
| 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:
|
| 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 |
| 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-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListBankingTransactionsVersionV3) Enum: "V0" "V1" "V2" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 422
- 451
{- "version": "V0",
- "data": [
- {
- "id": "964e06a838a236f3883cb5b19369ddcf63f95f746f7f4035b7d1f67063800298",
- "amount": 55.66,
- "amountType": "PAYMENT",
- "currency": "AUD",
- "description": "Payment for furniture accessories",
- "reference": "",
- "status": "POSTED",
- "executionDateTime": "2019-08-24T14:15:22Z",
- "postingDateTime": "2019-08-24T14:15:22Z",
- "valueDateTime": "2019-08-24T14:15:22Z",
- "transactionType": "BPAY",
- "bpay": {
- "billerCode": "string",
- "billerName": "string",
- "crn": "string"
}, - "creditCard": {
- "merchantCategoryCode": "5021",
- "merchantName": "Freedom Furniture"
}, - "directDeposit": {
- "bsb": "999999"
}, - "x2p101": {
- "payee": "string",
- "payer": "string",
- "endToEndId": "string",
- "extendedDescription": "An extended description about the X2P1.01 payment",
- "purposeCode": "string"
}
}
], - "meta": {
- "totalPages": 1,
- "totalRecords": 10,
- "isQueryParamUnsupported": true
}
}List Banking Instalment Plans
Retrieve Banking Instalment Plans for a list of accounts authorised for the principal. The list of accounts to fetch plans for is supplied in the request body, allowing HaaS to act as the gatekeeper of authorised accounts and to retrieve all plans across the supplied accounts in a single call.
Filtering parameters from the upstream CDR Banking Instalment Plan
endpoints (plan-status, page, page-size) are mirrored through to
the data adapter via the request body.
Response data MUST be ordered according to plan creationDate in descending order.
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v required | string (EnumResponseListBankingInstalmentPlansVersion) Value: "V1" Example: V1 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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/jsonrequired
Request to list Banking Instalment Plans for a set of accounts
| version required | string Default: "V1" |
required | object (RequestListBankingInstalmentPlansDataV1) |
Responses
Request samples
- Payload
{- "version": "V1",
- "data": {
- "userId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "accountIds": [
- "7b2604da-0810-4ad4-8c74-7ce0487ed26e",
- "67d542f5-e0ec-4df5-821e-4dbf02c4403f"
], - "planStatus": "ACTIVE",
- "page": 1,
- "pageSize": 25
}
}Response samples
- 200
- 400
- 404
- 422
- 451
{- "version": "V1",
- "data": [
- {
- "accountId": "string",
- "planId": "5ce4408d-3a6c-4d2c-b51a-cebde6b21e4e",
- "planReference": "ORD-998832",
- "merchantName": "ACME Retail",
- "merchantCategoryCode": "5311",
- "planNickname": "New TV",
- "creationDate": "2026-11-15",
- "amount": "100.00",
- "planCurrency": "AUD",
- "planCharge": "5.00",
- "planRate": "0.10",
- "duration": "P6W",
- "instalmentInterval": "P2W",
- "schedule": [
- {
- "amountDue": "25.00",
- "dueDate": "2026-12-15",
- "isPaid": false
}
]
}
], - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}This contains the APIs related to the retrieval of information related to the Energy namespace within the Data Standards
List Energy Accounts
Retrieve a list of energy accounts for a specified principal
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| accountIds | Array of strings Filter results based on a set of account identifiers |
| 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 |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListEnergyAccountsVersionV2) Enum: "V1" "V2" Example: V2 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 451
{- "version": "V0",
- "data": [
- {
- "accountId": "5bbdb5d20e474ee2f10ecd08deca1b16c89f0eaa94e69167c2475b417db7ec58",
- "accountNumber": "12981837",
- "accountCustomers": [
- {
- "userId": "5bbdb5d20e474ee2f10ecd08deca1b16c89f0eaa94e69167c2475b417db7ec58",
- "relationship": "OWNER",
- "vulnerable": true
}
], - "accountAddress": {
- "addressUType": "simple",
- "paf": {
- "buildingName1": "CAPITAL HOUSE",
- "buildingName2": "WE WORK",
- "dpid": "34567890",
- "flatUnitNumber": "2A",
- "flatUnitType": "U",
- "floorLevelNumber": "2",
- "floorLevelType": "FL",
- "localityName": "RICHMOND",
- "lotNumber": "20",
- "postalDeliveryNumber": 2,
- "postalDeliveryNumberPrefix": "N",
- "postalDeliveryNumberSuffix": "A",
- "postalDeliveryType": "PO BOX",
- "postcode": "3024",
- "state": "NSW",
- "streetName": "SMITH",
- "streetSuffix": "W",
- "streetType": "ST",
- "thoroughfareNumber1": 23,
- "thoroughfareNumber1Suffix": "A",
- "thoroughfareNumber2": 25,
- "thoroughfareNumber2Suffix": "B"
}, - "simple": {
- "addressLine1": "55 McDonald Avenue",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "Maryville",
- "country": "AUS",
- "mailingName": "string",
- "postcode": "2293",
- "state": "NSW"
}
}, - "status": "OPEN",
- "displayName": "string",
- "creationDate": "2022-03-04",
- "plans": [
- {
- "nickname": "string",
- "servicePointIds": [
- {
- "servicePointId": "5bbdb5d20e474ee2f10ecd08deca1b16c89f0eaa94e69167c2475b417db7ec58",
- "deviceType": "NMI"
}
], - "planOverview": {
- "displayName": "Solar Saver",
- "startDate": "2021-01-01",
- "endDate": "2023-07-01"
}, - "planDetail": {
- "fuelType": "ELECTRICITY",
- "isContingentPlan": false,
- "meteringCharges": [
- {
- "displayName": "Base Metering Charge",
- "description": "A metering charge applied to all bills",
- "minimumValue": "1.00",
- "maximumValue": "15.00",
- "period": "P1M"
}
], - "gasContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": null,
- "description": null,
- "dailySupplyCharge": null,
- "rates": [ ]
}, - "timeOfUseRates": [
- null
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": null
}, - "percentOfUse": {
- "rate": null
}, - "fixedAmount": {
- "amount": null
}, - "percentOverThreshold": {
- "rate": null,
- "usageAmount": null
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- null
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": null
}, - "timeVaryingTariffs": {
- "type": null,
- "amount": null,
- "timeVariations": [ ]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": null,
- "description": null,
- "generalUnitPrice": null,
- "rates": [ ],
- "period": null
}, - "timeOfUseRates": [
- null
], - "demandCharges": [
- null
]
}
]
}, - "electricityContract": {
- "additionalFeeInformation": "Additional Solar Feed In Fee",
- "pricingModel": "SINGLE_RATE",
- "timeZone": "AEST",
- "isFixed": true,
- "variation": "Price Variations possible by calling support center",
- "onExpiryDescription": "On expiry of the contract the price will revert to the spot price at any given time",
- "paymentOption": [
- "CREDIT_CARD"
], - "intrinsicGreenPower": {
- "greenPercentage": "0.95"
}, - "controlledLoad": [
- {
- "displayName": "Electric hot water system",
- "rateBlockUType": "singleRate",
- "startDate": "2021-10-23",
- "endDate": "2022-04-30",
- "singleRate": {
- "displayName": null,
- "description": null,
- "dailySupplyCharge": null,
- "rates": [ ]
}, - "timeOfUseRates": [
- null
]
}
], - "incentives": [
- {
- "displayName": "Pay Early Discount",
- "description": "Pay Early and Receive a 5% Discount",
- "category": "ACCOUNT_CREDIT",
- "eligibility": "Pay by the due date and you will be credited 5% off your next bill"
}
], - "discounts": [
- {
- "displayName": "Pensioner Discount",
- "description": "Provide Pensioner card and you will receive a 15% discount",
- "type": "CONDITIONAL",
- "category": "GUARANTEED_DISCOUNT",
- "endDate": "2023-01-01",
- "methodUType": "percentOfBill",
- "percentOfBill": {
- "rate": null
}, - "percentOfUse": {
- "rate": null
}, - "fixedAmount": {
- "amount": null
}, - "percentOverThreshold": {
- "rate": null,
- "usageAmount": null
}
}
], - "greenPowerCharges": [
- {
- "displayName": "Green Power Surcharge",
- "description": "A surcharge applied for saving the planet",
- "scheme": "GREENPOWER",
- "type": "FIXED_PER_DAY",
- "tiers": [
- null
]
}
], - "eligibility": [
- {
- "type": "EXISTING_CUST",
- "information": "Eligibility restrictions apply for this restriction",
- "description": "Must be a remote property"
}
], - "fees": [
- {
- "type": "ESTABLISHMENT",
- "term": "FIXED",
- "amount": "1.55",
- "rate": "0.10",
- "description": "Initial Setup Charge"
}
], - "solarFeedInTariff": [
- {
- "displayName": "Solar Feed In Tariff",
- "description": "A base charge for feeding back into the grid",
- "scheme": "PREMIUM",
- "payerType": "RETAILER",
- "tariffUType": "singleTariff",
- "singleTariff": {
- "amount": null
}, - "timeVaryingTariffs": {
- "type": null,
- "amount": null,
- "timeVariations": [ ]
}
}
], - "tariffPeriod": [
- {
- "type": "OTHER",
- "displayName": "Plan Tariff",
- "startDate": "08-01",
- "endDate": "12-01",
- "dailySupplyCharges": "1.00",
- "timeZone": "AEST",
- "rateBlockUType": "singleRate",
- "singleRate": {
- "displayName": null,
- "description": null,
- "generalUnitPrice": null,
- "rates": [ ],
- "period": null
}, - "timeOfUseRates": [
- null
], - "demandCharges": [
- null
]
}
]
}
}, - "authorisedContacts": [
- {
- "firstName": "John",
- "lastName": "Doe",
- "middleNames": [
- "Jefferey"
], - "prefix": "Mr.",
- "suffix": "Sr."
}
]
}
], - "jointAccountSharingStatus": "PRE_APPROVAL"
}
]
}Get Energy Account Agreed Payment Schedule
Retrieve a list of payment schedules for a specific account
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
| accountId required | string Unique Account Identifier |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetEnergyPaymentScheduleVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 451
{- "version": "V0",
- "data": {
- "schedules": [
- {
- "amount": "string",
- "paymentScheduleUType": "manualPayment",
- "cardDebit": {
- "cardScheme": "VISA",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "directDebit": {
- "isTokenised": true,
- "bsb": "string",
- "accountNumber": "string",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "digitalWallet": {
- "name": "My Digital Wallet",
- "identifier": "user@digital.wallet.com",
- "type": "EMAIL",
- "provider": "OTHER",
- "paymentFrequency": "P3M",
- "calculationType": "CALCULATED"
}, - "manualPayment": {
- "billFrequency": "P3M"
}
}
]
}
}List Energy Account Concessions
Retrieve a list of concessions for a specific account
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
| accountId required | string Unique Account Identifier |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetEnergyConcessionsVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 451
{- "version": "V0",
- "data": {
- "concessions": [
- {
- "type": "FIXED_AMOUNT",
- "displayName": "Pensioner Discount",
- "additionalInfo": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "discountFrequency": "string",
- "amount": "67.39",
- "percentage": "0.05",
- "appliedTo": [
- "INVOICE"
]
}
]
}
}List Energy Account Balances
Retrieve a list of balances for one or more account identifiers
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| accountIds required | Array of strings Filter results based on a set of account identifiers |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListEnergyBalancesVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 451
{- "version": "V0",
- "data": {
- "balances": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "balance": "15.66"
}
]
}
}List Energy Account Invoices
Retrieve a list of invoices for one or more account identifiers
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| accountIds required | Array of strings Filter results based on a set of account identifiers |
| oldest-date | string <date> Constrain the request to records with issue 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 issue 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-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListEnergyInvoicesVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 422
- 451
{- "version": "V0",
- "data": {
- "invoices": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "invoiceNumber": "109818233",
- "issueDate": "2022-08-01",
- "dueDate": "2022-09-01",
- "period": {
- "startDate": "2022-01-01",
- "endDate": "2022-06-30"
}, - "invoiceAmount": "22.00",
- "gstAmount": "20.00",
- "payOnTimeDiscount": {
- "discountAmount": "5.00",
- "gstAmount": "0.50",
- "date": "2022-07-15"
}, - "balanceAtIssue": "10.00",
- "servicePoints": [
- "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa"
], - "gas": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "electricity": {
- "totalUsageCharges": "10.00",
- "totalGenerationCredits": "7.00",
- "totalOnceOffCharges": "10.00",
- "totalOnceOffDiscounts": "10.00",
- "otherCharges": [
- {
- "type": "OTHER",
- "amount": "5.00",
- "description": "Other Usage"
}
], - "totalGst": "1.36"
}, - "accountCharges": {
- "totalCharges": "15.00",
- "totalDiscounts": "10.00",
- "totalGst": "1.36"
}, - "paymentStatus": "NOT_PAID"
}
]
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}List Energy Account Billing Transactions
Retrieve a list of billing transactions for one or more account identifiers
Authorizations:
path Parameters
| principalId required | string <= 512 characters Example: 552375cb-9c00-4fde-a0a0-592904a55355 Represents the Principal being accessed |
query Parameters
| userId | string Example: userId=f9e23fa7-bb0a-42b6-9c8c-81f235ea1f10 The optional user to apply to the adapter call. This allows filtering of resources to only those accessible by the user rather than the whole set of resources available to the principal |
| accountIds required | Array of strings Filter results based on a set of account identifiers |
| 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:
|
| 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-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseListEnergyBillingsVersionV2) Enum: "V1" "V2" Example: V2 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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-R-Draft. Required for all resource calls (customer present and unattended) if the customer is currently logged. Otherwise optional where the customer has not logged in. Not to be included 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. |
| 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
- 200
- 400
- 404
- 422
- 451
{- "version": "V0",
- "data": {
- "transactions": [
- {
- "accountId": "jdnmwucgrchzngrqieryhiovpvzknokkwsediggdlnxgxizegvwpwfflgavkrbay",
- "executionDateTime": "2022-08-20T03:01:42+00:00",
- "gst": "string",
- "transactionUType": "onceOff",
- "usage": {
- "servicePointId": "string",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": false,
- "startDate": "2022-08-20T03:01:42+00:00",
- "endDate": "2022-09-20T03:01:42+00:00",
- "measureUnit": "KWH",
- "usage": 1.55,
- "amount": "1.56",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "demand": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "timeOfUseType": "PEAK",
- "description": "string",
- "isEstimate": true,
- "startDate": "2022-07-20T03:01:42+00:00",
- "endDate": "2022-08-20T03:01:42+00:00",
- "rate": 0.044,
- "amount": "10.00",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "onceOff": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "amount": "10.00",
- "description": "Once Off Setup Charge"
}, - "otherCharges": {
- "servicePointId": "aa719cefa99b27d2a86482c0e51460910e4336f24fa42b5c60dc72dcda86b3fa",
- "invoiceNumber": "string",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "type": "OTHER",
- "amount": "14.55",
- "description": "Miscellaneous Supply Charge",
- "calculationFactors": [
- {
- "value": 1.34,
- "type": "DLF"
}
], - "adjustments": [
- {
- "amount": "10.00",
- "description": "Adjustment"
}
]
}, - "payment": {
- "amount": "1.00",
- "method": "CARD"
}
}
]
}, - "meta": {
- "totalPages": 1,
- "totalRecords": 20
}
}Init Login
Initiate OTP Login using a supplied username and receive a request identifier to present the supplied OTP back with. This call should not fail if the username doesn't exist, but instead return a request ID that has no possibility of succeeding. This is to avoid enumeration attacks on usernames via this interface (i.e the only way to verify a user exists is to successfully pass the right OTP).
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseInitLoginVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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. |
| 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/jsonrequired
Initiate a login request
| version | string Default: "V0" |
| username required | string The username is the string that the customer is expected to enter at the first step of the consent flow. It could be an email, phone number or some kind of internet banking ID. The CDR mandates that the user needs to login to CDR with the same username as their digital banking channels, so what this username is depends on your existing UX. |
Responses
Request samples
- Payload
{- "version": "V0",
- "username": "customer@email.com"
}Response samples
- 200
- 400
- 422
{- "version": "V0",
- "requestId": "e5468c93-2dfc-4a27-b156-009a1067f2fb",
- "otp": "123455"
}Verify Login
Using a supplied request identifier and a supplied OTP verify the login and return a set of customer identifiers it is now validated for
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseVerifyLoginVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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. |
| 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/jsonrequired
Verify a login
| version | string Default: "V0" |
| requestId required | string |
| otpValue required | string |
Responses
Request samples
- Payload
{- "version": "V0",
- "requestId": "e5468c93-2dfc-4a27-b156-009a1067f2fb",
- "otpValue": "123455"
}Response samples
- 200
- 400
- 422
- 451
{- "version": "V0",
- "principalIds": [
- "552375cb-9c00-4fde-a0a0-592904a55355"
], - "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}Get Username Attributes
Accept a digital service identifier (Username) and return relevant details to conduct operations without already knowing the User Principal.
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetUsernameAttributesVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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. |
| 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/jsonrequired
Lookup User Attributes
| version | string Default: "V0" |
| username required | string The username is the string that the customer is expected to enter at the first step of the consent flow. It could be an email, phone number or some kind of internet banking ID. The CDR mandates that the user needs to login to CDR with the same username as their digital banking channels, so what this username is depends on your existing UX. |
Responses
Request samples
- Payload
{- "version": "V0",
- "username": "customer@email.com"
}Response samples
- 200
- 400
- 404
- 451
{- "version": "V0",
- "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567",
- "otpType": "MOBILE",
- "emailAddresses": [ ],
- "phoneNumbers": [ ]
}Get User Principals
Accept a previously supplied user identifier and provide back a response containing a list of principals
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| 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. |
| 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. |
| x-haas-v | string (EnumResponseGetUserPrincipalsVersion) Value: "V0" Example: V0 Supported Response Version |
Request Body schema: application/jsonrequired
Lookup User Principals
| version | string Default: "V0" |
| userId required | string <= 512 characters The internal user ID of the user. This should be an ID that doesn't change over the life of the user. |
Responses
Request samples
- Payload
{- "version": "V0",
- "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}Response samples
- 200
- 404
- 451
{- "version": "V0",
- "principalIds": [
- "552375cb-9c00-4fde-a0a0-592904a55355"
], - "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}Get Service Health Status
Retrieve health check summary
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetHealthVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
Responses
Response samples
- 200
- 400
{- "version": "V0",
- "data": {
- "status": "UP"
}
}Get Endpoint Metadata
Retrieve the endpoint metadata of the endpoints that this adapter supports
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-max-v required | string Example: V6 Supported Response Version |
Responses
Response samples
- 200
- 400
{- "version": "V3",
- "data": {
- "common": {
- "getCustomer": {
- "flags": [
- "SUPPORTS_USERID_QUERY_PARAM",
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "getUser": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}
}, - "auth": {
- "initLogin": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}, - "verifyLogin": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}, - "getUsernameAttributes": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}, - "getUserPrincipals": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}
}, - "admin": {
- "getHealth": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "responseVersions": [
- "V0"
]
}, - "getClosedPrincipals": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "responseVersions": [
- "V0"
]
}
}, - "banking": {
- "listBankingAccounts": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listBankingPayments": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listBankingPayees": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listBankingTransactions": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "requestBankingTransactionDetailList": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "requestVersions": [
- "V1"
], - "responseVersions": [
- "V1"
]
}, - "getBankingTransactionDetailListStatus": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V1"
]
}, - "retrieveBankingTransactionDetailList": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V1"
]
}
}, - "energy": {
- "listEnergyAccounts": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V2"
]
}, - "getEnergyPaymentSchedule": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "getEnergyConcessions": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listEnergyBalances": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listEnergyInvoices": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V0"
]
}, - "listEnergyBillings": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "responseVersions": [
- "V2"
]
}
}, - "device": {
- "getFRMPDetails": {
- "flags": [
- "SUPPORTS_TIER_HEADER",
- "SUPPORTS_CONSUMER_HEADERS"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}
}, - "notifications": {
- "sendNotification": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}, - "getUserNotificationInfo": {
- "flags": [
- "SUPPORTS_TIER_HEADER"
], - "requestVersions": [
- "V0"
], - "responseVersions": [
- "V0"
]
}
}
}
}Get Closed Principals (Optional)
Retrieve a list of principalIds that have recently closed all of their accounts and should have sharing arrangements revoked.
Authorizations:
query Parameters
| since | string <date-time> Filters the list to records that are newer than the timestamp |
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetClosedPrincipalsVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
Responses
Response samples
- 200
- 400
{- "version": "V0",
- "data": [
- {
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "timeClosed": "2017-07-21T17:32:28Z"
}
]
}This contains the APIs related to the sending of notification information to the Data Holder
Get User Notification Information
Takes a userId and returns back the name and email that should be used when sending email notifications to that user.
There are places where HaaS needs to obtain the name & email of a userId but we don't have a principalId present.
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
| x-haas-v | string (EnumResponseGetUserNotificationInfoVersion) Value: "V0" Example: V0 Supported Response Version |
Request Body schema: application/jsonrequired
Lookup User Attributes
| version | string Default: "V0" |
| userId required | string <= 512 characters The internal user ID of the user. This should be an ID that doesn't change over the life of the user. |
Responses
Request samples
- Payload
{- "version": "V0",
- "userId": "b5d1da97-a796-4e8f-9221-cc3cffafb567"
}Response samples
- 200
- 404
{- "version": "V0",
- "name": "First Last",
- "email": "demo@example.com"
}Send Notification
Send a batch of notifications.
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseSendNotificationVersion) Value: "V0" Example: V0 Supported Response Version |
Request Body schema: application/jsonrequired
Content of the Notification Request
| version | string Default: "V0" |
Array of objects (AdapterNotificationV1) List of Notifications to be sent as a batch. |
Responses
Request samples
- Payload
{- "version": "V0",
- "data": [
- {
- "to": [
- {
- "principalId": "6d33f5df-d550-4b35-9618-556155e78c28",
- "userId": "2a9e9706-30c2-4155-98c9-18d94e523a7a"
}
], - "from": {
- "principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
- "userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
- "accountDetails": [
- {
- "accountId": "0905f95b-4655-4e77-8556-869724f0460e",
- "relationship": "OWNER"
}
]
}, - "recipientDetails": {
- "legalEntityId": "9278f2f1-a08d-47b8-8743-79a478e63734",
- "legalEntityName": "Test Legal Entity",
- "softwareProductId": "9cc57c33-040a-480f-9df6-03a83d466656",
- "softwareProductName": "Test Software Product",
- "softwareProductDescription": "This is an example of a software product's description",
- "softwareProductStatus": "ACTIVE",
- "dataRecipientBrandName": "Test Recipient Brand",
- "dataRecipientBrandStatus": "ACTIVE",
- "dataRecipientAccreditationNumber": "TESTACCNO000123"
}, - "notificationType": "ARRANGEMENT_ACTION",
- "arrangementAction": {
- "grantId": "4f1cc672-88be-4cd8-bbe7-3fb6981b6958",
- "action": "STARTED"
}, - "sharingRequested": {
- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "expiry": "2022-08-01"
}, - "sharingRequestAction": {
- "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
- "action": "APPROVED",
- "expiry": "2023-02-03"
}, - "secondaryUserInstructionAction": {
- "action": "ADDED",
- "secondaryUser": {
- "principalId": "cd309f8be82b0ecdb5cbfe00355eb7a29f1583fd863da8fd4c87eb09dc5b4d61",
- "userId": "835e3f01f36c0bbc60d8841c29398d0ec6f8c596833b0e99bcdd7f2a97cb01e4"
}
}, - "otp": {
- "otpValue": "123456",
- "otpType": "MOBILE",
- "emailAddresses": [ ],
- "phoneNumbers": [
- {
- "fullNumber": "+61439123123",
- "number": "0439123123",
- "isPreferred": true,
- "purpose": "MOBILE"
}
]
}, - "periodicSummary": {
- "period": "WEEKLY",
- "sharingEvents": [
- {
- "type": "STARTED",
- "from": {
- "principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
- "userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
- "accountDetails": [
- {
- "accountId": "0905f95b-4655-4e77-8556-869724f0460e",
- "relationship": "OWNER"
}
]
}, - "recipientDetails": {
- "legalEntityId": "9278f2f1-a08d-47b8-8743-79a478e63734",
- "legalEntityName": "Test Legal Entity",
- "softwareProductId": "9cc57c33-040a-480f-9df6-03a83d466656",
- "softwareProductName": "Test Software Product",
- "softwareProductDescription": "This is an example of a software product's description",
- "softwareProductStatus": "ACTIVE",
- "dataRecipientBrandName": "Test Recipient Brand",
- "dataRecipientBrandStatus": "ACTIVE",
- "dataRecipientAccreditationNumber": "TESTACCNO000123"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
], - "secondaryUserInstructions": [
- {
- "type": "ADDED",
- "from": {
- "principalId": "e8013e29-f1da-4055-8a13-f4ac747a9218",
- "userId": "3607fd26-81f6-4563-9e70-7e87e3d61b7d",
- "accountDetails": [
- {
- "accountId": "0905f95b-4655-4e77-8556-869724f0460e",
- "relationship": "OWNER"
}
]
}, - "secondaryUser": {
- "principalId": "cd309f8be82b0ecdb5cbfe00355eb7a29f1583fd863da8fd4c87eb09dc5b4d61",
- "userId": "835e3f01f36c0bbc60d8841c29398d0ec6f8c596833b0e99bcdd7f2a97cb01e4"
}, - "timestamp": "2019-08-24T14:15:22Z"
}
]
}
}
]
}Response samples
- 200
- 400
{- "version": "V0",
- "data": {
- "receiptId": "d093323e-4ea5-4c94-a7a0-bf2f173bdaae"
}
}Retrieve FRMP Details
Retrieve a list of FRMP details for specified NMIs
Authorizations:
header Parameters
| x-fapi-interaction-id | string <uuid> Example: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 |
| x-haas-realm-name required | string Example: holder-auth The name of the realm that data is being requested for. Necessary for holders that have multiple brands that should not share data between them. |
| x-haas-v | string (EnumResponseGetFRMPDetailsVersion) Value: "V0" Example: V0 Supported Response Version |
| x-haas-performance-tier | string (EnumXHaaSPerformanceTierV1) Enum: "UNAUTHENTICATED" "HIGH_PRIORITY" "LOW_PRIORITY" "UNATTENDED" "LARGE_PAYLOAD" "SECONDARY_REQUEST" "LARGE_SECONDARY_REQUEST" "INTERNAL" Example: HIGH_PRIORITY This indicates which performance tier according to the Data Standards the request originates |
Request Body schema: application/jsonrequired
Lookup FRMP Details using a set of NMI
| version | string Default: "V0" |
| principalId required | string <= 512 characters The internal identifier of the entity being shared via CDR. It is the ID that will be supplied to the data sharing calls for customer details, listing accounts, etc. |
| nmi required | Array of strings An array of NMIs |
| oldestDate required | string <date> Constrain the request to records with effective date at or after this date. |
Responses
Request samples
- Payload
{- "version": "V0",
- "principalId": "552375cb-9c00-4fde-a0a0-592904a55355",
- "nmi": [
- "string"
], - "oldestDate": "2022-01-03"
}Response samples
- 200
- 404
{- "version": "V0",
- "nmi1": [
- {
- "frmpId": "ACMEENERGY",
- "startDate": "2022-01-03",
- "endDate": "2019-08-24"
}
], - "nmi2": [
- {
- "frmpId": "ACMEENERGY",
- "startDate": "2022-01-03",
- "endDate": "2019-08-24"
}
]
}