ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Ability to identify pre-authorisation transactions #579

Open nils-work opened 1 year ago

nils-work commented 1 year ago

Description

In certain scenarios, a pre-authorisation, or 'hold' on funds may be applied to an account as a transaction.

It appears that some banking systems may record these transactions with a PENDING status (where they may later be removed), and others may classify them as POSTED (where they may later be reversed).

Apart from the status and possibly the description field, there are currently no other structured fields to clearly label what could be a 'pre-authorisation' transaction.

Area Affected

BankingTransaction schema, part of the Get Transactions For Account endpoint.

Change Proposed

Consider the need for such a field and the following possible options -

  1. "isPreAuthorisation": true, - this could be a Boolean similar to isDetailAvailable
  2. "type": "PRE_AUTHORISATION", - this could be a string enum, extending the existing list. It would need to be confirmed if this would be replacing other relevant data already provided by the enum.
Property Value
type DIRECT_DEBIT
type FEE
type INTEREST_CHARGED
type INTEREST_PAID
type OTHER
type PAYMENT
type TRANSFER_INCOMING
type TRANSFER_OUTGOING