Get account transactions
GET/v1/accounts/:id/transactions
It is possible to filter the transactions by using query parameters:
-
bookingStatus
can be used to get only booked transactions, only pending transactions, or both/all transactions. -
dateFrom
anddateTo
is used to get transactions within a given timeframe. These parameters are optional, but recomended to use because increases resilience to change with the ASPSP systems and increases performance.
Note that dateFrom is required, and if omitted a default value will be used.
Parameters offset
and limit
is used for pagination. It is recomended to follow the "next" and "previous" links from the response for subsequent requests.
Offset is the offset from the first transaction in the query and limit is the max amount of transactions to return.
These parameters are also recomended to use for the same reason as dateFrom and dateTo.
For optimal performance it is recommended to keep the limit to a number between 100 and 200.
In any case the "next" and "previous" links will be generated to promote performance.
Requests without the PSU present is allowed for tranactions within the last 90 days. Limited to 4 calls within a 24 hour period, requiring a PSU consent that is no more than 180 days old.
Example:
This request gets the first 10 transactions for the 1st and 2nd of January 2024:
https://psd2.sbh.no/api/v1/accounts/enc!!encoded-account-reference/transactions?bookingStatus=both&dateFrom=2024-01-01&dateTo=2024-01-02&offset=0&limit=10
To get the next 10 transactions change the offset to 10 (so you skip the first 10 you already got), but keep the limit at 10 because you still want 10 transactions:
https://psd2.sbh.no/api/v1/accounts/enc!!encoded-account-reference/transactions?bookingStatus=both&dateFrom=2024-01-01&dateTo=2024-01-02&offset=10&limit=10
See XS2A Framework Implementation Guidelines, Section 6.6.5 for additional details.
Request
Path Parameters
Resource ID.
Query Parameters
Possible values: [booked
, pending
, both
, all
]
Transactions with booking status
Transactions not before
Transactions not after
Offset into transaction list
Possible values: >= 1
Limit number of transactions to specified count
Header Parameters
- keyId must be formatted as
keyId="SN=XXX,CA=YYY"
whereXXX
is the serial number of the signing certificate in hexadecimal encoding andYYY
is the full Distinguished Name of the Certificate Authority having certificate - algorithm must identify the same algorithm for the signature as presented in the signing certificate and should be
rsa-sha256
- headers must contain
date
,digest
,x-request-id
,psu-id
,psu-corporate-id
, andtpp-redirect-uri
when available - signature must be computed as
Base64(RSA-SHA256(signingString))
Make a published future breaking change active before the date when it is going to be made default, for adopting changes early. (see Future Breaking Changes)
Advertises which content types, expressed as MIME types, the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Advertises which character set the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice within the Content-Type response header.
Advertises which content encoding, usually a compression algorithm, the client is able to understand. Using content negotiation, the server selects one of the proposals, uses it and informs the client of its choice with the Content-Encoding response header.
Advertises which natural languages the client is able to understand, and which locale variant is preferred. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Language response header.
The domain name of the server (for virtual hosting), and (optionally) the TCP port number on which the server is listening.
Request identifier unique to the call generated by the TPP.
TPP session identifier.
Call back URI of the TPP, where the transaction flow shall be redirected to after a Redirect.
Set to false to automatically trigger biometric authentication for mobile apps whenever available. Default is true.
The certificate used for signing the request in base64 encoding.
HTTP Message Signature as specified by https://tools.ietf.org/html/draft-cavage-http-signatures-10 with requirements imposed by Berlin Group's NextGenPSD2 Framework.
If any value in the Signature header is ISO-8859-1 or UTF-8 encoded, the Signature header needs to be URL encode compliant to RFC-2047, which means MIME encoding the signature.
Also, the signature must be wrapped using this format: =?charset?encoding?encoded signature?=
Example of this encoding: =?utf-8?B?a2V5QTQsQ0E9Mi41LjQuOTc9IzB........jMTM1MDUzNDQ0ZTRmMmQ0NjUz?=
Java example of how to implement encoding:
if (charset.equals(StandardCharsets.UTF_8)) {
Signature = String.format("=?utf-8?B?%s?=", Base64.getEncoder().encodeToString(signature.getBytes(StandardCharsets.UTF_8)));
}
The PSU identifier.
The PSU Corporate agreement identifier.
Possible values: [PRIVATE
, CORPORATE
]
Explicitly set PSU context. If not set the PSU is promted to select context when performing SCA the first time
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded value for the User-Agent header field between the PSU and TPP, if available.
The forwarded value for the Accept header field between the PSU and TPP, if available.
The forwarded value for the Accept-Charset header field between the PSU and TPP, if available.
The forwarded value for the Accept-Encoding header field between the PSU and TPP, if available.
The forwarded value for the Accept-Language header field between the PSU and TPP, if available.
The forwarded value for the HTTP method used between the PSU and TPP, if available.
The forwarded value of the device ID used by the PSU, if available.
The forwarded value of the Geo Location of the corresponding HTTP request between the PSU and TPP, if available.
Responses
- 200
- 400
- 401
- 404
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
]
Array [
Array [
Array [
]
]
Array [
]
]
transactions
object
booked
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services. If this indicator equals true, then the related entry is a batch entry.
This is only available for a corporate context and is not always available, depending on support in underlying services. Shall be used if and only if the batchIndicator is contained and equals true.
entryDetails
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services. Might be used by the ASPSP to transport details about transactions within a batch. Only available from transaction details if there are related batched transactions.
transactionAmount
object
required
Note that even though the contract sets a precision of 18 and a scale of 5, the provided fraction digits must adhere to the minor units as defined in ISO 4217 for the provided currency code.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 70 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
creditorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 70 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
debtorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 140 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
Possible values: <= 140 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
remittanceInformationStructuredArray
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services.
Possible values: <= 35 characters
Possible values: <= 35 characters
Possible values: <= 35 characters
_links
object
Link to the transaction details of this batch transaction. This is only available for a corporate context and is not always available, depending on support in underlying services.
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
Possible values: >= 4 characters
and <= 14 characters
ISO20022 Bank Transaction Code available if supported by underlying services
Transaction ID for identification of account transaction.
Possible values: <= 35 characters
Unique end to end identity of this transaction.
transactionAmount
object
Note that even though the contract sets a precision of 18 and a scale of 5, the provided fraction digits must adhere to the minor units as defined in ISO 4217 for the provided currency code.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
currencyExchange
object
Exchange rate details between two currencies for a specific date.
From currency.
Conversion factor from source to target currency.
Base currency of exchange rate (I.e. in 1 EUR = nnnNOK, EUR is unit)
To currency
Quotation date of the exchange rate.
Unique identification of foreign exchange contract.
Possible values: <= 35 characters
This information is not offered by current implementation.
Possible values: <= 70 characters
Not always available, depending on support in underlying services.
creditorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: Value must match regular expression ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
Business identifier code of financial institution.
Possible values: <= 70 characters
This information is not offered by current implementation.
Possible values: <= 70 characters
Not always available, depending on support in underlying services.
debtorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: Value must match regular expression ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
Business identifier code of financial institution.
Possible values: <= 70 characters
This information is not offered by current implementation.
Possible values: <= 140 characters
Not always available, depending on support in underlying services.
Possible values: non-empty
and <= 4 characters
ISO20022 Purpose Code available if supported by underlying services.
Possible values: <= 35 characters
Not always available, depending on support in underlying services.
Possible values: <= 140 characters
Not always available, depending on support in underlying services.
remittanceInformationStructuredArray
object[]
Not always available, depending on support in underlying services.
Possible values: <= 35 characters
Possible values: <= 35 characters
Possible values: <= 35 characters
_links
object
Link to a transaction detail. This is only available for a corporate context and is not always available, depending on support in underlying services.
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
pending
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services. If this indicator equals true, then the related entry is a batch entry.
This is only available for a corporate context and is not always available, depending on support in underlying services. Shall be used if and only if the batchIndicator is contained and equals true.
entryDetails
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services. Might be used by the ASPSP to transport details about transactions within a batch. Only available from transaction details if there are related batched transactions.
transactionAmount
object
required
Note that even though the contract sets a precision of 18 and a scale of 5, the provided fraction digits must adhere to the minor units as defined in ISO 4217 for the provided currency code.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 70 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
creditorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 70 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
debtorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: <= 140 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
Possible values: <= 140 characters
This is only available for a corporate context and is not always available, depending on support in underlying services.
remittanceInformationStructuredArray
object[]
This is only available for a corporate context and is not always available, depending on support in underlying services.
Possible values: <= 35 characters
Possible values: <= 35 characters
Possible values: <= 35 characters
_links
object
Link to the transaction details of this batch transaction. This is only available for a corporate context and is not always available, depending on support in underlying services.
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
Possible values: >= 4 characters
and <= 14 characters
ISO20022 Bank Transaction Code available if supported by underlying services
Transaction ID for identification of account transaction.
Possible values: <= 35 characters
Unique end to end identity of this transaction.
transactionAmount
object
Note that even though the contract sets a precision of 18 and a scale of 5, the provided fraction digits must adhere to the minor units as defined in ISO 4217 for the provided currency code.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
currencyExchange
object
Exchange rate details between two currencies for a specific date.
From currency.
Conversion factor from source to target currency.
Base currency of exchange rate (I.e. in 1 EUR = nnnNOK, EUR is unit)
To currency
Quotation date of the exchange rate.
Unique identification of foreign exchange contract.
Possible values: <= 35 characters
This information is not offered by current implementation.
Possible values: <= 70 characters
Not always available, depending on support in underlying services.
creditorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: Value must match regular expression ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
Business identifier code of financial institution.
Possible values: <= 70 characters
This information is not offered by current implementation.
Possible values: <= 70 characters
Not always available, depending on support in underlying services.
debtorAccount
object
Possible values: <= 30 characters
Identifier that uniquely identifies an individual account at a specific financial institution in a particular country, and which includes a bank identifier of the financial institution servicing that account.
Possible values: <= 34 characters
Expanded version of the basic bank account number (BBAN), structured as defined by ISO 13616-1:2007, intended for use internationally, which uniquely identifies an individual account at a specific financial institution, in a particular country.
Possible values: [AED
, AFN
, ALL
, AMD
, ANG
, AOA
, ARS
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, BWP
, BYR
, BZD
, CAD
, CDF
, CHF
, CLP
, CNY
, COP
, CRC
, CUC
, CUP
, CVE
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, ERN
, ETB
, EUR
, FJD
, FKP
, GBP
, GEL
, GGP
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, IMP
, INR
, IQD
, IRR
, ISK
, JEP
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MAD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, NGN
, NIO
, NOK
, NPR
, NZD
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SPL
, SRD
, STD
, SVC
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TVD
, TWD
, TZS
, UAH
, UGX
, USD
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, XAF
, XCD
, XDR
, XOF
, XPF
, YER
, ZAR
, ZMW
, ZWD
]
ISO 4217 Alphabetic Currency Code.
Possible values: Value must match regular expression ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
Business identifier code of financial institution.
Possible values: <= 70 characters
This information is not offered by current implementation.
Possible values: <= 140 characters
Not always available, depending on support in underlying services.
Possible values: non-empty
and <= 4 characters
ISO20022 Purpose Code available if supported by underlying services.
Possible values: <= 35 characters
Not always available, depending on support in underlying services.
Possible values: <= 140 characters
Not always available, depending on support in underlying services.
remittanceInformationStructuredArray
object[]
Not always available, depending on support in underlying services.
Possible values: <= 35 characters
Possible values: <= 35 characters
Possible values: <= 35 characters
_links
object
Link to a transaction detail. This is only available for a corporate context and is not always available, depending on support in underlying services.
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
_links
object
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
{
"transactions": {
"booked": [
{
"batchIndicator": true,
"batchNumberOfTransactions": 0,
"entryDetails": [
{
"transactionAmount": {
"amount": "100.26",
"currency": "NOK"
},
"creditorName": "Ola Nordmann",
"creditorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"debtorName": "Kari Hansen",
"debtorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"remittanceInformationUnstructuredArray": [
"string"
],
"remittanceInformationStructuredArray": [
{
"reference": "010022062838329290202022",
"referenceType": "SCOR",
"referenceIssuer": "BITS"
}
],
"_links": {
"self": {
"href": "https://psd2.sbh.no/",
"verbs": [
"GET"
]
}
}
}
],
"bankTransactionCode": "PMNT-RDDT-ESDD",
"transactionId": "string",
"endToEndId": "string",
"bookingDate": "2018-09-01",
"valueDate": "2018-09-01",
"transactionAmount": {
"amount": "100.26",
"currency": "NOK"
},
"currencyExchange": {
"sourceCurrency": "EUR",
"exchangeRate": "string",
"unitCurrency": "string",
"targetCurrency": "NOK",
"quotationDate": "2024-07-29",
"contractIdentification": "string"
},
"creditorId": "xxxxx",
"creditorName": "Ola Nordmann",
"creditorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"creditorAgent": "string",
"ultimateCreditor": "Some Company ABC",
"debtorName": "Kari Hansen",
"debtorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"debtorAgent": "string",
"ultimateDebtor": "Some Company ABC",
"remittanceInformationUnstructured": "Kredittrente",
"purposeCode": "SALA",
"proprietaryBankTransactionCode": "xxxx",
"remittanceInformationUnstructuredArray": [
"string"
],
"remittanceInformationStructuredArray": [
{
"reference": "010022062838329290202022",
"referenceType": "SCOR",
"referenceIssuer": "BITS"
}
],
"_links": {
"self": {
"href": "https://psd2.sbh.no/",
"verbs": [
"GET"
]
}
}
}
],
"pending": [
{
"batchIndicator": true,
"batchNumberOfTransactions": 0,
"entryDetails": [
{
"transactionAmount": {
"amount": "100.26",
"currency": "NOK"
},
"creditorName": "Ola Nordmann",
"creditorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"debtorName": "Kari Hansen",
"debtorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"remittanceInformationUnstructured": "Kredittrente",
"remittanceInformationUnstructuredArray": [
"string"
],
"remittanceInformationStructuredArray": [
{
"reference": "010022062838329290202022",
"referenceType": "SCOR",
"referenceIssuer": "BITS"
}
],
"_links": {
"self": {
"href": "https://psd2.sbh.no/",
"verbs": [
"GET"
]
}
}
}
],
"bankTransactionCode": "PMNT-RDDT-ESDD",
"transactionId": "string",
"endToEndId": "string",
"bookingDate": "2018-09-01",
"valueDate": "2018-09-01",
"transactionAmount": {
"amount": "100.26",
"currency": "NOK"
},
"currencyExchange": {
"sourceCurrency": "EUR",
"exchangeRate": "string",
"unitCurrency": "string",
"targetCurrency": "NOK",
"quotationDate": "2024-07-29",
"contractIdentification": "string"
},
"creditorId": "xxxxx",
"creditorName": "Ola Nordmann",
"creditorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"creditorAgent": "string",
"ultimateCreditor": "Some Company ABC",
"debtorName": "Kari Hansen",
"debtorAccount": {
"bban": "95360573002",
"iban": "NO0995360573002",
"currency": "NOK"
},
"debtorAgent": "string",
"ultimateDebtor": "Some Company ABC",
"remittanceInformationUnstructured": "Kredittrente",
"purposeCode": "SALA",
"proprietaryBankTransactionCode": "xxxx",
"remittanceInformationUnstructuredArray": [
"string"
],
"remittanceInformationStructuredArray": [
{
"reference": "010022062838329290202022",
"referenceType": "SCOR",
"referenceIssuer": "BITS"
}
],
"_links": {
"self": {
"href": "https://psd2.sbh.no/",
"verbs": [
"GET"
]
}
}
}
],
"_links": {
"self": {
"href": "https://psd2.sbh.no/",
"verbs": [
"GET"
]
}
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"FORMAT_ERROR": {
"id": "5615873375",
"status": 400,
"system": "ERA-PSD2",
"code": "FORMAT_ERROR"
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
_links
object
property name*
Link
Possible values: [GET
, PUT
, POST
, DELETE
]
{
"_links": {}
}
When the TPP must redirect the PSU in order to perform SCA
{
"_links": {
"scaRedirect": {
"href": "https://psd2.sbh.no/tap?route_secesb_id=1&flow=psd2&state=ca477daf-d824-4f0b-b405-6c8fc385dc0b&locale=no-NB, no; q=1.0",
"verbs": [
"GET"
]
}
},
"summary": "When the TPP must redirect the PSU in order to perform SCA"
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"unknown": null,
"id": "5615873376",
"system": "ERA-PSD2",
"status": 404,
"code": "RESOURCE_UNKNOWN",
"message": "Account not found."
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873377",
"system": "ERA-PSD2",
"status": 429,
"code": "ACCESS_EXCEEDED"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"id": "5884127160",
"system": "ERA-PSD2",
"status": 400,
"code": "ERROR_CODE",
"message": "error message appears here"
}
{
"id": "5615873378",
"system": "ERA-PSD2",
"status": 500,
"code": "SYSTEM_ERROR"
}