ofOpen Finance Guide
GlossarySTETBlogContact
object

HalTransactions

HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP

Fields (2)

  • transactionsarray<Transaction>required

    List of transactions

    Item: Transaction

    structure of a transaction

    • resourceIdResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls.

      Schema: ResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data.

      Type: string

      Constraints: pattern: `^([a-zA-Z0-9 /\-?:\()\.,']{1,35})$`

    • entryReferencestring

      Technical incremental identification of the transaction.

      Technical incremental identification of the transaction.

      Constraints: maxLength: 40

    • transactionAmountAmountTyperequired

      Structure aiming to embed the amount and the currency to be used.

      Schema: AmountType

      Structure aiming to embed the amount and the currency to be used.

      • currencyCurrencyCodeISO 4217required

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

      • amountstringrequired

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

        Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

    • creditDebitIndicatorCreditDebitIndicatorrequired

      Accounting flow of the amount

      Schema: CreditDebitIndicator

      Code
      CRDT
      DBIT
    • statusTransactionStatusrequired

      Type of Transaction

      Schema: TransactionStatus

      Code
      BOOK
      PDNG
      OTHR
    • bookingDatestring (date)ISO 8601required

      Booking date of the transaction on the account

      Booking date of the transaction on the account If the transaction is not yet booked. This field must be valued with a scheduled booking date.

    • valueDatestring (date)ISO 8601

      Value date of the transaction on the account

    • transactionDatestring (date)ISO 8601

      Date used for specific purposes:

      Date used for specific purposes:

      • for card transaction: date of the transaction
      • for credit transfer: acquiring date of the transaction
      • for direct debit: receiving date of the transaction
    • remittanceInformationUnstructuredRemittanceInformation

      ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

      Schema: UnstructuredRemittanceInformation

      Type: array<string>

      ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. API: Only one occurrence is allowed

      Item: Relevant information to the transaction

      Item constraints: maxLength: 140