Internet-Draft | DataRight+: Bulk Transaction Detail | September 2024 |
Low | Expires 25 March 2025 | [Page] |
This specification outlines the DataRight+ extension functionality for an asynchronous bulk banking transaction detail capability within the existing constructs of the profile described in [PROFILE-AU-CDR].¶
The functionality exposed by the Provider allows the Initiator to request, using the same filter parameters of the [CDS] List Banking Transactions, a full set of Banking Transaction Detail via a job queue, poll and retrieval mechanism.¶
The keywords "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 25 March 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document.¶
The scope of this specification is focused on describing an asynchronous capability for downloading bulk banking transactions from a specific Provider supplied resource server. This specification does not seek to provide further definition as this is left to what is specified in [PROFILE-AU-CDR].¶
This specification uses the terms "Provider" and "Initiator" as defined by [DATARIGHTPLUS-ROSETTA].¶
This document, as extended further in OpenAPI format within [DATARIGHTPLUS-REDOCLY-ID2], describes the endpoints to deliver the Bulk Banking Transaction Detail capability. An identified challenge faced by participants within the Australian CDR is a desire of Initiators to obtain Banking Transaction Details for all transactions while balancing the performance constraints of Providers. On the one hand Initiators are often needing to iterate over lists of transactions to obtain, on an individual basis, transaction details, sometimes hitting the upper bounds of the prescribed Non-Functional Requirements while on the other hand Providers often must interact with many different sources of data to provide all the attributes contained within the BankingTransactionDetailV1
schema.¶
At a high level the process expected to be followed through the implementation of the prescribed endpoints is as follows:¶
bank:transaction:read
and bank:accounts.basic:read
scopes from the Provider through normal processes as prescribed within [PROFILE-AU-CDR], [CDS] and [CDR-RULES];¶
listBankingAccounts
operation, as described in [DATARIGHTPLUS-REDOCLY-ID2]. Further elaboration regarding this endpoint is outside the scope of this document;¶
requestBankingTransactionDetailList
request, including account identifier and desired filters, from the Provider Resource Server;¶
getBankingTransactionDetailListStatus
operation until the status returned indicates readiness;¶
retrieveBankingTransactionDetailList
, the Provider responds with a continuous list of BankingTransactionDetailV1
objects;¶
The Provider SHALL make available, as described further in the following subsections and specified in OpenAPI format within [DATARIGHTPLUS-REDOCLY-ID2], the following endpoints where the token is granted the bank:transactions:read
scope value:¶
Resource Server Endpoint |
x-v
|
Description |
---|---|---|
POST /actions/bulk-banking-transactions
|
1
|
Used to lodge Banking Transaction Detail List requests. |
Expects a wrapped Request Banking Transaction Detail List object to | ||
be submitted and returns a payload containing Action Status Metadata | ||
GET /actions/bulk-banking-transactions/{actionId}
|
1
|
Returns the current status of request. Accepts an actionId as a path parameter and returns a payload containing |
Action Status Metadata as well as the original | ||
Request Banking Transaction Detail List request content | ||
GET /actions/bulk-banking-transactions/{actionId}/retrieve
|
1
|
Provides the result payload. Accepts an actionId as a path parameter and returns a payload containing a list of |
Banking Transaction Detail. If the action is not in COMPLETE status returns |
||
urn:au-cds:error:cds-all:Resource/Unavailable error as described in [CDS]. If the action is in EXPIRED or |
||
FAILED status returns urn:au-cds:error:cds-all:Resource/Invalid error as described in [CDS]
|
Note: Each endpoint supports a number of other error behaviours, these are documented within [DATARIGHTPLUS-REDOCLY-ID2] and are intended to align with the behaviours described within [CDS].¶
Key schemas utilised for achieving the defined scope are described as follows.¶
Defined within [DATARIGHTPLUS-REDOCLY-ID2] as RequestBankingTransactionDetailListDataV1
this schema is used to provide the request information, is replayed by the Get Banking Transaction Detail List Status endpoint, and is intended to be a like-for-like to the input parameters for List Transactions for Banking Account as outlined within [CDS].¶
Attribute | Requirement | Type | Description |
---|---|---|---|
accountId
|
REQUIRED | String | ID of a specific account to obtain data for. This is a tokenised ID previously obtained from the List Banking Accounts endpoint. |
oldestDate
|
REQUIRED | String (DateString) | Constrain the request to records with effective date at or after this date. Format is aligned to DateString common type |
newestDate
|
REQUIRED | String (DateString) | Constrain the request to records with effective date at or before this date. Format is aligned to DateString common type |
minAmount
|
OPTIONAL | String (AmountString) | Filter transactions to only transactions with amounts higher or equal to than this amount |
maxAmount
|
OPTIONAL | String (AmountString) | Filter transactions to only transactions with amounts less than or equal to than this amount |
Note: For requests related to this specification the Initiator SHALL NOT include any other attributes than those documented above.¶
Defined within [DATARIGHTPLUS-REDOCLY-ID2] as MetaRequestBankingTransactionDetailListV1
this schema provides a high level status of the action, in this case the Bulk Banking Transaction Detail List request as follows:¶
Attribute | Requirement | Type | Description |
---|---|---|---|
actionId
|
REQUIRED | String (UUID) | Globally unique identifier for this action. MUST not be reused foID of a specific account to obtain data for. This is a tokenised ID previously obtained from the List Banking Accounts endpoint. |
status
|
REQUIRED | String (Enum) | Status of the action based on one of the enumerations described in Action Statuses |
statusDescription
|
REQUIRED | String | Extended description of the status containing content at the discretion of the Provider |
creationDateTime
|
REQUIRED | String (Date-Time) | Date/Time in RFC3339 representing the creation time of the action |
lastUpdated
|
REQUIRED | String (Date-Time) | Date/Time in RFC3339 representing the last update time of the action |
The following action statuses are recognised within this specification.¶
Status | Description |
---|---|
INITIALISE
|
Initialised but processing has not been started. |
PROCESSING
|
Currently processing and being prepared for download. |
COMPLETE
|
Completed and available for download at the Retrieve Banking Transaction Detail List endpoint. |
EXPIRED
|
Completed successfully but no longer available for download. |
FAILED
|
Failed to complete successfully, further information available within statusDescription
|
Note: For requests related to this specification the Provider SHALL NOT include any other statuses other than those documented above.¶
The results output by the Retrieve Banking Transaction Detail List operation is a list of BankingTransactionDetailV1
as defined within [DATARIGHTPLUS-REDOCLY-ID2].¶
Request:¶
POST /dio-au/actions/bulk-banking-transactions Host: api.provider.com.au Content-Type: application/json Accept: application/json x-v: V1 { "version": "V1", "data": { "accountId": "6ecc1b30-5889-49d4-a988-e44b4e215574", "oldestDate": "2022-07-01", "newestDate": "2024-06-30" } }¶
Response:¶
{ "version": "V1", "data": { "accountId": "6ecc1b30-5889-49d4-a988-e44b4e215574", "oldestDate": "2022-07-01", "newestDate": "2024-06-30" }, "links": { "self": "https://api.provider.com.au/actions/bulk-banking-transactions/9fe3f97e-c22c-4516-b6ed-05c0486db195" }, "meta": { "actionId": "9fe3f97e-c22c-4516-b6ed-05c0486db195", "status": "PROCESSING", "statusDescription": "Job Received, contacting internal systems to formulate response." } }¶
Request:¶
GET /dio-au/actions/bulk-banking-transactions/9fe3f97e-c22c-4516-b6ed-05c0486db195 Host: api.provider.com.au Accept: application/json x-v: V1¶
Response:¶
{ "version": "V1", "data": { "accountId": "6ecc1b30-5889-49d4-a988-e44b4e215574", "oldestDate": "2022-07-01", "newestDate": "2024-06-30" }, "links": { "self": "https://api.provider.com.au/dio-au/v1/actions/bulk-banking-transactions/9fe3f97e-c22c-4516-b6ed-05c0486db195" }, "meta": { "actionId": "9fe3f97e-c22c-4516-b6ed-05c0486db195", "status": "PROCESSING", "statusDescription": "Job Received, contacting internal systems to formulate response." } }¶
Request:¶
GET /dio-au/actions/bulk-banking-transactions/9fe3f97e-c22c-4516-b6ed-05c0486db195/retrieve Host: api.provider.com.au Accept: application/json x-v: V1¶
Response:¶
{ "version": "V1", "data": [ { "accountId": "6ecc1b30-5889-49d4-a988-e44b4e215574", "amount": "133.55", "apcaNumber": "484799", "billerCode": "75556", "billerName": "TAX OFFICE PAYMENTS", "crn": "1234123412341", "currency": "AUD", "description": "Outbound payment to ATO", "executionDateTime": "2022-03-03T03:03:03.3Z", "isDetailAvailable": true, "merchantCategoryCode": "5200", "merchantName": "Freedom Furniture", "postingDateTime": "2022-03-03T03:03:03.3Z", "reference": "Payment for Services", "status": "POSTED", "transactionId": "8cce04fbcc0fe8307e8c221b5ae497691935a368e98f5478610c60ca4ef81caf", "type": "PAYMENT", "valueDateTime": "2022-03-13T03:03:03.3Z", "extendedData": { "extensionUType": "x2p101Payload", "payee": "string", "payer": "string", "service": "X2P1.01", "x2p101Payload": { "endToEndId": "string", "extendedDescription": "An extended string description.", "purposeCode": "string" } } } ], "links": { "self": "https://api.provider.com.au/dio-au/v1/actions/bulk-banking-transactions/9fe3f97e-c22c-4516-b6ed-05c0486db195/retrieve" }, "meta": { "actionId": "9fe3f97e-c22c-4516-b6ed-05c0486db195", "status": "COMPLETE", "statusDescription": "Job complete, ready for download." } }¶
The availability of this functionality is expected to be discovered using the specification outlined in [DATARIGHTPLUS-DISCOVERY]. The version negotiation utilised by this specification is outlined within [DATARIGHTPLUS-ENHANCED-VERSIONING].¶