Get card account transactions

GET 
/v1/card-accounts/:id/transactions

Requests without the header PSU-IP-Address is limited to 4 calls per day, and a PSU consent that is maximum 180 days old.

It is possible to filter the transactions by using query parameters:

• `bookingStatus` can be used to get only booked transactions, only pending or all transactions.
• `dateFrom` and `dateTo` 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, but it will return no error but use a default value, this is for bakwards compatibility.
• `offset` and `limit` is used for pagination (though it is recomended to follow the "next" and "previous" links). 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.

Example: This request gets the first 10 transactions for the 1st and 2nd of January 2018:

https://openbanking.spareskillingsbanken.no/api/v1/card-accounts/SOME-REFERENCE-ID/transactions?bookingStatus=both&dateFrom=2018-01-01&dateTo=2018-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://openbanking.spareskillingsbanken.no/api/v1/card-accounts/SOME-REFERENCE-ID/transactions?bookingStatus=both&dateFrom=2018-01-01&dateTo=2018-01-02&offset=10&limit=10

See XS2A Framework Implementation Guidelines, Section 6.6.4 for additional details.

Request

Path Parameters

id stringrequired
Example: enc!!aI55HS7YpeXJhHqt4PmNavMmogFrZWG789qlE-hGC6Y9T-kejIx4ZfRdS68U_RpL5m_PCXFPEGfF992bjRx2Gw==

Query Parameters

bookingStatus stringrequired
Possible values: [booked, pending, both]
Transactions with booking status
Example: both
dateFrom daterequired
Transactions not before
Example: 2023-06-18
dateTo date
Transactions not after
Example: 2023-07-13
offset int32
Default value: 0
Offset into transaction list
Example: 0
limit int32
Possible values: >= 1
Default value: 1
Limit number of transactions to specified value
Example: 10

Header Parameters

x-accept-fix stringrequired
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)
Example: new-feature-name-as-publised-in-documentation
Accept string
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.
Example: application/json
Accept-Charset string
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.
Example: utf-8
Accept-Encoding string
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.
Example: deflate, gzip;q=1.0, *;q=0.5
Accept-Language string
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.
Example: en-US,en;q=0.7,nb;q=0.3
Host string
The domain name of the server (for virtual hosting), and (optionally) the TCP port number on which the server is listening.
Example: openbanking.spareskillingsbanken.no
X-Request-ID stringrequired
Request identifier, unique to the call, as determined by the TPP.
Example: 4eba4445-1a4b-47b8-bdd5-4e56ef026b19
TPP-Session-ID stringrequired
TPP session identifier.
Example: b29f79d9-12ea-462b-ad8a-8ad38b8c57b7
TPP-Redirect-URI stringrequired
URI of the TPP, where the transaction flow shall be redirected to after a Redirect.
Example: http://httpbin.org/get
TPP-Redirect-Preferred string
Set to false to automatically trigger biometric authentication for mobile apps whenever available. Default is true.
Example: false
TPP-Signature-Certificate stringrequired
The certificate used for signing the request in base64 encoding.
Example: MIFFTzCCAzegAkIBAgMJANnQVDLqktJUMA0GCS....8WLZOX3YxNoH4k==
Signature stringrequired
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.
• keyId must be formatted as keyId="SN=XXX,CA=YYY" where XXX is the serial number of the signing certificate in hexadecimal encoding and YYY 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, and tpp-redirect-uri when available
• signature must be computed as Base64(RSA-SHA256(signingString))
If any values in the Signature header is ISO-8859-1 or UTF-8 encoded you need to URL encode the Signature header according 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)));
}
Example: keyId="SN=6AEB4444FBAAD267,CA=O=PSDNO-FSA-ABCA,L=Trondheim,C=NO", algorithm="rsa-sha256", headers="date x-request-id tpp-redirect-uri psu-id", signature="***************"
PSU-ID UUID
The PSU identifier.
Example: 49ae0cfe-6b72-4310-81f5-ad4eef897fe3
PSU-Corporate-ID string
The PSU Corporate agreement identifier.
Example: aog5kNSbDNo2srEPAqsCGaR8LNCAfLVlKPzbwKZQJzI=
PSU-Context string
Possible values: [PRIVATE, CORPORATE]
Explicitly set PSU context. If not set the PSU is promted to select context when performing SCA the first time
Example: PRIVATE
PSU-IP-Address string
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP.
Example: 153.110.241.229
PSU-IP-Port string
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
Example: 443
PSU-User-Agent string
The forwarded value for the User-Agent header field between the PSU and TPP, if available.
Example: Mozilla/5.0 (Windows NT 10.0; …) Gecko/20100101 Firefox/63.0
PSU-Accept string
The forwarded value for the Accept header field between the PSU and TPP, if available.
Example: application/json
PSU-Accept-Charset string
The forwarded value for the Accept-Charset header field between the PSU and TPP, if available.
Example: utf-8
PSU-Accept-Encoding string
The forwarded value for the Accept-Encoding header field between the PSU and TPP, if available.
Example: gzip, deflate, br
PSU-Accept-Language string
The forwarded value for the Accept-Language header field between the PSU and TPP, if available.
Example: en-US,en;q=0.7,nb;q=0.3
PSU-HTTP-Method string
The forwarded value for the HTTP method used between the PSU and TPP, if available.
Example: GET
PSU-Device-ID UUID
The forwarded value of the device ID used by the PSU, if available.
Example: 35-67660-48540-8
PSU-Geo-Location string
The forwarded value of the Geo Location of the corresponding HTTP request between the PSU and TPP, if available.
Example: GEO:52.506931,13.144558

Responses

200

OK

application/json

Schema

Schema

cardAccount

object

maskedPan string

currency ISOCurrencyCode (string)required

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.

cardTransactions

object

booked

object[]

Array [

cardTransactionId string

Possible values: <= 35 characters

bookingDate date

transactionDate date

transactionAmount

object

amount stringrequired

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.

currency ISOCurrencyCode (string)required

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

sourceCurrency ISOCurrencyCode (string)required

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.

targetCurrency ISOCurrencyCode (string)required

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.

exchangeRate stringrequired

unitCurrency ISOCurrencyCode (string)required

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.

quotationDate daterequired

originalAmount

object

amount stringrequired

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.

currency ISOCurrencyCode (string)required

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.

merchantCategoryCode string

invoiced boolean

Flag indicating whether the underlying card transaction is already invoiced

proprietaryBankTransactionCode string

Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports

transactionDetails string

Possible values: <= 140 characters

]

pending

object[]

Array [

cardTransactionId string

Possible values: <= 35 characters

bookingDate date

transactionDate date

transactionAmount

object

amount stringrequired

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.

currency ISOCurrencyCode (string)required

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

sourceCurrency ISOCurrencyCode (string)required

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.

targetCurrency ISOCurrencyCode (string)required

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.

exchangeRate stringrequired

unitCurrency ISOCurrencyCode (string)required

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.

quotationDate daterequired

originalAmount

object

amount stringrequired

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.

currency ISOCurrencyCode (string)required

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.

merchantCategoryCode string

invoiced boolean

Flag indicating whether the underlying card transaction is already invoiced

proprietaryBankTransactionCode string

Proprietary bank transaction code as used within a community or within an ASPSP e.g. for MT94x based transaction reports

transactionDetails string

Possible values: <= 140 characters

]

_links

object

property name*

Link

href stringrequired

verbs string[]required

Possible values: [GET, PUT, POST, DELETE]

Example (from schema)

{
  "cardAccount": {
    "maskedPan": "1223*******4567",
    "currency": "NOK"
  },
  "cardTransactions": {
    "booked": [
      {
        "cardTransactionId": "enc!!mJWer4g9YXt4PmNagHfIM89Jh8Lw==",
        "bookingDate": "2018-09-01",
        "transactionDate": "2018-09-01",
        "transactionAmount": {
          "amount": "100.26",
          "currency": "NOK"
        },
        "currencyExchange": {
          "sourceCurrency": "NOK",
          "targetCurrency": "NOK",
          "exchangeRate": "9.4383",
          "unitCurrency": "NOK",
          "quotationDate": "2018-10-01"
        },
        "originalAmount": {
          "amount": "100.26",
          "currency": "NOK"
        },
        "merchantCategoryCode": "4131",
        "invoiced": true,
        "proprietaryBankTransactionCode": "200-002-008",
        "transactionDetails": "User defined details"
      }
    ],
    "pending": [
      {
        "cardTransactionId": "enc!!mJWer4g9YXt4PmNagHfIM89Jh8Lw==",
        "bookingDate": "2018-09-01",
        "transactionDate": "2018-09-01",
        "transactionAmount": {
          "amount": "100.26",
          "currency": "NOK"
        },
        "currencyExchange": {
          "sourceCurrency": "NOK",
          "targetCurrency": "NOK",
          "exchangeRate": "9.4383",
          "unitCurrency": "NOK",
          "quotationDate": "2018-10-01"
        },
        "originalAmount": {
          "amount": "100.26",
          "currency": "NOK"
        },
        "merchantCategoryCode": "4131",
        "invoiced": true,
        "proprietaryBankTransactionCode": "200-002-008",
        "transactionDetails": "User defined details"
      }
    ],
    "_links": {
      "self": {
        "href": "https://openbanking.spareskillingsbanken.no/",
        "verbs": [
          "GET"
        ]
      }
    }
  }
}

400

Bad Request

application/json

Schema

Schema

id string
system string
code string
status int32
message string

Example (from schema)

{
  "id": "5884127160",
  "system": "ERA-PSD2",
  "code": "400",
  "status": 400,
  "message": "error message appears here"
}

FORMAT_ERROR

{
  "id": "5615873375",
  "status": 400,
  "system": "ERA-PSD2",
  "code": "FORMAT_ERROR"
}

401

Unauthorized

application/json

Schema

Schema

_links

object

property name*

Link

href stringrequired

verbs string[]required

Possible values: [GET, PUT, POST, DELETE]

Example (from schema)

{
  "_links": {
    "scaRedirect": {
      "href": "https://openbanking.spareskillingsbanken.no/tap?route_secesb_id=1&flow=psd2&state=ca477daf-d824-4f0b-b405-6c8fc385dc0b&locale=no-NB, no; q=1.0",
      "verbs": [
        "GET"
      ]
    }
  }
}

When the TPP must redirect the PSU in order to perform SCA

{
  "_links": {
    "scaRedirect": {
      "href": "https://openbanking.spareskillingsbanken.no/tap?route_secesb_id=1&flow=psd2&state=ca477daf-d824-4f0b-b405-6c8fc385dc0b&locale=no-NB, no; q=1.0",
      "verbs": [
        "GET"
      ]
    }
  }
}

QUERY_PARAMETER_REQUIRED

{
  "id": "5615873375",
  "status": 400,
  "system": "ERA-PSD2",
  "code": "QUERY_PARAMETER_REQUIRED"
}

PERIOD_INVALID

{
  "id": "5615873375",
  "status": 400,
  "system": "ERA-PSD2",
  "code": "PERIOD_INVALID"
}

404

Not Found

application/json

Schema

Schema

id string
system string
code string
status int32
message string

Example (from schema)

{
  "id": "5884127160",
  "system": "ERA-PSD2",
  "code": "400",
  "status": 400,
  "message": "error message appears here"
}

RESOURCE_UNKNOWN

{
  "id": "5615873376",
  "system": "ERA-PSD2",
  "status": 404,
  "code": "RESOURCE_UNKNOWN",
  "message": "Account not found."
}

429

Too Many Requests

application/json

Schema

Schema

id string
system string
code string
status int32
message string

Example (from schema)

{
  "id": "5884127160",
  "system": "ERA-PSD2",
  "code": "400",
  "status": 400,
  "message": "error message appears here"
}

ACCESS_EXCEEDED

{
  "id": "5615873377",
  "system": "ERA-PSD2",
  "status": 429,
  "code": "ACCESS_EXCEEDED"
}

500

Internal Server Error

application/json

Schema

Schema

id string
system string
code string
status int32
message string

Example (from schema)

{
  "id": "5884127160",
  "system": "ERA-PSD2",
  "code": "400",
  "status": 400,
  "message": "error message appears here"
}

SYSTEM_ERROR

{
  "id": "5615873378",
  "system": "ERA-PSD2",
  "status": 500,
  "code": "SYSTEM_ERROR"
}

Loading...