--- swagger: "2.0" info: version: "1.0" title: PSD2 BERLIN Securities Accounts description: "# Endpoints url \ndiscount sandbox \nhttps://mtls-api-nonprod.discountbank.co.il/devapi/cert\n\ndiscount prod \nhttps://mtls-api.discountbank.co.il/prod/d\n\nmercantile sandbox \ \nhttps://mtls-api-nonprod.mercantile.co.il/devapi/cert\n\nmercantile prod \nhttps://mtls-api.mercantile.co.il/prod/d\n\nWith the XS2A Specification [XS2A-IG], a standard for an XS2A Interface is defined for the core services defined by the PSD2.\\nWith [oFA-IG-SecAIS] an extension of the NextGenPSD2 XS2A Specification [XS2A-IG]. It describes how the existing services for \\naccount information can be extended to provide account information on securities accounts. Therefore, new endpoints are \\ndefined in order to provide the information.This yaml file reflects the API definition given in [oFA-IG-SecAIS] and therefore \\nprovides the (essentially) same information regarding the data definition in a machine readable form.\\n **[XS2A-IG]** NextGenPSD2 XS2A Framework, Implementation Guidelines, The Berlin Group Joint Initiative on a PSD2 Compliant XS2A Interface, version 1.3.12, published 01 July 2022.\\n **[oFA-IG-SecAIS]** openFinance API Framework Implementation Guidelines for Extended Services AIS for Securities Accounts\\n\n\n\nNot supported query parameters \nRead Securities Accounts List: evaluationCurrency \ \nRead Securities Account Details: evaluationCurrency \nRead Securities Account Transaction List: entryReferenceFrom, deltaList" x-ibm-name: psd2-berlin-securities-accounts name: "" host: localhost basePath: /psd2 schemes: - https consumes: - application/json produces: - application/json - inbal.harel@dbank.co.il paths: /v1.0/securities-accounts: get: summary: Read Securities Account List description: | Returns a list of securities accounts as permitted by the presented consent. BOI Remarks: This service returns a list of all securities portfolios under the account. operationId: accounts-SCTS:get_securities_accounts parameters: - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true format: uuid type: string - name: Digest in: header description: Is contained if and only if the \"Signature\" element is contained in the header of the request. required: false type: string - name: Signature in: header description: | A signature of the request by the TPP on application level. This might be mandated by ASPSP. required: false type: string - name: TPP-Signature-Certificate in: header description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n" required: false format: byte type: string - name: PSU-IP-Address in: header description: "The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n" required: false format: ipv4 type: string - name: Consent-ID in: header description: | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. required: true type: string - name: PSU-IP-Port in: header description: | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false type: string - name: PSU-Accept in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Charset in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Encoding in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Language in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-User-Agent in: header description: | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false type: string - name: PSU-Http-Method in: header description: | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE required: false enum: - GET - POST - PUT - PATCH - DELETE type: string - name: PSU-Device-ID in: header description: | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false format: uuid type: string - name: PSU-Geo-Location in: header description: | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. required: false pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ type: string responses: 200: headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Ok schema: type: object required: - securitiesAccounts properties: securitiesAccounts: type: array items: $ref: '#/definitions/accountDetailsSecurities' 400: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Bad Request schema: $ref: '#/definitions/error_NG_400_AIS' 401: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unauthorised schema: $ref: '#/definitions/error_NG_401_AIS' 403: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Forbidden schema: $ref: '#/definitions/error_NG_403_AIS' 404: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Found schema: $ref: '#/definitions/error_NG_404_AIS_Securities' 405: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Method not allowed schema: $ref: '#/definitions/error_NG_405_AIS' 406: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Acceptable schema: $ref: '#/definitions/error_NG_406_AIS' 408: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Request Timeout 409: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Conflict schema: $ref: '#/definitions/error_NG_409_AIS' 415: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unsupported Media Type 429: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Too many Requests schema: $ref: '#/definitions/error_NG_429_AIS' 500: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Internal Server Error 503: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Service Unavailable produces: - application/json - application/problem+json security: - oauth2: - accounts-SCTS /v1.0/securities-accounts/{securities-account-id}: get: summary: Read Securities Account Details description: Reads details about a securities account as permitted by the presented consent operationId: accounts-SCTS:get_securities_account parameters: - name: securities-account-id in: path description: "This identification is denoting the addressed securities account. \nThe securities-account-id is retrieved by using a \\\"Read Securities Account List\\\". \nThe securities-account-id is the \\\"resourceId\\\" attribute of the securities account structure. \nIts value is constant at least throughout the lifecycle of a given consent.\n" required: true type: string - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true format: uuid type: string - name: Digest in: header description: Is contained if and only if the \"Signature\" element is contained in the header of the request. required: false type: string - name: Signature in: header description: | A signature of the request by the TPP on application level. This might be mandated by ASPSP. required: false type: string - name: TPP-Signature-Certificate in: header description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n" required: false format: byte type: string - name: PSU-IP-Address in: header description: "The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n" required: false format: ipv4 type: string - name: Consent-ID in: header description: | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. required: true type: string - name: PSU-IP-Port in: header description: | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false type: string - name: PSU-Accept in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Charset in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Encoding in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Language in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-User-Agent in: header description: | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false type: string - name: PSU-Http-Method in: header description: | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE required: false enum: - GET - POST - PUT - PATCH - DELETE type: string - name: PSU-Device-ID in: header description: | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false format: uuid type: string - name: PSU-Geo-Location in: header description: | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. required: false pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ type: string responses: 200: headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Ok schema: type: object required: - securitiesAccount properties: securitiesAccount: $ref: '#/definitions/accountDetailsSecurities' 400: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Bad Request schema: $ref: '#/definitions/error_NG_400_AIS' 401: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unauthorised schema: $ref: '#/definitions/error_NG_401_AIS' 403: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Forbidden schema: $ref: '#/definitions/error_NG_403_AIS' 404: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Found schema: $ref: '#/definitions/error_NG_404_AIS_Securities' 405: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Method not allowed schema: $ref: '#/definitions/error_NG_405_AIS' 406: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Acceptable schema: $ref: '#/definitions/error_NG_406_AIS' 408: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Request Timeout 409: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Conflict schema: $ref: '#/definitions/error_NG_409_AIS' 415: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unsupported Media Type 429: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Too many Requests schema: $ref: '#/definitions/error_NG_429_AIS' 500: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Internal Server Error 503: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Service Unavailable produces: - application/json - application/problem+json security: - oauth2: - accounts-SCTS /v1.0/securities-accounts/{securities-account-id}/positions: get: summary: Read Securities Account Positions description: | Reads the list of positions associated with a securities account as permitted by the presented consent BOI Remarks: Calculated balances should be based on public external sources. operationId: balances-SCTS:get_securities_account_positions parameters: - name: securities-account-id in: path description: "This identification is denoting the addressed securities account. \nThe securities-account-id is retrieved by using a \\\"Read Securities Account List\\\". \nThe securities-account-id is the \\\"resourceId\\\" attribute of the securities account structure. \nIts value is constant at least throughout the lifecycle of a given consent.\n" required: true type: string - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true format: uuid type: string - name: Digest in: header description: Is contained if and only if the \"Signature\" element is contained in the header of the request. required: false type: string - name: Signature in: header description: | A signature of the request by the TPP on application level. This might be mandated by ASPSP. required: false type: string - name: TPP-Signature-Certificate in: header description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n" required: false format: byte type: string - name: PSU-IP-Address in: header description: "The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n" required: false format: ipv4 type: string - name: Consent-ID in: header description: | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. required: true type: string - name: PSU-IP-Port in: header description: | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false type: string - name: PSU-Accept in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Charset in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Encoding in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Language in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-User-Agent in: header description: | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false type: string - name: PSU-Http-Method in: header description: | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE required: false enum: - GET - POST - PUT - PATCH - DELETE type: string - name: PSU-Device-ID in: header description: | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false format: uuid type: string - name: PSU-Geo-Location in: header description: | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. required: false pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ type: string responses: 200: headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Ok schema: type: object required: - reportDateTime - positionList - securitiesAccount properties: securitiesAccount: $ref: '#/definitions/accountReference' reportDateTime: $ref: '#/definitions/ISODateTime' balances: type: array items: $ref: '#/definitions/balanceSecurities' positionList: type: array items: $ref: '#/definitions/securitiesPosition' 400: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Bad Request schema: $ref: '#/definitions/error_NG_400_AIS' 401: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unauthorised schema: $ref: '#/definitions/error_NG_401_AIS' 403: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Forbidden schema: $ref: '#/definitions/error_NG_403_AIS' 404: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Found schema: $ref: '#/definitions/error_NG_404_AIS_Securities' 405: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Method not allowed schema: $ref: '#/definitions/error_NG_405_AIS' 406: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Acceptable schema: $ref: '#/definitions/error_NG_406_AIS' 408: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Request Timeout 409: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Conflict schema: $ref: '#/definitions/error_NG_409_AIS' 415: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unsupported Media Type 429: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Too many Requests schema: $ref: '#/definitions/error_NG_429_AIS' 500: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Internal Server Error 503: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Service Unavailable produces: - application/json - application/problem+json security: - oauth2: - balances-SCTS /v1.0/securities-accounts/{securities-account-id}/transactions: get: summary: Read Securities Transaction List description: Reads the list of transactions associated with a securities account as permitted by the presented consent operationId: transactions-SCTS:get_securities_account_transactions parameters: - name: securities-account-id in: path description: "This identification is denoting the addressed securities account. \nThe securities-account-id is retrieved by using a \\\"Read Securities Account List\\\". \nThe securities-account-id is the \\\"resourceId\\\" attribute of the securities account structure. \nIts value is constant at least throughout the lifecycle of a given consent.\n" required: true type: string - name: dateFrom in: query description: "Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required\nand if bookingStatus does not equal \\\"information\\\".\nFor booked transactions, the relevant date is the booking date. \nFor pending transactions, the relevant date is the entry date, which may not be transparent \nneither in this API nor other channels of the ASPSP.\nBOI remarks: \nThe ASPSP shall provide a documentation with the maximum value.\nIn case of exception from the minimum value the response will be only for the minimum period.\n" required: true format: date type: string - name: dateTo in: query description: "End date (inclusive the data dateTo) of the transaction list, default is \\\"now\\\" if not given. \nMight be ignored if a delta function is used.\nFor booked transactions, the relevant date is the booking date. \nFor pending transactions, the relevant date is the entry date, which may not be transparent \nneither in this API nor other channels of the ASPSP.\n" required: false format: date type: string - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true format: uuid type: string - name: Digest in: header description: Is contained if and only if the \"Signature\" element is contained in the header of the request. required: false type: string - name: Signature in: header description: | A signature of the request by the TPP on application level. This might be mandated by ASPSP. required: false type: string - name: TPP-Signature-Certificate in: header description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n" required: false format: byte type: string - name: PSU-IP-Address in: header description: "The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n" required: false format: ipv4 type: string - name: Consent-ID in: header description: | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. required: true type: string - name: PSU-IP-Port in: header description: | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false type: string - name: PSU-Accept in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Charset in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Encoding in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Language in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-User-Agent in: header description: | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false type: string - name: PSU-Http-Method in: header description: | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE required: false enum: - GET - POST - PUT - PATCH - DELETE type: string - name: PSU-Device-ID in: header description: | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false format: uuid type: string - name: PSU-Geo-Location in: header description: | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. required: false pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ type: string responses: 200: headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Ok schema: type: object properties: securitiesAccount: $ref: '#/definitions/accountReference' transactions: type: array items: $ref: '#/definitions/securitiesTransaction' _links: $ref: '#/definitions/_links_200_SecuritiesTransactions' 400: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Bad Request schema: $ref: '#/definitions/error_NG_400_AIS' 401: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unauthorised schema: $ref: '#/definitions/error_NG_401_AIS' 403: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Forbidden schema: $ref: '#/definitions/error_NG_403_AIS' 404: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Found schema: $ref: '#/definitions/error_NG_404_AIS_Securities' 405: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Method not allowed schema: $ref: '#/definitions/error_NG_405_AIS' 406: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Acceptable schema: $ref: '#/definitions/error_NG_406_AIS' 408: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Request Timeout 409: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Conflict schema: $ref: '#/definitions/error_NG_409_AIS' 415: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unsupported Media Type 429: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Too many Requests schema: $ref: '#/definitions/error_NG_429_AIS' 500: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Internal Server Error 503: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Service Unavailable produces: - application/json - application/problem+json security: - oauth2: - transactions-SCTS /v1.0/securities-accounts/{securities-account-id}/orders: get: summary: Read Securities Order List description: Reads the list of orders associated with a securities account as permitted by the presented consent operationId: transactions-SCTS:get_securities_account_orders parameters: - name: securities-account-id in: path description: "This identification is denoting the addressed securities account. \nThe securities-account-id is retrieved by using a \\\"Read Securities Account List\\\". \nThe securities-account-id is the \\\"resourceId\\\" attribute of the securities account structure. \nIts value is constant at least throughout the lifecycle of a given consent.\n" required: true type: string - name: dateFrom in: query description: "Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required\nand if bookingStatus does not equal \\\"information\\\".\nFor booked transactions, the relevant date is the booking date. \nFor pending transactions, the relevant date is the entry date, which may not be transparent \nneither in this API nor other channels of the ASPSP.\nBOI remarks: \nThe ASPSP shall provide a documentation with the maximum value.\nIn case of exception from the minimum value the response will be only for the minimum period.\n" required: true format: date type: string - name: dateTo in: query description: "End date (inclusive the data dateTo) of the transaction list, default is \\\"now\\\" if not given. \nMight be ignored if a delta function is used.\nFor booked transactions, the relevant date is the booking date. \nFor pending transactions, the relevant date is the entry date, which may not be transparent \nneither in this API nor other channels of the ASPSP.\n" required: false format: date type: string - name: orderStatus in: query description: "Comma separated list of Order Status Code\nRestricts the result to orders that are currently assigned to one of the status values provided in \nthis query parameter.\nIf the parameter is not provided, orders are provided without restriction to their respective status.\n" required: false type: string - name: X-Request-ID in: header description: ID of the request, unique to the call, as determined by the initiating party. required: true format: uuid type: string - name: Digest in: header description: Is contained if and only if the \"Signature\" element is contained in the header of the request. required: false type: string - name: Signature in: header description: | A signature of the request by the TPP on application level. This might be mandated by ASPSP. required: false type: string - name: TPP-Signature-Certificate in: header description: "The certificate used for signing the request, in base64 encoding. \nMust be contained if a signature is contained.\n" required: false format: byte type: string - name: PSU-IP-Address in: header description: "The forwarded IP Address header field consists of the corresponding HTTP request \nIP Address field between PSU and TPP. \nIt shall be contained if and only if this request was actively initiated by the PSU.\n" required: false format: ipv4 type: string - name: Consent-ID in: header description: | This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation. required: true type: string - name: PSU-IP-Port in: header description: | The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. required: false type: string - name: PSU-Accept in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Charset in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Encoding in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-Accept-Language in: header description: | The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. required: false type: string - name: PSU-User-Agent in: header description: | The forwarded Agent header field of the HTTP request between PSU and TPP, if available. required: false type: string - name: PSU-Http-Method in: header description: | HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE required: false enum: - GET - POST - PUT - PATCH - DELETE type: string - name: PSU-Device-ID in: header description: | UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. required: false format: uuid type: string - name: PSU-Geo-Location in: header description: | The forwarded Geo Location of the corresponding http request between PSU and TPP if available. required: false pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$ type: string responses: 200: headers: X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Ok schema: type: object properties: securitiesAccount: $ref: '#/definitions/accountReference' orders: type: array items: $ref: '#/definitions/securitiesOrder' _links: $ref: '#/definitions/_links_200_SecuritiesOrders' 400: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Bad Request schema: $ref: '#/definitions/error_NG_400_AIS' 401: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unauthorised schema: $ref: '#/definitions/error_NG_401_AIS' 403: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Forbidden schema: $ref: '#/definitions/error_NG_403_AIS' 404: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Found schema: $ref: '#/definitions/error_NG_404_AIS_Securities' 405: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Method not allowed schema: $ref: '#/definitions/error_NG_405_AIS' 406: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Not Acceptable schema: $ref: '#/definitions/error_NG_406_AIS' 408: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Request Timeout 409: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Conflict schema: $ref: '#/definitions/error_NG_409_AIS' 415: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Unsupported Media Type 429: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Too many Requests schema: $ref: '#/definitions/error_NG_429_AIS' 500: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Internal Server Error 503: headers: Location: description: | Location of the created resource. type: string format: url X-Request-ID: description: ID of the request, unique to the call, as determined by the initiating party. type: string format: uuid description: Service Unavailable produces: - application/json - application/problem+json security: - oauth2: - transactions-SCTS definitions: error_RFC7807_429_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_429_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_429_AIS' _links: $ref: '#/definitions/_linksAll' TradingSessionTypeCode: description: "Code set to identify the type of a trading session, in which an order shall be executed. Possible values:\n* **auctions**: Orders that are traded in regularly occurring auctions: orders are \n accumulated and executed on the basis of defined algorithms.\n* **continuous**: Orders that are executed directly against each other as they hit the marketplace.\n" type: string enum: - auctions - continuous MessageCode_405_AIS: description: Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). type: string enum: - SERVICE_INVALID SecuritiesOrderSide: description: "Code set to identify the \\\"side\\\" / intended action for the respective order. \n" type: string enum: - buy - sell - subscription - redemption error_NG_400_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_400_AIS' _links: $ref: '#/definitions/_linksAll' tppMessage_403_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_403_AIS' path: type: string text: $ref: '#/definitions/Max500Text' evaluatedAmount: description: This data structure represents an evaluated amount (without indicating the method of evaluation) when an unambiguous balance cannot be provided, but an evaluation, e.g. the value of a securities position. type: object required: - amount properties: amount: allOf: - description: Amount that is evaluated. - $ref: '#/definitions/amount' evaluationDateTime: allOf: - description: Date and time of the evaluation. - $ref: '#/definitions/ISODateTime' evaluationDate: allOf: - description: Date of the evaluation. - $ref: '#/definitions/ISODate' otherFinancialInstrumentIdentification: description: | This data element structure represents the identification of a financial instrument by means other than ISIN. type: object required: - identification properties: identification: allOf: - description: Identification of a security. - $ref: '#/definitions/Max35Text' suffix: allOf: - description: Identifies the suffix of the security identification. - $ref: '#/definitions/Max16Text' typeCode: allOf: - description: Unique and unambiguous identification source, as assigned via a pre-determined code list. - $ref: '#/definitions/ExternalFinancialInstrumentIdentificationType1Code' typeProprietary: allOf: - description: Unique and unambiguous identification source using a proprietary identification scheme. - $ref: '#/definitions/Max35Text' securitiesPosition: description: | This data element structure represents the identification of a financial instrument by means other than ISIN. type: object required: - financialInstrument properties: financialInstrument: allOf: - description: | Financial Instrument that is contained in this position. - $ref: '#/definitions/financialInstrument' unitsNumber: allOf: - description: | Numeric quantification of the financial instrument. Negative values for short positions. - type: number unitsNominal: allOf: - description: | Nominal quantification of the financial instrument. Negative values for short positions. - $ref: '#/definitions/amount' externalIdentifier: allOf: - description: | Name or identifier with an intrinsic meaning for the PSU to be displayed. - $ref: '#/definitions/Max35Text' safekeepingPlace: allOf: - description: "BIC of the place where the securities are safe-kept, physically or notionally. \n" - $ref: '#/definitions/BICFI' safekeepingCountry: allOf: - description: | Country where the securities are safe-kept. - $ref: '#/definitions/CountryCode' balanceType: allOf: - description: "Specifies the nature of the securities or investment fund balance.\nType of balance in case of multiple positions for the same financial instrument for \nfurther distinction.\n*Remark:* In consequence, several positions with the same financial instrument may occur in the same position list, \nhaving different values of \\\"balanceType\\\".\n" - $ref: '#/definitions/SecuritiesBalanceType_1_2_11_12_Code' averageBuyingPrice: allOf: - description: | Average buying price of the position excluding any fees or taxes. - $ref: '#/definitions/amount' averageSellingPrice: allOf: - description: | Average selling price of the position, e.g. in case of a short position. Price excluding any fees or taxes. - $ref: '#/definitions/amount' totalBuyingPrice: allOf: - description: "In case of bonds, an average buying price does not make sense. \nTherefore, the total buying price excluding any fees or taxes can be shown displayed instead.\n" - $ref: '#/definitions/amount' estimatedCurrentValue: allOf: - description: | Estimated value of the position and timestamp of the estimation. - $ref: '#/definitions/evaluatedAmount' accruedInterest: allOf: - description: | Accrued interest by the position. - $ref: '#/definitions/accruedInterest' currencyExchange: allOf: - description: "The ASPSP might include exchange rates e.g. if the security is denoted in another currency \nthan the account itself.\n" - type: array items: $ref: '#/definitions/reportExchangeRate' details: allOf: - description: | Additional details to the position. - $ref: '#/definitions/Max500Text' TppMessageCategory: description: Category of the TPP message category. type: string enum: - ERROR - WARNING error_NG_409_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_409_AIS' _links: $ref: '#/definitions/_linksAll' error_RFC7807_403_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_403_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_403_AIS' _links: $ref: '#/definitions/_linksAll' Max500Text: type: string maxLength: 500 CurrencyCode: description: | ISO 4217 Alpha 3 currency code. type: string pattern: ^[A-Z]{3}$ example: EUR Max70Text: type: string maxLength: 70 tppMessage_429_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_429_AIS' path: type: string text: $ref: '#/definitions/Max500Text' BalanceType: description: "The following balance types are defined:\n - \\\"closingBooked\\\": \n Balance of the account at the end of the pre-agreed account reporting period. \n It is the sum of the opening booked balance at the beginning of the period and all entries booked \n to the account during the pre-agreed account reporting period.\n For card-accounts, this is composed of\n - invoiced, but not yet paid entries\n - \\\"expected\\\":\n Balance composed of booked entries and pending items known at the time of calculation, \n which projects the end of day balance if everything is booked on the account and no other entry is posted.\n For card accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries and\n - pending items (not yet booked)\n For savings and loans:\n \ estimated balance (e.g. including an upcoming interest payment) for the referenced date.\n - \\\"openingBooked\\\":\n Book balance of the account at the beginning of the account reporting period. \n It always equals the closing book balance from the previous report.\n - \\\"interimAvailable\\\":\n \ Available balance calculated in the course of the account ?servicer?s business day, \n at the time specified, and subject to further changes during the business day. \n The interim balance is calculated on the basis of booked credit and debit items during the calculation \n time/period specified.\n \ For card-accounts, this is composed of:\n - invoiced, but not yet paid entries\n - not yet invoiced but already booked entries\n NOT used for savings and loans.\n - \\\"interimBooked\\\":\n Balance calculated in the course of the account servicer's business day, at the time specified, \n and subject to further changes during the business day. \n The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period \n specified.\n - \\\"forwardAvailable\\\":\n Forward available balance of money that is at the disposal of the account owner on the date specified.\n \ NOT used for savings and loans.\n - \\\"nonInvoiced\\\": \n Only for card accounts, to be defined yet.\n" type: string enum: - closingBooked - expected - openingBooked - interimAvailable - interimBooked - forwardAvailable - nonInvoiced balanceSecurities: description: "In the context of securities, balances are used to represent an estimation of the securities account's \ntotal value. As the value of single financial instruments and therefore the sum of all such values is \nconstantly changing, the estimation does particularly depend on the time of its creation. \nTherefore, it is strongly recommended (and in some instances mandated) \nto include the element referenceDateTime.\n" type: object required: - balanceAmount - balanceType properties: balanceAmount: allOf: - description: "" - $ref: '#/definitions/amount' balanceType: allOf: - description: "The used balance types that apply to securities are restricted to the following values \nwith ther specific interpretation for securities accounts:\n* closingBooked: estimation based in the last fully finished trading date as interpreted \nby the ASPSP.\n* interimAvailable: intermediate estimation of the amounts value. If a balance with type \n\\\"interimAvailable\\\" is used, it must indicate the date and time of the evaluation in \nfield referenceDateTime.\n" - $ref: '#/definitions/BalanceType' lastChangeDateTime: allOf: - description: "This data element might be used to indicate e.g. with the expected or booked balance that no action is known \non the account, which is not yet booked.\n" - $ref: '#/definitions/ISODateTime' referenceDate: allOf: - description: Indicates the date of the balance. - $ref: '#/definitions/ISODate' referenceDateTime: allOf: - description: Indicates the date and time of the balance. Mandated, if balanceType = interimAvailable. - $ref: '#/definitions/ISODateTime' lastCommittedTransaction: description: "\\\"entryReference\\\" of the last commited transaction to support the TPP in identifying whether all \nPSU transactions are already known.\n" type: string maxLength: 35 MessageCode_403_AIS: allOf: - description: Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). - [] hrefType: description: Link to a resource. type: object properties: href: description: Link to a resource. type: string MessageCode_400_Generic: description: Generic message codes defined for HTTP Error code 400 (BAD_REQUEST). type: string enum: - FORMAT_ERROR - PARAMETER_NOT_CONSISTENT - PARAMETER_NOT_SUPPORTED - SERVICE_INVALID - RESOURCE_UNKNOWN - RESOURCE_EXPIRED - RESOURCE_BLOCKED - TIMESTAMP_INVALID - PERIOD_INVALID - SCA_METHOD_UNKNOWN - SCA_INVALID - CONSENT_UNKNOWN MessageCode_429_AIS: description: Message codes for HTTP Error code 429 (TOO MANY REQUESTS). type: string enum: - ACCESS_EXCEEDED error_RFC7807_404_AIS_Securities: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_404_AIS_Securities' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_404_AIS_Securities' _links: $ref: '#/definitions/_linksAll' Max35Text: type: string maxLength: 35 tppMessage_406_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_406_AIS' path: type: string text: $ref: '#/definitions/Max500Text' error_RFC7807_400_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_400_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_400_AIS' _links: $ref: '#/definitions/_linksAll' MessageCode_401_Generic: description: Generic message codes defined for HTTP Error code 401 (UNAUTHORIZED). type: string enum: - CERTIFICATE_INVALID - ROLE_INVALID - CERTIFICATE_EXPIRED - CERTIFICATE_BLOCKED - CERTIFICATE_REVOKE - CERTIFICATE_MISSING - SIGNATURE_INVALID - SIGNATURE_MISSING - CORPORATE_ID_INVALID - PSU_CREDENTIALS_INVALID - CONSENT_INVALID - CONSENT_EXPIRED - TOKEN_UNKNOWN - TOKEN_INVALID - TOKEN_EXPIRED accountReference: description: "This type is containing any account identification which can be used on payload-level to address specific \naccounts. The ASPSP will document which account reference type it will support.\n" type: object properties: iban: allOf: - description: "" - $ref: '#/definitions/IBAN' bban: allOf: - description: | This data element can be used for accounts when no IBAN is provided. - $ref: '#/definitions/BBAN' maskedPan: allOf: - description: | Primary Account Number (PAN) of a card in a masked form. - $ref: '#/definitions/Max35Text' msisdn: allOf: - description: "An alias to access a payment account via a registered mobile phone number. \n" - $ref: '#/definitions/Max35Text' other: allOf: - description: "In cases where the criteria listed above (IBAN, BBAN,MSISDN) are not provided to \nidentify the account (e.g. a securities account), the ASPSP shall support delivery \nof a proprietary ID of the respective account that uniquely identifies the account \nfor this ASPSP. This ID will be delivered within the \\\"other\\\" structure.\nIn this case, the ASPSP specifically shall support consent establishment for an account \nidentified by its proprietary ID.\n**Remark:** An ASPSP does not have to support the \\\"other\\\" element for (regular payment) \naccounts.\n" - $ref: '#/definitions/otherType' currency: allOf: - description: | ISO 4217 Alpha 3 currency code - $ref: '#/definitions/CurrencyCode' cashAccountType: allOf: - description: "ExternalCashAccountType1Code from ISO 20022. Might be extended by an additional code to indicate securities accounts. \nA global definition of a code for securities accounts is intentionally not provided by this document.\nThe API provider may restrict the accepted values further (e.g. only \\\"SVGS\\\" and \\\"CACC\\\" may be supported). \nThe TPP includes this element, if the account reference may identify several accounts of different types, \nbut the TPP only requests access to a specific type (e.g. card accounts).\nIf the cashAccountType is not present, it indicates the cashAccountType\n* \\\"Card Account\\\" in case of the account identification being provided as a maskedPan or a pan and \n* \\\"Current Account\\\" (CACC) otherwise.\nBOI REMARKS:\nCode for securities : \"SCTS\"\nIn case the TPP requests access for several types with same identifiers, the TPP will send the same identifier multiple times for each cashAccountType. \ \n" - $ref: '#/definitions/ExternalCashAccountType' IBAN: type: string description: IBAN of an account. pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ example: FR7612345987650123456789014 securitiesTransaction: description: Represents a securities transaction. type: object required: - relevantDates - financialInstrument - amountIncludesFees - amountIncludesTaxes properties: transactionId: allOf: - description: "Can be used as access-ID in the API, where more details on a transaction is offered. \nIf this data attribute is provided, this shows that the AIS can get access on more details \nabout this transaction using the Read Securities Transaction Details Request.\n" - type: string entryReference: allOf: - description: "Identification of the transaction as used e.g. for reference for deltafunction on application level. \n" - $ref: '#/definitions/Max35Text' relevantDates: allOf: - description: "" - type: array items: $ref: '#/definitions/securitiesRelatedDateOrTime' financialInstrument: allOf: - description: | Financial instrument that was transferred within the transaction. - $ref: '#/definitions/financialInstrument' orderId: allOf: - description: | Resource Id of the order resource that triggered this transaction, if applicable. - type: string unitsNumber: allOf: - description: "Numeric quantification of the financial instrument. Negative values indicate that \nthe respective quantity of the financial instrument has been taken from the securities\naccount, positive values indicate that the quantity hasbeen added.\n" - type: number unitsNominal: allOf: - description: "Nominal quantification of the financial instrument. Negative values indicate that \nthe respective quantity of the financial instrument has been taken from the securities\naccount, positive values indicate that the quantity hasbeen added.\n" - $ref: '#/definitions/amount' transactionTypeCode: allOf: - description: | Type of the transaction as code. - $ref: '#/definitions/TransactionActivityType1Code' transactionTypeProprietary: allOf: - description: | Type of the transaction as a proprietary string. - $ref: '#/definitions/Max35Text' placeOfTrade: allOf: - description: "" - $ref: '#/definitions/marketIdentification' amountIncludesFees: allOf: - description: | Indicates whether the transactionAmount (see below) is including fees. Default: false - type: boolean amountIncludesTaxes: allOf: - description: | Indicates whether the transactionAmount (see below) is including taxes. Default: false - type: boolean transactionAmount: allOf: - description: "Transaction amount for the transferred security for the PSU. Potential fees or taxes are reflected as indicated \nby elements \\\"amountIncludesFees\\\" and \\\"amountIncludesTaxes\\\".\nRemark: The price denoted here is the price for the whole lot of securities within this transaction, \nnot for a single item.\n" - $ref: '#/definitions/amount' relatedFees: allOf: - description: "Only allowed if amountIncludesFees = true. In that case Details of the fees that have been applied to\nthis transaction (and therefore represent additional costs of the transaction beyond the \ntransactionAmount).\nFees with positive amount are debited by the PSU, only in the rare case of a fee credited to the PSU \n(e.g. in case of a reversal) negative amounts are used.\n" - type: array items: $ref: '#/definitions/securitiesRelatedFee' currencyExchange: allOf: - description: "The ASPSP might include exchange rates e.g. if the transaction has been settled \nin another currency than the PSU's currency.\n" - type: array items: $ref: '#/definitions/reportExchangeRate' reversalIndicator: allOf: - description: | Indicates whether it is the reversal of a previously reported movement. Default: false - type: boolean reversedTransactionId: allOf: - description: | \"transactionId\" of the reversed transaction, if applicable and supported by the ASPSP. - type: boolean unitsNumberBeforeTx: allOf: - description: | Numeric quantification of the financial instrument within the primary position before the transaction, negative values for short positions. - type: number unitsNominalBeforeTx: allOf: - description: | Nominal quantification of the financial instrument within the primary position before the transaction, negative values for short positions. - $ref: '#/definitions/amount' unitsNumberAfterTx: allOf: - description: | Numeric quantification of the financial instrument within the primary position after the transaction, negative values for short positions. - type: number unitsNominalAfterAfterTx: allOf: - description: | Nominal quantification of the financial instrument within the primary position after the transaction, negative values for short positions. - $ref: '#/definitions/amount' accruedInterest: allOf: - description: | Accrued interest by the position to make transparent what the PSU really lost within this transaction - $ref: '#/definitions/accruedInterest' details: allOf: - description: "Additional details to the transaction. \n" - $ref: '#/definitions/Max500Text' _links: description: "The following types of links are supported:\n * \\\"transactionDetails\\\": Single link for retrieving details on this specific transaction. Only\n \ applicable, if the ASPSP supports the Read Securities Transaction Details endpoint. \n" type: object additionalProperties: $ref: '#/definitions/hrefType' properties: transactionDetails: $ref: '#/definitions/hrefType' _linksAll: description: | A _link object with all available link types. type: object additionalProperties: $ref: '#/definitions/hrefType' properties: scaRedirect: $ref: '#/definitions/hrefType' scaOAuth: $ref: '#/definitions/hrefType' confirmation: $ref: '#/definitions/hrefType' startAuthorisation: $ref: '#/definitions/hrefType' startAuthorisationWithPsuIdentification: $ref: '#/definitions/hrefType' updatePsuIdentification: $ref: '#/definitions/hrefType' startAuthorisationWithProprietaryData: $ref: '#/definitions/hrefType' updateProprietaryData: $ref: '#/definitions/hrefType' startAuthorisationWithPsuAuthentication: $ref: '#/definitions/hrefType' updatePsuAuthentication: $ref: '#/definitions/hrefType' startAuthorisationWithEncryptedPsuAuthentication: $ref: '#/definitions/hrefType' updateEncryptedPsuAuthentication: $ref: '#/definitions/hrefType' updateAdditionalPsuAuthentication: $ref: '#/definitions/hrefType' updateAdditionalEncryptedPsuAuthentication: $ref: '#/definitions/hrefType' startAuthorisationWithAuthenticationMethodSelection: $ref: '#/definitions/hrefType' selectAuthenticationMethod: $ref: '#/definitions/hrefType' startAuthorisationWithTransactionAuthorisation: $ref: '#/definitions/hrefType' authoriseTransaction: $ref: '#/definitions/hrefType' self: $ref: '#/definitions/hrefType' status: $ref: '#/definitions/hrefType' scaStatus: $ref: '#/definitions/hrefType' account: $ref: '#/definitions/hrefType' balances: $ref: '#/definitions/hrefType' positions: $ref: '#/definitions/hrefType' orders: $ref: '#/definitions/hrefType' transactions: $ref: '#/definitions/hrefType' transactionDetails: $ref: '#/definitions/hrefType' cardAccount: $ref: '#/definitions/hrefType' cardTransactions: $ref: '#/definitions/hrefType' relatedOrders: allOf: - description: | An array of links to request order details of related orders (e.g. other orders that originated from the same order split as this order). Only applicable, if the ASPSP supports the Read Securities Order Details endpoint. - type: array items: $ref: '#/definitions/hrefType' relatedTransactions: allOf: - description: "An array of links to request securities transaction details of transactions that resulted\nfrom this order. \nOnly applicable, if the ASPSP supports the Read Securities Transaction Details endpoint.\n" - type: array items: $ref: '#/definitions/hrefType' orderDetails: allOf: - description: "Single link for retrieving details on this specific order. \nOnly applicable, if the ASPSP supports the Read Securities Order Details endpoint.\n" - $ref: '#/definitions/hrefType' first: $ref: '#/definitions/hrefType' next: $ref: '#/definitions/hrefType' previous: $ref: '#/definitions/hrefType' last: $ref: '#/definitions/hrefType' download: $ref: '#/definitions/hrefType' Max16Text: type: string maxLength: 16 accruedInterest: type: object properties: daysAccrued: allOf: - description: Specifies the number of days used for calculating the accrued interest amount. - type: number amounts: allOf: - description: Amount of the accrued interest. Each item represents the same monetary value in different currencies, e.g. account currency, currency of the security's denomination. - type: array items: $ref: '#/definitions/amount' securitiesAccountFeeRule: description: "Represents parameters of a given type of fee (represented by the overlying Securities Fee Rule) as they apply \nif the volume of certain (not explicitly mentioned) statistics of the account / PSU lies in the intervall from\na certain \\\"fromBaseAmount\\\" to a certain \\\"toBaseAmount\\\".\n" type: object properties: amount: allOf: - description: | Amount of the fee. - $ref: '#/definitions/amount' percentage: description: Percentage of the fee. Up to 20 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Trailing zeroes must be truncated. type: string pattern: ^-?[0-9]{1,20}(\.[0-9]{0,19})?$ fromBaseAmount: allOf: - description: "To be used for fees where a tiered percentage is used to calculate the fee relative to an implicitly defined \nbase amount (such as a transaction's volume being the base amount for a courtage).\nThe range of one tier is defined as all applicable entities with base amounts X and \nfromBaseAmount \\<\\= X \\<\\= toBaseAmount\nIn any array of fee rules, only one of these entries may be missing the\n\\\"fromBaseAmount\\\" element (indicating that the rule represented by this entry is\nused without a lower bound to the base amount) and only one entry may be missing the\n\\\"toBaseAmount\\\" element (indicating that the rule represented by this entry is applied \nwithout an upper limit to the base amount).\nIn cases, where the fee is not calculated as a tiered percentage, only one entry in array \\\"feeRules\\\" is included.\nThis entry must be missing the subelements \\\"fromBaseAmount\\\" and \\\"toBaseAmount\\\".\nBOI Remarks:\n\\\"fromBaseAmount\\\" and \\\"toBaseAmount\\\" must be displayed if it's set.\n" - $ref: '#/definitions/amount' toBaseAmount: allOf: - description: "To be used for fees where a tiered percentage is used to calculate the fee relative to an implicitly defined \nbase amount (such as a transaction's volume being the base amount for a courtage).\nThe range of one tier is defined as all applicable entities with base amounts X and \nfromBaseAmount \\<\\= X \\<\\= toBaseAmount\nIn any array of fee rules, only one of these entries may be missing the\n\\\"fromBaseAmount\\\" element (indicating that the rule represented by this entry is\nused without a lower bound to the base amount) and only one entry may be missing the\n\\\"toBaseAmount\\\" element (indicating that the rule represented by this entry is applied \nwithout an upper limit to the base amount).\nIn cases, where the fee is not calculated as a tiered percentage, only one entry in array \\\"feeRules\\\" is included.\nThis entry must be missing the subelements \"fromBaseAmount\" and \"toBaseAmount\".\nBOI Remarks:\n\\\"fromBaseAmount\\\" and \\\"toBaseAmount\\\" must be displayed if it's set.\n" - $ref: '#/definitions/amount' minimumAmount: allOf: - description: | Minimum amount of the fee in each billing period / for each billed event, if applicable. BOI Remarks: minumumAmount must be displayed if it's set. - $ref: '#/definitions/amount' maximumAmount: allOf: - description: | Maximum amount of the fee in each billing period / for each billed event, if applicable. BOI Remarks: maximumAmount must be displayed if it's set. - $ref: '#/definitions/amount' error_RFC7807_401_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_401_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_401_AIS' _links: $ref: '#/definitions/_linksAll' MessageCode_403_Generic: description: Generic message codes defined defined for HTTP Error code 403 (FORBIDDEN). type: string enum: - CONSENT_UNKNOWN - SERVICE_BLOCKED - RESOURCE_UNKNOWN - RESOURCE_EXPIRED TypeOfOrderCode: description: | Code set to indicate characteristics of an order.
CodeName Definition
allOrNone A round-lot market or limit-price order which must be executed in its entirety or not at all; unlike 'fill or kill', these orders are not cancelled if not executed as soon as received.
buyContraShortExempt Order to buy contra short exempt.
buyContraShort Order to buy contra short.
buyMinus Order to buy at a price lower than the current market price. This is an order to buy a stated amount of a financial instrument provided that its price is not higher than the last sale if the last sale was a minus or zero minus tick, not higher than the last sale minus the minimum fractional change in the stock if the last sale was a plus or zero plus tick. The price limit indicates the highest price at which the order can be executed.
carefully Order that is not to be executed as a whole because it may disturb the price.
combinationOrder Order that is linked to another order to buy or sell and must be executed as a unit, both or none, or cancelled as a unit.
discretionary Order where the executing broker or investment manager decides on the quantity or price.
doNotIncrease Limit order to buy or stop order to sell or stop limit order that is not to be increased in shares on the ex-dividend date as a result of a stock dividend or distribution.
doNotReduce Limit order to buy or stop order to sell, or stop-limit order to sell that is not to be reduced in price by the amount of an ordinary cash dividend. Applies only to ordinary stock dividends; should be reduced for other distributions.
icebergOrder Type of limit order whose overall quantity is not transparent to the market. Rather, only a client-defined part of the order is shown to the market (the 'tip of the iceberg'). Upon execution of the first 'tip' (that is partial execution to the client while for the market it does not appear to be a 'partial') the system releases the next 'tip' of the same size to the market until the 'iceberg' has been melted down successfully. Different from a usual care order.
limitWith Order to be executed at a limit price, with a round-lot (or board-lot) sales; valid only for odd lot orders.
limitWithout Order to be executed at a limit price, without a round-lot (or board-lot) sales; valid only for odd lot orders.
limitOrder Order to buy at the indicated price limit or lower or an order to sell at the indicated limit price or higher.
atMarket Order to buy or sell a specified amount of a financial instrument at the quoted market price or better.
marketNotHeld Order to buy or sell a specified amount of a financial instrument at the quoted market price or better with some discretion on the price limit.
marketToLimitOrder Type of order that couples the high possibility of execution (Market Order) with a protection against unwanted price fluctuations (Limit Order).
marketUntilTouched Order to buy or sell a specified amount of a financial instrument at the quoted market price or better with some discretion on the price limit.
notHeld Order that may be executed in partials or outside the hours of the exchange or other exchange rules.
orderLie Order that is related to another order where the second order may be cancelled without cancelling the first. Normally, the sell order must be executed before the buy order.
stopLimit Stop order to buy (sell) that becomes a limit order at the limit price when the financial instrument trades at or above (below) the stop price after the order is submitted.
stopOrder Order to buy that becomes a market order when the financial instrument trades at or above the stop price after the order is submitted or an order to sell which becomes a market order when the financial instrument trades at or below the stop price.
stopLoss Order to sell that sets the sell price below the market price.
sellPlus Order to sell a stated amount provided that the price is not lower than the last sale price if the last sale was a plus or zero plus tick and not lower than the last sale minus the minimum fractional change in the financial instrument if the last sale was a minus or zero minus tick.
sellShortExempt Order to sell short which is exempt from short-sale rules.
sellShort Order to sell a financial instrument that the seller does not own; a sale effected by delivering a financial instrument borrowed by or for the account of the seller.
type: string enum: - allOrNone - buyContraShortExempt - buyContraShort - buyMinus - carefully - combinationOrder - discretionary - doNotIncrease - doNotReduce - icebergOrder - limitWith - limitWithout - limitOrder - atMarket - marketNotHeld - marketToLimitOrder - marketUntilTouched - notHeld - orderLie - stopLimit - stopOrder - stopLoss - sellPlus - sellShortExempt - sellShort SecuritiesBalanceType_1_2_11_12_Code: description: | SecuritiesBalanceTypeV2Code from ISO 20022.
CodeName Name Definition
AVAI Available
AWAS AvailableWithNoAdditionalStatus
BTRA BeingTransferred/td>
BLOK Blocked
BLOV BlockedAuthenticity
BLCA BlockedCorporateAction
BLTA BlockedTrading
BORR Borrowed/td>
COLI ColateralIn
COLO ColateralOut
MARG DerivativesMargin
DRAW Drawn/td>
COLA EligibleForCollateralPurposes
TRAN InTransshipment
ISSU Issued
DIRT NonTaxExempt
LOAN OnLoan/td>
REGO OnRegistration
BODE PendingBorrowedDelivery
BORE PendingBorrowedReceipt
PEDA PendingCorporateActionDelivera OnRegistration
PECA PendingCorporateActionReceipt
PEND Pending
PDMT PendingDeliveryMatchedBalance/td>
PDUM PendingDeliveryUnmatchedBalance
LODE PendingOnLoanDelivery
LORE PendingOnLoanReceipt
PENR PendingReceipt
PRMT PendingReceiptMatchedBalance/td>
PRUM PendingReceiptUnmatchedBalance
PLED Pledged
BORE PendingBorrowedReceipt
QUAS QuasiIssued/td>
NOMI Registered
RSTR Restricted
SPOS StreetPosition
CLEN TaxExempt
OTHR Unclassified/td>
UNRG Unregistered
WDOC WaitingDocumentation
type: string enum: - AVAI - AWAS - BTRA - BLOK - BLOV - BLCA - BLOT - BORR - COLI - COLO - MARG - DRAW - COLA - TRAN - ISSU - DIRT - LOAN - REGO - BODE - BORE - PEDA - PECA - PEND - PDMT - PDUM - LODE - LORE - PENR - PRMT - PRUM - PLED - QUAS - NOMI - RSTR - SPOS - CLEN - OTHR - UNRG - WDOC securitiesRelatedFee: description: | Represents a specific fee amount related to a securities transaction. type: object required: - amount properties: typeCode: allOf: - description: "" - $ref: '#/definitions/SecuritiesFeeTypeCode' typeProprietary: allOf: - description: "" - $ref: '#/definitions/Max35Text' amount: allOf: - description: "" - $ref: '#/definitions/amount' _links: allOf: - description: | Links to resources, where the ASPSP can provide additional information on the fee, e.g. an overview on the general fee rules of the underlying securities account. Currently, no specific href types are defined in this context. type: object additionalProperties: $ref: '#/definitions/hrefType' tppMessage_405_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_405_AIS' path: type: string text: $ref: '#/definitions/Max500Text' MessageCode_406_AIS: description: Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE). type: string enum: - REQUESTED_FORMATS_INVALID sourceOfPrice: description: Represents the source of a price for a financial instrument, such as a market. type: object required: - type properties: type: allOf: - $ref: '#/definitions/MarketType4Code' mic: allOf: - description: Date and time of the evaluation. - $ref: '#/definitions/Max4Text' marketIdentifierProprietary: allOf: - description: Date and time of the evaluation. - $ref: '#/definitions/Max35Text' securitiesRelatedDateOrTime: description: | Represents the date / time of an event with specific meaning for securities. type: object required: - type properties: type: allOf: - description: "Can be used as access-ID in the API, where more details on a transaction is offered. \nIf this data attribute is provided, this shows that the AIS can get access on more details \nabout this transaction using the Read Securities Transaction Details Request.\n" - type: string enum: - effectiveSettlementDate - settlementDate - valueDate - performanceDate - bookingDate - transactionDate date: allOf: - description: "" - $ref: '#/definitions/ISODate' dateAndTime: allOf: - description: "" - $ref: '#/definitions/ISODateTime' error_NG_406_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_406_AIS' _links: $ref: '#/definitions/_linksAll' error_NG_405_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_405_AIS' _links: $ref: '#/definitions/_linksAll' MessageCode_409_AIS: description: Message codes defined for AIS for HTTP Error code 409 (CONFLICT). type: string enum: - STATUS_INVALID MessageCode_400_AIS: allOf: - description: Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). - [] evaluatedPrice: description: This data structure represents an evaluated price (e.g. of a security) when an unambiguous balance cannot be provided, but an evaluation, e.g. the total value of a securities deposit. type: object properties: amount: $ref: '#/definitions/amount' percentage: description: Up to 20 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Trailing zeroes must be truncated. type: string pattern: ^-?[0-9]{1,20}(\.[0-9]{0,19})?$ priceDateTime: allOf: - description: Date and time of the evaluation of this price. - $ref: '#/definitions/ISODateTime' priceDate: allOf: - description: Date of the evaluation of this price. - $ref: '#/definitions/ISODate' priceType: allOf: - description: Type of the price. - $ref: '#/definitions/TypeOfPrice17Code' sourceOfPrice: allOf: - description: Indicates the source of the respective price. - $ref: '#/definitions/sourceOfPrice' description: allOf: - description: Additional description of the source of price. E.g., if the source of price indicates a local market, the ASPSP can include the local market's name in this field. - $ref: '#/definitions/Max500Text' exchangeRates: allOf: - description: Relevant exchange rates for the determined price. - type: array items: $ref: '#/definitions/reportExchangeRate' ExternalFinancialInstrumentIdentificationType1Code: description: "ExternalFinancialInstrumentIdentificationType1Code from ISO 20022.\n\n \n \n \n \n \ \n \n \n \n \ \n \n \ \n \n \n \n \n \n \ \n \n \ \n \n \n \n \n \ \n \n \n \ \n \n \n \n \n \n \ \n \n \ \n \n \n \n \ \n \n \n \n \n \ \n \n \n \n \n \ \n \ \n \n \n \n \ \n \n \n \n \n \ \n \n \ \n \n \n \ \n \n \ \n \n \n \n \n \ \n \n \n \n \ \n \n \n \n \ \n \n \n \n \ \n \n \n \n \n \n \ \n \ \n \n \n \n \ \n \n \ \n \n \n \ \n \n \n \n \ \n \n \n \n \n \n \ \n \ \n \n \n \n \n \n \n \ \n \n \n \n
CodeNameNameDefinition
BELCCodeSRWSecretariaatVoorRoerendeWaardenOrSVMSecrétariatDesValeursMobiliÚres\n National securities identification number for BE issued by the National Numbering \n Association SIX Telekurs Belgium.\n
BLOMBloombergTicker-like code assigned by Bloomberg to identify financial instruments.
CCCDOtherNationalSecuritiesIdentificationNumber\n National Securities Identification Number issued by the National Numbering Association for \n a country for which no specific financial instrument identification type code already yet. \n The first two letters of the code represents the country code (for example, EGDC for Egyptian NSIN). \n To be used only until the code is added to the ISO ExternalFinancialInstrumentIdentificationType1Code \n list.\n
CMEDChicagoMercantileExchangeCME\n Ticker-like code assigned by the Chicago Mercantile Exchange to identify \n listed-derivatives instruments.\n
COMMCommonCode\n National securities identification number for ICSDs issued by the National Numbering Association \n Clearstream and Euroclear.\n
CTACConsolidatedTapeAssociationCTATicker-like code assigned by the Consolidated Tape Association to identify financial instruments.
CUSPCommitteeOnUniformSecurityIdentificationProceduresCUSI\n National securities identification number for US and CA issued by the National Numbering Association \n Standard & PoorÂŽs - CUSIP Global Services.\n
FIGCFinancialInstrumentGlobalIdentifierComposite\n A Financial Instrument Global Identifier Composite (FIGC) is a unique, \n persistent twelve character string that serves to identify financial instruments \n across asset classes at the composite level, is associated with one or more FIGI venue \n level ID's and a single Share Class level ID.\n
FIGGFinancialInstrumentGlobalIdentifierShareClass\n A Financial Instrument Global Identifier Share Class (FIGG) is a unique, \n persistent twelve character string that serves to identify financial instruments \n across asset classes at the global share class level, and is associated with one \n or more Composite level ID's.\n
FIGIFinancialInstrumentGlobalIdentifier\n A Financial Instrument Global Identifier (FIGI) is a unique, persistent twelve \n character string that serves to identify financial instruments across asset classes \n at the venue level. It is associated with one Composite ID.\n
ISDUISDAAndFpMLProductURLInSecurityIDURL in Description to identify OTC derivatives instruments.
ISDXISDAAndFpMLProductSpecificationXMLInEncodedSecurityDescXML in Description to identify OTC derivatives instruments.
LCHDLCHClearnetTicker-like code assigned by LCH to identify listed-derivatives instruments.
OCCSOptionsClearingCorpOCCTicker-like code assigned by the Options Clearing Corporation to identify financial instruments.
OPRAOptionsPriceReportingAuthorityOPRA\n Ticker-like code assigned by the Options Price Reporting Authority to \n identify financial instruments.\n
RCMDMarkitRedCodeTicker-like code assigned by Markit to identify listed-derivatives instruments.
RICCReutersInstrumentCodeRICTicker-like code assigned by Thomson Reuters to identify financial instruments.
SEDLStockExchangeDailyOfficialListSEDOL\n National securities identification number for GB issued by the National Numbering Association \n London Stock Exchange.\n
SICCSecuritiesIdentificationCodeCommittee\n National securities identification number for JP issued by the National Numbering Association \n 6 Stock Exchanges and JASDEC (Securities Identification Ticker-like code Committee)\n
TIKRTickerSymbolTSTicker Code assigned by an exchange to identify financial instruments.
VALOVALOR\n National securities identification number for CH and LI issued by the National Numbering Association \n SIX Telekurs Ltd.\n
WKNRWertpapierkennummerWKN\n \ National securities identification number for DE issued by the National Numbering Association \n WM Datenservice.\n
CCDCBondIdentificationCodeListChina\n \ National Bond identification number for China issued by CHINA CENTRAL DEPOSITORY & CLEARING CO.\n , Limited.\n
\n" type: string accountDetailsSecurities: description: | Extended defintion of the \"Account Details\" Structure to represent Securities Accounts. type: object required: - resourceId - currency - cashAccountType - applicableFees properties: resourceId: description: | This is the data element to be used in the path when retrieving data from a dedicated account. type: string iban: allOf: - description: "This data element can be used in the body of the Consent Request Message for retrieving account \naccess consent from this account.\n" - $ref: '#/definitions/IBAN' bban: allOf: - description: "This data element can be used in the body of the Consent Request Message for retrieving account \naccess consent from this account. This data elements is used for payment accounts which have no IBAN.\n" - $ref: '#/definitions/BBAN' msisdn: allOf: - description: "An alias to access an account via a registered mobile phone number. \nThis alias might be needed e.g. in the payment initiation service. \nThe support of this alias must be explicitly documented by the ASPSP \nfor the corresponding API Calls.\n" - $ref: '#/definitions/Max35Text' other: allOf: - description: "In cases where the criteria listed above (IBAN, BBAN, MSISDN) are not provided to identify an \ninstance of the respective account type (e.g. a securities account), the ASPSP shall include a \nproprietary ID of the respective account that uniquely identifies the account for this ASPSP.\n" - $ref: '#/definitions/otherType' currency: allOf: - description: "Account currency. If the (e.g. securities) account does not have a dedicated account currency, \ncode \\\"XXX\\\" is used.\n" - $ref: '#/definitions/CurrencyCode' ownerName: allOf: - description: "Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here.\nFor a corporate account, the corporate name is used for this attribute.\nEven if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit \nconsent to this specific additional account information has been given by the PSU.\nBOI Remarks:\nFor the Israeli market there is no need in explicit consent to this specific additional account information.\n" - $ref: '#/definitions/Max140Text' name: allOf: - description: "Name of the account, as assigned by the ASPSP, in agreement with the account owner in order to provide an additional \nmeans of identification of the account.\n" - $ref: '#/definitions/Max70Text' displayName: allOf: - description: | Name of the account as defined by the PSU within online channels. - $ref: '#/definitions/Max70Text' product: allOf: - description: | Product Name of the ASPSP for this account, proprietary definition. - $ref: '#/definitions/Max35Text' cashAccountType: allOf: - description: "ExternalCashAccountType1Code from ISO 20022. Might be extended by an additional code to indicate \nsecurities accounts. A global definition of a code for securities accounts is intentionally not \nprovided by this document.\nBOI remarks:\nCode for securities: \"SCTS\"\n" - $ref: '#/definitions/ExternalCashAccountType' status: description: | Account status. The value is one of the following: * \"enabled\": account is available * \"deleted\": account is terminated * \"blocked\": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification. type: string enum: - enabled - deleted - blocked bic: allOf: - description: | The BIC associated with the account. - $ref: '#/definitions/BICFI' linkedAccounts: allOf: - description: "This data attribute is a field, where an ASPSP can name a cash account associated with the \n(e.g. securities) account.\n" - $ref: '#/definitions/Max70Text' usage: description: | Specifies the usage of the account: * PRIV: private personal account * ORGA: professional account type: string maxLength: 4 enum: - PRIV - ORGA details: allOf: - description: | Specifications that might be provided by the ASPSP: * characteristics of the account * characteristics of the relevant card * characteristics of the savings account, and the ASPSP will provide specification for each deposit * characteristics of the loan - $ref: '#/definitions/Max500Text' balances: description: | A list of balances regarding this account, e.g. the current balance, the last booked balance. The list might be restricted to the current balance. BOI Remarks: ASPSP must provide at least one balanceType and all balances that presented in the online channels. type: array items: $ref: '#/definitions/balanceSecurities' tariffs: allOf: - description: | Text information on tariffs related to this securities account. - $ref: '#/definitions/Max1000Text' applicableFees: allOf: - description: "Array of elements, each representing one fee (rule) that is individually applicable for this \nSecurities account. If, for example, an ASPSP applies a standard \\\"managementFee\\\" X, but the\nconsumer negotiated a discount D, an element should represent (X-D), but neither X nor D.\n" type: array items: $ref: '#/definitions/securitiesAccountFee' _links: description: "Links to the account, which can be directly used for retrieving account\ninformation from this dedicated account.\nLinks to \\\"positions\\\", \\\"orders\\\" or \\\"transactions\\\".\nThese links are only supported, when the corresponding consent has been already granted. \n" type: object additionalProperties: $ref: '#/definitions/hrefType' properties: positions: $ref: '#/definitions/hrefType' orders: $ref: '#/definitions/hrefType' transactions: $ref: '#/definitions/hrefType' error_NG_403_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_403_AIS' _links: $ref: '#/definitions/_linksAll' error_RFC7807_409_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_409_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_409_AIS' _links: $ref: '#/definitions/_linksAll' error_NG_429_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_429_AIS' _links: $ref: '#/definitions/_linksAll' TransactionActivityType1Code: description: "TransactionActivityType1Code from ISO 20022.\nCompare \nISO 20022\nSettlement And Reconciliation - ISO - Maintenace 2019 - 2020\nMessage Definition Report - Part 2\nApproved by the Securities SEG on the 27th of January 2020:\n\n \n \n \n \n \ \n \n \n \n \ \n \n \n \n \ \n \n \n \n \n \n \n \n \n \ \n \n \n \n \n \n \ \n \n
CodeNameNameDefinition
BOLEBorrowingLendingActivityTransaction relates to lending/borrowing.
CLAIMarketClaimTransaction relates to a market claim following a corporate action.
COLLCollateralActivity/td>\n \ Transaction relates to collateral.
CORPCorporateActionActivityTransaction relates to corporate action.
SETTSettlementandClearingActivityTransaction relates to settlement and clearing.
\n" type: string enum: - BOLE - CLAI - COLL - CORP - SETT ExternalCashAccountType: description: | ExternalCashAccountType1Code from ISO 20022. type: string enum: - CACC - CARD - LOAN - SVGS - SCTS BICFI: description: | BICFI type: string pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$ example: AAAADEBBXXX Max1000Text: type: string maxLength: 1000 _links_200_SecuritiesOrders: type: object additionalProperties: $ref: '#/definitions/hrefType' properties: first: $ref: '#/definitions/hrefType' next: $ref: '#/definitions/hrefType' previous: $ref: '#/definitions/hrefType' last: $ref: '#/definitions/hrefType' CountryCode: description: ISO 3166 ALPHA2 country code. type: string pattern: ^[A-Z]{2}$ example: SE Max140Text: type: string maxLength: 140 MarketType4Code: description: "MarketType4Code from ISO 20022.\nCompare \nISO 20022\nSettlement And Reconciliation - ISO - Maintenace 2019 - 2020\nMessage Definition Report - Part 2\nApproved by the Securities SEG on the 27th of January 2020:\n\n \n \n \n \n \ \n \n \n \n \n \n \n \n \ \n \n \n \ \n \n \n \ \n \n \n \n \n \n
CodeNameNameDefinition
FUNDFundThe place is a fund (transfer agent, fund itself, etc.).
LMARLocalMarketThe place is a local market.
THEOTheoretical/td>\n The place is theoretical.
VENDVendorThe place is a vendor.
\n" type: string enum: - FUND - LMAR - THEO - VEND financialInstrument: description: This data structure represents financial instrument. type: object properties: isin: allOf: - description: | ISIN of the financial Instrument. - $ref: '#/definitions/ISIN' other: allOf: - description: | If an ISIN is not available, the ASPSP may instead include an identification by other means. - $ref: '#/definitions/otherFinancialInstrumentIdentification' name: allOf: - description: | Name of the financial instrument. BOI Remarks: Suppose to be equivalent to the name in the stock exchange. - $ref: '#/definitions/Max70Text' normalisedPrice: allOf: - description: "Price per unit of the financial instrument in case of a price amount. Percentage price otherwise.\nIf used in the context of a transaction, the price here shall indicate the applied price \n(without fees) for the trade.\n" - $ref: '#/definitions/evaluatedPrice' error_RFC7807_405_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_405_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_405_AIS' _links: $ref: '#/definitions/_linksAll' marketIdentification: description: Identification of a market for financial instruments. type: object properties: mic: allOf: - description: Date and time of the evaluation. - $ref: '#/definitions/Max4Text' marketIdentifierProprietary: allOf: - description: Date and time of the evaluation. - $ref: '#/definitions/Max35Text' MessageCode_404_AIS_Securities: allOf: - description: Message codes defined for AIS for HTTP Error code 404 (NOT FOUND). - [] tppMessage_401_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_401_AIS' path: type: string text: $ref: '#/definitions/Max500Text' amount: type: object required: - currency - amount properties: currency: $ref: '#/definitions/CurrencyCode' amount: description: | The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78 type: string pattern: ^-?[0-9]{1,14}(\.[0-9]{1,3})?$ example: "5877.78" example: currency: EUR amount: "123" reportExchangeRate: description: Exchange Rate. type: object required: - sourceCurrency - exchangeRate - unitCurrency - targetCurrency - quotationDate properties: sourceCurrency: allOf: - description: "" - $ref: '#/definitions/CurrencyCode' exchangeRate: allOf: - description: "" - type: string unitCurrency: allOf: - description: "" - $ref: '#/definitions/CurrencyCode' targetCurrency: allOf: - description: "" - $ref: '#/definitions/CurrencyCode' quotationDate: allOf: - description: "" - $ref: '#/definitions/ISODate' contractIdentification: allOf: - description: "" - $ref: '#/definitions/Max35Text' tppMessage_404_AIS_Securities: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_404_AIS_Securities' path: type: string text: $ref: '#/definitions/Max500Text' OrderStatusCode: description: "Code set to identify the status of an order. \n\n \ \n \n \n \n \n \n \ \n \n \ \n \n \n \ \n \n \n \n \n \n \n \ \n \n \n \ \n \n \n \n \n \ \n \n \n \n \ \n \ \n \n \n \n \ \n \n \n \n \n \ \n \n \n \n \ \n \n \n \n \n \n \ \n \n \n \n \ \n \n \ \n \n \n \n \n \n \ \n \n \ \n \n \n \n
CodeNameDefinition
unknownthe status of this order can currently not be determined
newOutstanding order with no executions
partiallyFilledOutstanding order with executions and remaining quantity
filledOrder completely filled, no remaining quantity
doneForDayOrder not, or partially, filled; no further executions forthcoming for the trading day
canceledCancelled order with or without executions
replacedCancelled order due to a replacement with or without executions
pendingCancelOrder with a request for cancellation pending. Does not indicate that the order has been cancelled.
stoppedOrder has been stopped at the exchange. Used when guaranteeing or protecting a price and quantity
rejectedOrder has been rejected by sell-side (broker, exchange, ECN). NOTE: An order can be rejected subsequent to order acknowledgment, i.e. an order can pass from New to Rejected status.
suspendedOrder has been placed in suspended state at the request of the client.
pendingNewOrder has been received by sell-side's (broker, exchange, ECN) system but not yet accepted for execution.
calculatedOrder has been completed for the day (either filled or done for day). Commission or currency settlement details have been calculated
expiredOrder has been cancelled in broker's system due to time in force instructions.
acceptedForBiddingOrder has been received and is being evaluated for pricing.
pendingReplaceOrder with an Order Cancel/Replace Request pending.
\n" type: string enum: - unknown - new - partiallyFilled - filled - doneForDay - canceled - replaced - pendingCancel - stopped - rejected - suspended - pendingNew - calculated - expired - acceptedForBidding - pendingReplace _links_200_SecuritiesTransactions: type: object additionalProperties: $ref: '#/definitions/hrefType' properties: first: $ref: '#/definitions/hrefType' next: $ref: '#/definitions/hrefType' previous: $ref: '#/definitions/hrefType' last: $ref: '#/definitions/hrefType' MessageCode_404_Generic: description: Generic message codes defined for HTTP Error code 404 (NOT FOUND). type: string enum: - RESOURCE_UNKNOWN SecuritiesFeeTypeCode: description: "List of supported Fee Type Codes in the context of securities. \nMight be changed based on market experience with the API.\n" type: string enum: - transactionFee - brokerageFee - managementFee - courtage - custodyFee - exchangeRate - thirdPartyFee - otherFee ISIN: type: string description: "International Securities Identification Number (ISIN). A numbering system designed by the United Nation's \nInternational Organisation for Standardisation (ISO). The ISIN is composed of a 2-character prefix \nrepresenting the country of issue, followed by the national security number (if one exists), and a \ncheck digit. Each country has a national numbering agency that assigns ISIN numbers for securities in \nthat country.\n" pattern: ^[A-Z0-9]{12,12}$ otherType: description: In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP. type: object required: - identification properties: identification: allOf: - description: Proprietary identification of the account. - $ref: '#/definitions/Max35Text' issuer: allOf: - description: Issuer of the identification. - $ref: '#/definitions/Max35Text' schemeNameProprietary: allOf: - description: A scheme name defined in a proprietary way. - $ref: '#/definitions/Max35Text' schemeNameCode: allOf: - description: An entry provided by an external ISO code list. - $ref: '#/definitions/Max35Text' MessageCode_401_AIS: allOf: - description: Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). - [] ISODate: type: string format: date BBAN: description: "Basic Bank Account Number (BBAN) Identifier.\nThis data element can be used in the body of the consent request.\n Message for retrieving account access consent from this account. This\n data elements is used for payment accounts which have no IBAN.\n ISO20022: Basic Bank Account Number (BBAN). \n Identifier used nationally by financial institutions, i.e., in individual countries, \n generally as part of a National Account Numbering Scheme(s), \n which uniquely identifies the account of a customer.\n" type: string pattern: ^[a-zA-Z0-9]{1,30}$ example: BARC12345612345678 error_RFC7807_406_AIS: description: | Standardised definition of reporting error information according to [RFC7807]. type: object required: - type - code properties: type: description: "A URI reference [RFC3986] that identifies the problem type. \nRemark For Future: These URI will be provided by NextGenPSD2 in future.\n" type: string format: uri maxLength: 70 title: $ref: '#/definitions/Max70Text' detail: description: | $ref: '#/components/schemas/Max500Text' code: $ref: '#/definitions/MessageCode_406_AIS' additionalErrors: description: | Array of Error Information Blocks. Might be used if more than one error is to be communicated type: array items: description: This is a data element to support the declaration of additional errors in the context of [RFC7807]. type: object required: - code properties: title: $ref: '#/definitions/Max70Text' detail: $ref: '#/definitions/Max500Text' code: $ref: '#/definitions/MessageCode_406_AIS' _links: $ref: '#/definitions/_linksAll' tppMessage_400_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_400_AIS' path: type: string text: $ref: '#/definitions/Max500Text' securitiesOrder: description: | Represents a securities order. type: object required: - side - financialInstrument - orderStatus properties: orderId: allOf: - description: "Can be used as access-ID in the API, where more details on an order is offered. \nIf this data attribute is provided, this shows that the AIS can get access on more \ndetails about this transaction using the Read Securities Transaction Details Request.\n*Remark:* In anticipation of future services where orders might be placed or revoked via the \nopenFinance API, the orderId should be defined in a way that it will also identify an order in \nthe case of a placement / cancellation, if the ASPSP intends to support those use cases, as well.\n" - type: string side: allOf: - description: | Type of transaction that is associated with this order. - $ref: '#/definitions/SecuritiesOrderSide' financialInstrument: allOf: - description: | Financial instrument the order refers to. - $ref: '#/definitions/financialInstrument' unitsNumberOrder: allOf: - description: | Numeric quantification of the financial instrument that is ordered. BOI Remarks: Even if the status of the order is partial, the full value will be displayed. - type: number unitsNominalOrder: allOf: - description: | Nominal quantification of the financial instrument that is ordered. BOI Remarks: Even if the status of the order is partial, the full value will be displayed. - $ref: '#/definitions/amount' unitsNumberDisplay: allOf: - description: | Numeric quantification of the order that shall be displayed. - type: number unitsNominalDisplay: allOf: - description: | Nominal quantification of the order that shall be displayed. - $ref: '#/definitions/amount' placeOfTrade: allOf: - description: "" - $ref: '#/definitions/marketIdentification' limitPriceAmount: description: | BOI Remarks: Limit price must be displayed if it set. $ref: '#/definitions/amount' limitPricePercent: description: | Up to 20 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Trailing zeroes must be truncated. BOI Remarks: Limit price must be displayed if it set. type: string pattern: ^-?[0-9]{1,20}(\.[0-9]{0,19})?$ stopPriceAmount: description: | BOI Remarks: Stop price must be displayed if it set. $ref: '#/definitions/amount' stopPricePercent: description: | Up to 20 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Trailing zeroes must be truncated. BOI Remarks: Stop price must be displayed if it set. type: string pattern: ^-?[0-9]{1,20}(\.[0-9]{0,19})?$ tradingSessionIndicator: allOf: - description: | Type of transaction that is associated with this order. - $ref: '#/definitions/TradingSessionTypeCode' typesOfOrder: allOf: - description: | One or more Codes to indicate characteristics of the order. - type: array items: $ref: '#/definitions/TypeOfOrderCode' timeInForce: allOf: - description: "If the order is restricted by a time limit, the type time limit is indicated by a value of \nthe corresponding code set.\n" - $ref: '#/definitions/OrderTimeLimitCode' expiryDate: allOf: - description: | Date, when the order expires, if applicable. BOI Remarks: Expiry date must be displayed if it set. - $ref: '#/definitions/ISODate' expiryDateTime: allOf: - description: | Date and time, when the order expires, if applicable. BOI Remarks: Expiry date time must be displayed if it set. - $ref: '#/definitions/ISODateTime' relatedCashAccount: allOf: - description: "If the execution of this order implies the transfer of money, cash account to be affected by this \ntransfer from the PSU's side.\n" - $ref: '#/definitions/accountReference' orderSplit: allOf: - description: | Value true indicates that this order is the result of an order split. Missing values indicate \"false\". - type: boolean orderModifyable: allOf: - description: | Value true indicates that this order can (still) be modified. Missing values indicate \"false\". - type: boolean orderStatus: allOf: - description: | Status of the order. - $ref: '#/definitions/OrderStatusCode' details: allOf: - description: | Additional details to the order. - $ref: '#/definitions/Max500Text' _links: allOf: - description: "" - type: object properties: relatedOrders: allOf: - description: | An array of links to request order details of related orders (e.g. other orders that originated from the same order split as this order). Only applicable, if the ASPSP supports the Read Securities Order Details endpoint. - type: array items: $ref: '#/definitions/hrefType' relatedTransactions: allOf: - description: "An array of links to request securities transaction details of transactions that resulted\nfrom this order. \nOnly applicable, if the ASPSP supports the Read Securities Transaction Details endpoint.\n" - type: array items: $ref: '#/definitions/hrefType' orderDetails: allOf: - description: "Single link for retrieving details on this specific order. \nOnly applicable, if the ASPSP supports the Read Securities Order Details endpoint.\n" - $ref: '#/definitions/hrefType' error_NG_401_AIS: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_401_AIS' _links: $ref: '#/definitions/_linksAll' error_NG_404_AIS_Securities: type: object properties: tppMessages: type: array items: $ref: '#/definitions/tppMessage_404_AIS_Securities' _links: $ref: '#/definitions/_linksAll' tppMessage_409_AIS: type: object required: - category - code properties: category: $ref: '#/definitions/TppMessageCategory' code: $ref: '#/definitions/MessageCode_409_AIS' path: type: string text: $ref: '#/definitions/Max500Text' ISODateTime: type: string format: date-time TypeOfPrice17Code: description: "TypeOfPrice17Code from ISO 20022.\nCompare \nISO 20022\nSettlement And Reconciliation - ISO - Maintenace 2019 - 2020\nMessage Definition Report - Part 2\nApproved by the Securities SEG on the 27th of January 2020:\n\n \n \n \n \n \ \n \n \n \n \n \n \ \n \n \n \n \ \n \n \n \n \n \n \n \n \ \n \n \n \n \n \n \n \n \n \n \n \ \n \n \n \n \n \ \n \n \n \n \n \n \n \n \ \n \n \n \n \n \n \ \n \n \n \n \n \n \ \n \n \n \n \ \n \n \ \n \n \n \n \n \n \n \n \n \n \n
CodeNameNameDefinition
BIDEBid\n Price is the calculated bid price of a dual-priced fund (offer-bid prices), that is, \n the selling price of the units for the investor.\n
OFFROffer\n Price is the calculated offer price of a dual-priced investment fund (offer-bid prices), \n that is, the buying price of the units for an investor.\n
NAVLNetAssetValue\n Price is the net asset value per unit that is used either as a transacting price for a single-priced \n investment fund class, or as a notional price for the calculation of other prices.\n
CREACreation\n Price is the calculated creation price of a dual-priced investment fund (creation-cancellation \n prices) and the highest possible buying price of the units before the initial charge. \n \ The actual buying or offer price, which includes charges, will be higher.\n \
CANCCancellation\n \ Price is the calculated cancellation price of a dual-priced investment fund (creation-cancellation \n price), and the lowest possible valuation of the units on any one-day. \n The actual selling or bid price is usually higher.\n
INTEInterimPrice is the non-official interim price given to an investor before the executed price.
SWNGSwing\n Price is the calculated net asset value price of a single-priced investment fund.\n The price is adjusted to take into accountthe dealing costs due to individual large\n deals, or due to a significant imbalance in volumes of subscriptions vs redemptions, \n as an alternative to dilutionlevy.\n \
MIDDMidPrice is the average price between the bid and offer prices.
RINVReinvestmentPrice is the price used when reinvesting units after distribution.
SWICSwitchPrice is the price used when transferring units between products.
MRKTMarketPrice is the current market price.
INDCIndicativePrice is the estimated indicative price.
DDVRDailyDividendRate\n \ Price is the net income of a financial instrument, calculated on each dealing\n day, and divided by all the units outstanding on that day.\n \
ACTUActualTrue offer price.
\n" type: string enum: - BIDE - OFFR - NAVL - CREA - CANC - INTE - SWNG - MIDD - RINV - SWIC - MRKT - INDC - DDVR - ACTU securitiesAccountFee: description: | Represents the parameters of a given type of fee as they apply to the securities account. type: object required: - feeRules properties: typeCode: allOf: - description: | Type of the fee as a code. Might be adjusted in the future based on market experience. - $ref: '#/definitions/SecuritiesFeeTypeCode' typeProprietary: allOf: - description: | Type of the fee as a proprietary string. - $ref: '#/definitions/Max35Text' feeRules: allOf: - description: | Array of fee rules. Each rule represents ow the amount of the fee is determined either explicitly by stating the amount or implicitly by providing a percentage, minimum and maximum amount. This array will usually only contain one entry to represent the whole rule. Only in the case of the fee being calculated as a tiered percentage, several entries are included to represent the several tiers of the fee rule. - type: array items: $ref: '#/definitions/securitiesAccountFeeRule' applicableFrom: allOf: - description: | First date, when this fee is applicable. If not present, the fee is applicable starting with the creation of this account / the latest reporting date supported by the ASPSP. BOI Remarks: applicableFrom must be displayed if it's set. - $ref: '#/definitions/ISODateTime' applicableTo: allOf: - description: | Last date, when this fee is applicable. If not present, the fee is applicable indefinitely. BOI Remarks: applicableTo must be displayed if it's set. - $ref: '#/definitions/ISODateTime' additionalInformation: allOf: - description: "" - $ref: '#/definitions/Max500Text' Max4Text: type: string maxLength: 4 OrderTimeLimitCode: description: "Code set to identify the time an order shall be in force. \n" type: string enum: - day - goodTillCancel - atTheOpening - immediateOrCancel - fillOrKill - fillAndKill - goodTillCrossing - goodTillDate - atTheClose - goodThroughCrossing - atCrossing - goodForTime - goodForAuction - goodForMonth security: - oauth2: - balances-SCTS - accounts-SCTS - transactions-SCTS securityDefinitions: oauth2: type: oauth2 description: "" flow: accessCode scopes: balances-SCTS: data balances accounts-SCTS: data account access transactions-SCTS: data transactions authorizationUrl: "" tokenUrl: "" x-ibm-configuration: enforced: true testable: true phase: realized x-ibm-endpoints: - endpointUrl: https://mtls-api.discountbank.co.il/prod/d type: - production - development ...