Skip to content

Commit

Permalink
AIS - enhance transactions with booking state (issue#115) (#130)
Browse files Browse the repository at this point in the history
- Parameter "bookingStatus" changed "entryStatus" added
- New field "entryStatus" added to schema "AccountTransactionEntry"
- Description of endpoint /transaction changed
  • Loading branch information
simonmeyerm authored Nov 4, 2024
1 parent a2a6b8d commit 7396271
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions accountAPI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ paths:
- accounts
summary: Retrieve transactions of a specific account
description: |
Returns the transaction list of the specified account. Only postings with status booked will be returned.
Returns the transaction list of the specified account.
* Returns the transaction list of the current day, if called without a date.
* Returns the transaction list for a specific day, if called for a past date (i.e. all transactions from that day).
In case the specified day is not yet finalized, the response code will be 202.
Expand All @@ -202,15 +202,19 @@ paths:
$ref: '#/components/schemas/Date'
description: The end date of the transaction query.
- in: query
name: bookingStatus
required: true
name: entryStatus
required: false
schema:
type: string
enum:
- booked
- pending
- both
description: Booking status of the transactions to be queried.
default: booked
description: >
Specifies the status of the entries to be queried.
Intraday movements can have a status of either "pending" or "booked."
For completed booking days, only entries with a "booked" status will be returned.
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/authorization_in_header'
Expand Down Expand Up @@ -625,6 +629,7 @@ components:
required:
- entryId
- transactionType
- entryStatus
- bookingDate
- valueDate
- amount
Expand All @@ -637,6 +642,14 @@ components:
example: ENTRY123456789
transactionType:
$ref: '#/components/schemas/AccountTransactionTransactionType'
entryStatus:
type: string
enum:
- booked
- pending
description: >
Indicates the status of an account movement. Corresponds to the attribute _Ntry ⇾ Sts ⇾ Cd_ in SPS/ISO-20022
example: booked
entryReference:
type: string
description: >
Expand Down

0 comments on commit 7396271

Please sign in to comment.