Mbanq PSD2 API (NextGenPSD2 XS2A v1.3.6 - 2020-07-31 - )

Download OpenAPI specification:Download

The Berlin Group - A European Standards Initiative: info@berlin-group.org URL: https://www.berlin-group.org/ License: Creative Commons Attribution 4.0 International Public License

NextGenPSD2 Publications (General Introduction, Operational Rules, Implementation Guidelines)

Summary

The MBanq PSD2 API is a REST implementation of account information and payment initiation services. It is based on the Implementation Guidelines of the Berlin Group PSD2 API.

The supported SCA approaches are:

OAuth SCA Approach

This document describes the TPP-to-ASPSP interface.

General Remarks on Data Types

The Berlin Group definition of UTF-8 strings in context of the PSD2 API have to support at least the following characters

a b c d e f g h i j k l m n o p q r s t u v w x y z

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

0 1 2 3 4 5 6 7 8 9

/ - ? : ( ) . , ' +

Space

License and External References

Authentication

BearerAuthOAuth

Bearer Token.

Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Payment Initiation Service (PIS)

The Decription for Payment Initiation Service (PIS) offers the following services:

Initiation and update of a payment request
Status information of a payment

Payment initiation request

This method is used to initiate a payment at the ASPSP.

Variants of Payment Initiation Requests

This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.

There are the following payment products:

Payment products with payment information in JSON format:
- sepa-credit-transfers (Mandatory Support of ASPSP)
- target-2-payments (Optional Support of ASPSP)
- cross-border-credit-transfers (Mandatory Support of ASPSP)
- domestic-credit-transfers-hr (Mandatory Support of ASPSP)
- instant-domestic-credit-transfers-hr (Optional Support of ASPSP)
- hr-rtgs-payments (Optional Support of ASPSP)
Payment products with payment information in pain.001 XML format:
- pain.001-credit-transfers

It is important to note that the support for pain.001 XML format is only supported for the bulk payments using the Croatian specific pain.001-credit-transfers!

Furthermore the request body depends on the payment-service

payments: A single payment initiation request.

In case of single payments, only the JSON format is mandatory. The pain.001 message implementations are ASPSP specific, see individual standard descriptions for your ASPSP.
bulk-payments: A collection of several payment iniatiation requests.

In case of a pain.001 message there are more than one payments contained in the pain.001 message.
periodic-payments: Create a standing order initiation resource for recurrent i.e. periodic payments addressable under {paymentId} with all data relevant for the corresponding payment product and the execution of the standing order contained in a JSON body.

This is the first step in the API to initiate the related recurring/periodic payment.

Single and mulitilevel SCA Processes

The Payment Initiation Requests are independent from the need of one ore multilevel SCA processing, i.e. independent from the number of authorisations needed for the execution of payments.

But the response messages are specific to either one SCA processing or multilevel SCA processing.

For payment initiation with multilevel SCA, this specification requires an explicit start of the authorisation, i.e. links directly associated with SCA processing like 'scaRedirect' or 'scaOAuth' cannot be contained in the response message of a Payment Initation Request for a payment, where multiple authorisations are needed. Also if any data is needed for the next action, like selecting an SCA method is not supported in the response, since all starts of the multiple authorisations are fully equal. In these cases, first an authorisation sub-resource has to be generated following the 'startAuthorisation' link.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service

required

string

Enum: "payments" "bulk-payments" "periodic-payments"

Payment service:

Possible values are:

payments
bulk-payments
periodic-payments

payment-product

required

string

Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers"

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.

The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines.

The following payment products are supported for single payments:

sepa-credit-transfers (mandatory support)
target-2-payments (optional support, decided by the ASPSP)
cross-border-credit-transfers (mandatory support)
domestic-credit-transfers-hr (mandatory support)
instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP)
hr-rtgs-payments (optional support, decided by the ASPSP)

The following payment products are supported for bulk payments:

pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard!

The following payment products are supported for periodic payments:

domestic-credit-transfers-hr (optional support, decided by the ASPSP)

Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities.

Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
Consent-ID	string (consentId) This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
TPP-Explicit-Authorisation-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
TPP-Rejection-NoFunds-Preferred	string Enum: "true" "false" If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available. If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment. This parameter might be ignored by the ASPSP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema:
application/json
application/json
application/xml
multipart/form-data

JSON request body for a payment inition request message

There are the following payment-products supported:

"sepa-credit-transfers" with JSON-Body
"target-2-payments" with JSON-Body
"cross-border-credit-transfers" with JSON-Body Only country specific schemes are currently available
"pain.001-credit-transfers" with pain.001 body. Only country specific schemes are currently available

There are the following payment-services supported:

"payments"
"periodic-payments"
"bulk-paments"

All optional, conditional and predefined but not yet used fields are defined.

One of

endToEndIdentification	string <= 35 characters
required	object (accountReference) Reference to an account by either IBAN, of a payment accounts, or BBAN, for payment accounts if there is no IBAN, or the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or the Primary Account Number (PAN) of a card in a masked form, or an alias to access a payment account via a registered mobile phone number (MSISDN).
ultimateDebtor	string (ultimateDebtor) <= 70 characters Ultimate Debtor
required	object (amount)
required	object (accountReference) Reference to an account by either IBAN, of a payment accounts, or BBAN, for payment accounts if there is no IBAN, or the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or the Primary Account Number (PAN) of a card in a masked form, or an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorAgent	string (bicfi) BICFI
creditorAgentName	string (creditorAgentName) <= 70 characters Creditor Agent Name
creditorName required	string (creditorName) <= 70 characters Creditor Name
	object (address)
ultimateCreditor	string (ultimateCreditor) <= 70 characters Ultimate Creditor
purposeCode	string (purposeCode) Enum: "BKDF" "BKFE" "BKFM" "BKIP" "BKPP" "CBLK" "CDCB" "CDCD" "CDCS" "CDDP" "CDOC" "CDQC" "ETUP" "FCOL" "MTUP" "ACCT" "CASH" "COLL" "CSDB" "DEPT" "INTC" "LIMA" "NETT" "BFWD" "CCIR" "CCPC" "CCPM" "CCSM" "CRDS" "CRPR" "CRSP" "CRTL" "EQPT" "EQUS" "EXPT" "EXTD" "FIXI" "FWBC" "FWCC" "FWSB" "FWSC" "MARG" "MBSB" "MBSC" "MGCC" "MGSC" "OCCC" "OPBC" "OPCC" "OPSB" "OPSC" "OPTN" "OTCD" "REPO" "RPBC" "RPCC" "RPSB" "RPSC" "RVPO" "SBSC" "SCIE" "SCIR" "SCRP" "SHBC" "SHCC" "SHSL" "SLEB" "SLOA" "SWBC" "SWCC" "SWPT" "SWSB" "SWSC" "TBAS" "TBBC" "TBCC" "TRCP" "AGRT" "AREN" "BEXP" "BOCE" "COMC" "CPYR" "GDDS" "GDSV" "GSCB" "LICF" "MP2B" "POPE" "ROYA" "SCVE" "SERV" "SUBS" "SUPP" "TRAD" "CHAR" "COMT" "MP2P" "ECPG" "ECPR" "ECPU" "EPAY" "CLPR" "COMP" "DBTC" "GOVI" "HLRP" "HLST" "INPC" "INPR" "INSC" "INSU" "INTE" "LBRI" "LIFI" "LOAN" "LOAR" "PENO" "PPTI" "RELG" "RINP" "TRFD" "FORW" "FXNT" "ADMG" "ADVA" "BCDM" "BCFG" "BLDM" "BNET" "CBFF" "CBFR" "CCRD" "CDBL" "CFEE" "CGDD" "CORT" "COST" "CPKC" "DCRD" "DSMT" "DVPM" "EDUC" "FACT" "FAND" "FCPM" "FEES" "GOVT" "ICCP" "IDCP" "IHRP" "INSM" "IVPT" "MCDM" "MCFG" "MSVC" "NOWS" "OCDM" "OCFG" "OFEE" "OTHR" "PADD" "PTSP" "RCKE" "RCPT" "REBT" "REFU" "RENT" "REOD" "RIMB" "RPNT" "RRBN" "RVPM" "SLPI" "SPLT" "STDY" "TBAN" "TBIL" "TCSC" "TELI" "TMPG" "TPRI" "TPRP" "TRNC" "TRVC" "WEBI" "ANNI" "CAFI" "CFDI" "CMDT" "DERI" "DIVD" "FREX" "HEDG" "INVS" "PRME" "SAVG" "SECU" "SEPI" "TREA" "UNIT" "FNET" "FUTR" "ANTS" "CVCF" "DMEQ" "DNTS" "HLTC" "HLTI" "HSPC" "ICRF" "LTCF" "MAFC" "MARF" "MDCS" "VIEW" "CDEP" "SWFP" "SWPP" "SWRS" "SWUF" "ADCS" "AEMP" "ALLW" "ALMY" "BBSC" "BECH" "BENE" "BONU" "CCHD" "COMM" "CSLP" "GFRP" "GVEA" "GVEB" "GVEC" "GVED" "GWLT" "HREC" "PAYR" "PEFC" "PENS" "PRCP" "RHBS" "SALA" "SSBE" "LBIN" "LCOL" "LFEE" "LMEQ" "LMFI" "LMRK" "LREB" "LREV" "LSFL" "ESTX" "FWLV" "GSTX" "HSTX" "INTX" "NITX" "PTXP" "RDTX" "TAXS" "VATX" "WHLD" "TAXR" "B112" "BR12" "TLRF" "TLRR" "AIRB" "BUSB" "FERB" "RLWY" "TRPT" "CBTV" "ELEC" "ENRG" "GASB" "NWCH" "NWCM" "OTLC" "PHON" "UBIL" "WTER" ExternalPurpose1Code from ISO 20022. Values from ISO 20022 External Code List ExternalCodeSets_1Q2018 June 2018.
chargeBearer	string (chargeBearer) Enum: "DEBT" "CRED" "SHAR" "SLEV" Charge Bearer. ChargeBearerType1Code from ISO20022
remittanceInformationUnstructured	string (remittanceInformationUnstructured) <= 140 characters Unstructured remittance information
	object (remittanceInformationStructured) Structured remittance information
requestedExecutionDate	string <date>

Responses

Request samples

Payload

Content type

Example


{"instructedAmount": 
{"currency": "EUR",
"amount": "123.50"
},
"debtorAccount": 
{"iban": "DE40100100103307118608"
},
"creditorName": "Merchant123",
"creditorAccount": 
{"iban": "DE02100100109307118603"
},
"remittanceInformationUnstructured": "Ref Number Merchant"
}

Response samples

Content type

application/json

Example

Response in case of a redirect with an implicitly created authorisation sub-resource


{"transactionStatus": "RCVD",
"paymentId": "1234-wertiq-983",
"_links": 
{"scaRedirect": 
{"href": "https://www.testbank.com/asdfasdfasdf"
},
"self": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"status": 
{"href": "/v1/payments/1234-wertiq-983/status"
},
"scaStatus": 
{"href": "/v1/payments/1234-wertiq-983/authorisations/123auth456"
}
}
}

Get Payment Information

Returns the content of a payment object

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

Example


{"endToEndIdentification": "string",
"debtorAccount": 
{"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "5409050000000000",
"maskedPan": "123456xxxxxx1234",
"msisdn": "+49 170 1234567",
"currency": "EUR"
},
"ultimateDebtor": "Ultimate Debtor",
"instructedAmount": 
{"currency": "EUR",
"amount": "123"
},
"creditorAccount": 
{"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "5409050000000000",
"maskedPan": "123456xxxxxx1234",
"msisdn": "+49 170 1234567",
"currency": "EUR"
},
"creditorAgent": "AAAADEBBXXX",
"creditorName": "Creditor Name",
"creditorAddress": 
{"street": "rue blue",
"buildingnNumber": "89",
"city": "Paris",
"postalCode": "75000",
"country": "FR"
},
"ultimateCreditor": "Ultimate Creditor",
"purposeCode": "BKDF",
"remittanceInformationUnstructured": "Ref Number Merchant",
"remittanceInformationStructured": 
{"reference": "string",
"referenceType": "string",
"referenceIssuer": "string"
},
"requestedExecutionDate": "2019-08-24",
"transactionStatus": "ACCP"
}

Payment Cancellation Request

This method initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this TPP call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message.

Cancels the addressed payment with resource identification paymentId if applicable to the payment-service, payment-product and received in product related timelines (e.g. before end of business day for scheduled payments of the last business day before the scheduled execution day).

The response to this DELETE command will tell the TPP whether the

access method was rejected
access method was successful, or
access method is generally applicable, but further authorisation processes are needed.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"transactionStatus": "ACTC",
"_links": 
{"self": 
{"href": "/v1/payments/123456scheduled789"
},
"status": 
{"href": "/v1/payments/123456scheduled789/status"
},
"startAuthorisation": 
{"href": "/v1/payments/123456scheduled789/cancellation-authorisations"
}
}
}

Payment initiation status request

Check the transaction status of a payment initiation.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

Example


{"transactionStatus": "ACCP"
}

Start the authorisation process for a payment initiation

Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the transaction.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Get Payment Initiation Authorisation Sub-Resources Request

Read a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"authorisationIds": 
["123auth456"
]
}

Read the SCA Status of the payment authorisation

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU data for payment initiation

This methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

There are several possible Update PSU Data requests in the context of payment initiation services needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Start the authorisation process for the cancellation of the addressed payment

Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the cancellation-authorisation.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.

Retrieve a list of all created cancellation authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"cancellationIds": 
["123auth456"
]
}

Read the SCA status of the payment cancellation's authorisation.

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
cancellationId required	string (cancellationId) Example: 123auth456 Identification for cancellation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU Data for payment initiation cancellation

This method updates PSU data on the cancellation authorisation resource if needed. It may authorise a cancellation of the payment within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
cancellationId required	string (cancellationId) Example: 123auth456 Identification for cancellation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Confirmation of Funds Service (PIIS)

Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the ASPSP.

Confirmation of Funds Request

Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively

Authorizations:

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Consent-ID	string (consentId) This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Request Body schema: application/json

Request body for a confirmation of funds request.

cardNumber	string <= 35 characters Card Number of the card issued by the PIISP. Should be delivered if available.
required	object (accountReference) Reference to an account by either IBAN, of a payment accounts, or BBAN, for payment accounts if there is no IBAN, or the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or the Primary Account Number (PAN) of a card in a masked form, or an alias to access a payment account via a registered mobile phone number (MSISDN).
payee	string <= 70 characters Name payee
required	object (amount)

Responses

Request samples

Payload

Content type

application/json

Request body for a confirmation of funds.


{"cardNumber": "12345678901234",
"account": 
{"iban": "DE23100120020123456789"
},
"instructedAmount": 
{"currency": "EUR",
"amount": "123"
}
}

Response samples

Content type

application/json

Response for a confirmation of funds request.


{"fundsAvailable": "true"
}

Account Information Service (AIS)

The Account Information Service (AIS) offers the following services

Transaction reports for a given account or card account including balances if applicable.
Balances of a given account or card account ,
A list of available accounts or card account ,
Account details of a given account or card account or of the list of all accessible accounts or card account relative to a granted consent

Read Account List

Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.

It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.

Returns all identifiers of the accounts, to which an account access has been granted to through the /consents endpoint by the PSU. In addition, relevant information about the accounts and hyperlinks to corresponding account information resources are provided if a related consent has been already granted.

Remark: Note that the /consents endpoint optionally offers to grant an access on all available payment accounts of a PSU. In this case, this endpoint will deliver the information about all available payment accounts of the PSU at this ASPSP.

Authorizations:

BearerAuthOAuth

query Parameters

withBalance

boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Example

Response in case of an example, where the consent has been given on two different IBANs


{"accounts": 
[
{"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
"iban": "DE2310010010123456789",
"currency": "EUR",
"product": "Girokonto",
"cashAccountType": "CACC",
"name": "Main Account",
"_links": 
{"balances": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
},
"transactions": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
}
}
},
{"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
"iban": "DE2310010010123456788",
"currency": "USD",
"product": "Fremdwährungskonto",
"cashAccountType": "CACC",
"name": "US Dollar Account",
"_links": 
{"balances": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
}
}
}
]
}

Read Account Details

Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.

NOTE: The account-id can represent a multicurrency account. In this case the currency code is set to "XXX".

Give detailed information about the addressed account.

Give detailed information about the addressed account together with balance information

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

query Parameters

withBalance

boolean

If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Example

Account Details for a regular Account


{"account": 
{"resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
"iban": "FR7612345987650123456789014",
"currency": "EUR",
"product": "Girokonto",
"cashAccountType": "CACC",
"name": "Main Account",
"_links": 
{"balances": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
},
"transactions": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
}
}
}
}

Read Balance

Reads account data from a given account addressed by "account-id".

Remark: This account-id can be a tokenised identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This account-id then can be retrieved by the "GET Account List" call.

The account-id is constant at least throughout the lifecycle of a given consent.

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Example

Response for a read balance request in case of a regular account.


{"account": 
{"iban": "FR7612345987650123456789014"
},
"balances": 
[
{"balanceType": "closingBooked",
"balanceAmount": 
{"currency": "EUR",
"amount": "500.00"
},
"referenceDate": "2017-10-25"
},
{"balanceType": "expected",
"balanceAmount": 
{"currency": "EUR",
"amount": "900.00"
},
"lastChangeDateTime": "2017-10-25T15:30:35.035Z"
}
]
}

Read transaction list of an account

Read transaction reports or transaction lists of a given account ddressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.

For a given account, additional parameters are e.g. the attributes "dateFrom" and "dateTo". The ASPSP might add balance information, if transaction lists without balances are not supported.

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

query Parameters

dateFrom	string <date> Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
dateTo	string <date> End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
entryReferenceFrom	string This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider.
bookingStatus required	string Enum: "booked" "pending" "both" Permitted codes are "booked", "pending" and "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend
deltaList	boolean This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
withBalance	boolean If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

Example

Response in JSON format for an access on a regular account


{"account": 
{"iban": "DE2310010010123456788"
},
"transactions": 
{"booked": 
[
{"transactionId": "1234567",
"creditorName": "John Miles",
"creditorAccount": 
{"iban": "DE67100100101306118605"
},
"transactionAmount": 
{"currency": "EUR",
"amount": "256.67"
},
"bookingDate": "2017-10-25",
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 1"
},
{"transactionId": "1234568",
"debtorName": "Paul Simpson",
"debtorAccount": 
{"iban": "NL76RABO0359400371"
},
"transactionAmount": 
{"currency": "EUR",
"amount": "343.01"
},
"bookingDate": "2017-10-25",
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 2"
}
],
"pending": 
[
{"transactionId": "1234569",
"creditorName": "Claude Renault",
"creditorAccount": 
{"iban": "FR7612345987650123456789014"
},
"transactionAmount": 
{"currency": "EUR",
"amount": "-100.03"
},
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 3"
}
],
"_links": 
{"account": 
{"href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f"
}
}
}
}

Read Transaction Details

Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "account-id". This call is only available on transactions as reported in a JSON format.

Remark: Please note that the PATH might be already given in detail by the corresponding entry of the response of the "Read Transaction List" call within the _links subfield.

Authorizations:

BearerAuthOAuth

path Parameters

account-id required	string (accountId) Example: qwer3456tzui7890 This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
resourceId required	string (resourceId) Example: 3dc3d5b3-7023-4848-9853-f5400a64e80f This identification is given by the attribute resourceId of the corresponding entry of a transaction list.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Example for transaction details


{"transactionsDetails": 
{"transactionId": "1234567",
"creditorName": "John Miles",
"creditorAccount": 
{"iban": "DE67100100101306118605"
},
"mandateId": "Mandate-2018-04-20-1234",
"transactionAmount": 
{"currency": "EUR",
"amount": "-256.67"
},
"bookingDate": "2017-10-25",
"valueDate": "2017-10-26",
"remittanceInformationUnstructured": "Example 1",
"bankTransactionCode": "PMNT-RCVD-ESDD"
}
}

Reads a list of card accounts

Reads a list of card accounts with additional information, e.g. balance information. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of card accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.

Authorizations:

BearerAuthOAuth

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Card account list example


{"cardAccounts": 
[
{"resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
"maskedPan": "525412******3241",
"currency": "EUR",
"name": "Main",
"product": "Basic Credit",
"status": "enabled",
"creditLimit": 
{"currency": "EUR",
"amount": "15000"
},
"balances": 
[
{"balanceType": "interimBooked",
"balanceAmount": 
{"currency": "EUR",
"amount": "14355.78"
}
},
{"balanceType": "nonInvoiced",
"balanceAmount": 
{"currency": "EUR",
"amount": "4175.86"
}
}
],
"_links": 
{"transactions": 
{"href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
}
}
}
]
}

Reads details about a card account

Reads details about a card account. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the OAuth2 access token.

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Card account details example


{"cardAccount": 
{"resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
"maskedPan": "525412******3241",
"currency": "EUR",
"name": "Main",
"product": "Basic Credit",
"status": "enabled",
"creditLimit": 
{"currency": "EUR",
"amount": "15000"
},
"balances": 
[
{"balanceType": "interimBooked",
"balanceAmount": 
{"currency": "EUR",
"amount": "14355.78"
}
},
{"balanceType": "nonInvoiced",
"balanceAmount": 
{"currency": "EUR",
"amount": "4175.86"
}
}
],
"_links": 
{"transactions": 
{"href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
}
}
}
}

Read card account balances

Reads balance data from a given card account addressed by "account-id".

Remark: This account-id can be a tokenised identification due to data protection reason since the path information might be logged on intermediary servers within the ASPSP sphere. This account-id then can be retrieved by the "GET Card Account List" call

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Response in case of card Acoount balance request


{"cardAccount": 
{"maskedPan": "525412******3241"
},
"balances": 
[
{"balanceType": "interimBooked",
"balanceAmount": 
{"currency": "EUR",
"amount": "14355.78"
}
},
{"balanceType": "nonInvoiced",
"balanceAmount": 
{"currency": "EUR",
"amount": "4175.86"
}
}
]
}

Read transaction list of an account

Reads account data from a given card account addressed by "account-id".

Authorizations:

BearerAuthOAuth

path Parameters

account-id

required

string (accountId)

Example: qwer3456tzui7890

This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call. The account-id is the "id" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.

query Parameters

dateFrom	string <date> Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
dateTo	string <date> End date (inclusive the data dateTo) of the transaction list, default is "now" if not given. Might be ignored if a delta function is used. For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.
entryReferenceFrom	string This data attribute is indicating that the AISP is in favour to get all transactions after the transaction with identification entryReferenceFrom alternatively to the above defined period. This is a implementation of a delta access. If this data element is contained, the entries "dateFrom" and "dateTo" might be ignored by the ASPSP if a delta report is supported. Optional if supported by API provider.
bookingStatus required	string Enum: "booked" "pending" "both" Permitted codes are "booked", "pending" and "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend
deltaList	boolean This data attribute is indicating that the AISP is in favour to get all transactions after the last report access for this PSU on the addressed account. This is another implementation of a delta access-report. This delta indicator might be rejected by the ASPSP if this function is not supported. Optional if supported by API provider
withBalance	boolean If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
Consent-ID required	string (consentId) This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"cardAccount": 
{"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "5409050000000000",
"maskedPan": "123456xxxxxx1234",
"msisdn": "+49 170 1234567",
"currency": "EUR"
},
"cardTransactions": 
{"booked": 
[
{"cardTransactionId": "string",
"terminalId": "string",
"transactionDate": "2019-08-24",
"bookingDate": "2019-08-24",
"transactionAmount": 
{"currency": "EUR",
"amount": "123"
},
"currencyExchange": 
[
{"sourceCurrency": "EUR",
"exchangeRate": "string",
"unitCurrency": "string",
"targetCurrency": "EUR",
"quotationDate": "2019-08-24",
"contractIdentification": "string"
}
],
"originalAmount": 
{"currency": "EUR",
"amount": "123"
},
"markupFee": 
{"currency": "EUR",
"amount": "123"
},
"markupFeePercentage": "0.3",
"cardAcceptorId": "string",
"cardAcceptorAddress": 
{"street": "rue blue",
"buildingnNumber": "89",
"city": "Paris",
"postalCode": "75000",
"country": "FR"
},
"merchantCategoryCode": "stri",
"maskedPAN": "123456xxxxxx1234",
"transactionDetails": "string",
"invoiced": true,
"proprietaryBankTransactionCode": "string"
}
],
"pending": 
[
{"cardTransactionId": "string",
"terminalId": "string",
"transactionDate": "2019-08-24",
"bookingDate": "2019-08-24",
"transactionAmount": 
{"currency": "EUR",
"amount": "123"
},
"currencyExchange": 
[
{"sourceCurrency": "EUR",
"exchangeRate": "string",
"unitCurrency": "string",
"targetCurrency": "EUR",
"quotationDate": "2019-08-24",
"contractIdentification": "string"
}
],
"originalAmount": 
{"currency": "EUR",
"amount": "123"
},
"markupFee": 
{"currency": "EUR",
"amount": "123"
},
"markupFeePercentage": "0.3",
"cardAcceptorId": "string",
"cardAcceptorAddress": 
{"street": "rue blue",
"buildingnNumber": "89",
"city": "Paris",
"postalCode": "75000",
"country": "FR"
},
"merchantCategoryCode": "stri",
"maskedPAN": "123456xxxxxx1234",
"transactionDetails": "string",
"invoiced": true,
"proprietaryBankTransactionCode": "string"
}
],
"_links": 
{"cardAccount": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"first": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"next": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"previous": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"last": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
},
"balances": 
[
{"balanceAmount": 
{"currency": "EUR",
"amount": "123"
},
"balanceType": "closingBooked",
"lastChangeDateTime": "2019-08-24T14:15:22Z",
"referenceDate": "2019-08-24",
"lastCommittedTransaction": "string"
}
],
"_links": 
{"download": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
}

Create consent

This method creates a consent resource in order to define access rights to the PSU's accounts. The request explicitly specifies these accounts as parameters as a core function.

Side Effects For consent requests with "recurringIndicator" set to "true", and if there exists another consent for recurring access to the same PSU's account information, then the former consent expires as soon as the PSU authorises the new consent.

Optional Functionality:

The ASPSP might accept a specific access right to access all PSD2 related services for all available accounts.
The ASPSP might accept a command, where only access rights are inserted without mentioning the addressed account. The relation to accounts is then handled afterwards between PSU and ASPSP. This option is not supported for the Embedded SCA Approach.
The ASPSP might in addition accept a command with access rights
- to see the list of available payment accounts or
- to see the list of available payment accounts with balances.

Authorizations:

BearerAuthOAuth

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
TPP-Explicit-Authorisation-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

Requestbody for a consents request

required	object (accountAccess) Requested access services for a consent.
recurringIndicator required	boolean (recurringIndicator) "true", if the consent is for recurring access to the account data. "false", if the consent is for one access to the account data.
validUntil required	string <date> (validUntil) This parameter is requesting a valid until date for the requested consent. The content is the local ASPSP date in ISO-Date Format, e.g. 2017-10-30. Future dates might get adjusted by ASPSP. If a maximal available date is requested, a date in far future is to be used: "9999-12-31". In both cases the consent object to be retrieved by the GET Consent Request will contain the adjusted date.
frequencyPerDay required	integer (frequencyPerDay) >= 1 This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one.
combinedServiceIndicator required	boolean If "true" indicates that a payment initiation service will be addressed in the same "session".

Responses

Request samples

Payload

Content type

application/json

Example

Consent request on dedicated accounts


{"access": 
{"balances": 
[
{"iban": "DE40100100103307118608"
},
{"iban": "DE02100100109307118603",
"currency": "USD"
},
{"iban": "DE67100100101306118605"
}
],
"transactions": 
[
{"iban": "DE40100100103307118608"
},
{"maskedPan": "123456xxxxxx1234"
}
]
},
"recurringIndicator": "true",
"validUntil": "2017-11-01",
"frequencyPerDay": "4"
}

Response samples

Content type

application/json

Example

Consent request Response in case of a redirect


{"consentStatus": "received",
"consentId": "1234-wertiq-983",
"_links": 
{"scaRedirect": 
{"href": "https://www.testbank.com/authentication/1234-wertiq-983"
},
"status": 
{"href": "/v1/consents/1234-wertiq-983/status"
},
"scaStatus": 
{"href": "v1/consents/1234-wertiq-983/authorisations/123auth567"
}
}
}

Get Consent Request

Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Consent request on account list or without indication of accounts


{"access": 
{"balances": 
[
{"iban": "DE2310010010123456789"
}
],
"transactions": 
[
{"iban": "DE2310010010123456789"
},
{"pan": "123456xxxxxx3457"
}
]
},
"recurringIndicator": "true",
"validUntil": "2017-11-01",
"frequencyPerDay": "4",
"consentStatus": "valid",
"_links": 
{"account": 
{"href": "/v1/accounts"
}
}
}

Delete Consent

The TPP can delete an account information consent object if needed.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type


{"tppMessages": 
[
{"category": "ERROR",
"code": "FORMAT_ERROR",
"path": "string",
"text": "string"
}
],
"_links": 
{"scaRedirect": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaOAuth": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithAuthenticationMethodSelection": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"selectAuthenticationMethod": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithTransactionAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"authoriseTransaction": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"self": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"status": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaStatus": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"account": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"balances": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactionDetails": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardAccount": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardTransactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"first": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"next": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"previous": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"last": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"download": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
}

Consent status request

Read the status of an account information consent resource.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json

Response for a consent status request.


{"consentStatus": "valid"
}

Start the authorisation process for a consent

Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times SCA authorisation in a corporate context, each creating its own authorisation sub-endpoint for the corresponding PSU authorising the consent.

The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call.

The start authorisation process is a process required to create a new authorisation or cancellation sub-resource(s) applicable to the following scenarios:

The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Get Consent Authorisation Sub-Resources Request

Return a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"authorisationIds": 
["123auth456"
]
}

Read the SCA status of the consent authorisation.

This method returns the SCA status of a consent initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

consentId required	string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU Data for consents

This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

consentId required	string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Signing Baskets Service (SBS)

Signing basket methods are used for authorising several transactions and resp. or consents with one SCA operation.

Common Services

Processes on starting authorisations, update PSU identification or PSU authentication data and explicit authorisation of transactions by using SCA are very similar in PIS and AIS and signing baskets services. The API calls supporting these processes are described in the following independently from the service/endpoint. For reasons of clarity, the endpoints are defined always for the Payment Initiation Service, the Payment Cancellation, the Account Information Service (Consents), and Signing Baskets separately. These processes usually are used following a hyperlink of the ASPSP.

Start the authorisation process for a payment initiation

Create an authorisation sub-resource and start the authorisation process. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the transaction.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Get Payment Initiation Authorisation Sub-Resources Request

Read a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"authorisationIds": 
["123auth456"
]
}

Read the SCA Status of the payment authorisation

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU data for payment initiation

This methods updates PSU data on the authorisation resource if needed. It may authorise a payment within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

There are several possible Update PSU Data requests in the context of payment initiation services needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Start the authorisation process for the cancellation of the addressed payment

Creates an authorisation sub-resource and start the authorisation process of the cancellation of the addressed payment. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the cancellation-authorisation.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST payments/{payment-product} call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Read the SCA status of the payment cancellation's authorisation.

This method returns the SCA status of a payment initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
cancellationId required	string (cancellationId) Example: 123auth456 Identification for cancellation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU Data for payment initiation cancellation

This method updates PSU data on the cancellation authorisation resource if needed. It may authorise a cancellation of the payment within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a cancellation authorisation within the payment initiation services needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

payment-service required	string Enum: "payments" "bulk-payments" "periodic-payments" Payment service: Possible values are: payments bulk-payments periodic-payments
payment-product required	string Enum: "sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" "domestic-credit-transfers-hr" "instant-domestic-credit-transfers-hr" "hr-rtgs-payments" "pain.001-credit-transfers" The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The Croatian version of the standard deviates slightly, as described in the country specific appendix to the implementation guidelines. The following payment products are supported for single payments: sepa-credit-transfers (mandatory support) target-2-payments (optional support, decided by the ASPSP) cross-border-credit-transfers (mandatory support) domestic-credit-transfers-hr (mandatory support) instant-domestic-credit-transfers-hr (optional support, decided by the ASPSP) hr-rtgs-payments (optional support, decided by the ASPSP) The following payment products are supported for bulk payments: pain.001-credit-transfers (mandatory support) Note that this payment product is specific to the Croatian standard! The following payment products are supported for periodic payments: domestic-credit-transfers-hr (optional support, decided by the ASPSP) Remark: For all SEPA Credit Transfer based endpoints which accept XML encoding, the XML pain.001 schemes provided by EPC are supported by the ASPSP as a minimum for the body content. Further XML schemes might be supported by some communities. Remark: For cross-border and TARGET-2 payments only community wide pain.001 schemes do exist. There are plenty of country specificic scheme variants.
paymentId required	string (paymentId) Example: 1234-wertiq-983 Resource identification of the generated payment initiation resource.
cancellationId required	string (cancellationId) Example: 123auth456 Identification for cancellation resource.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Start the authorisation process for a consent

Create an authorisation sub-resource and start the authorisation process of a consent. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times SCA authorisation in a corporate context, each creating its own authorisation sub-endpoint for the corresponding PSU authorising the consent.

The ASPSP might make the usage of this access method unnecessary, since the related authorisation resource will be automatically created by the ASPSP after the submission of the consent data with the first POST consents call.

The start authorisation process is a process required to create a new authorisation or cancellation sub-resource(s) applicable to the following scenarios:

The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with a 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

consentId

required

string (consentId)

ID of the corresponding consent object as returned by an Account Information Consent Request.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Read the SCA status of the consent authorisation.

This method returns the SCA status of a consent initiation's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

consentId required	string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Update PSU Data for consents

This method update PSU data on the consents resource if needed. It may authorise a consent within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

consentId required	string (consentId) ID of the corresponding consent object as returned by an Account Information Consent Request.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Delete the signing basket

Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.

Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Nevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type


{"tppMessages": 
[
{"category": "ERROR",
"code": "FORMAT_ERROR",
"path": "string",
"text": "string"
}
],
"_links": 
{"scaRedirect": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaOAuth": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithAuthenticationMethodSelection": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"selectAuthenticationMethod": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithTransactionAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"authoriseTransaction": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"self": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"status": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaStatus": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"account": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"balances": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactionDetails": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardAccount": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardTransactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"first": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"next": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"previous": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"last": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"download": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
}

Read the status of the signing basket

Returns the status of a signing basket object.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"transactionStatus": "RCVD"
}

Start the authorisation process for a signing basket

Create an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the signing-baskets.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST signing basket call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Get Signing Basket Authorisation Sub-Resources Request

Read a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"authorisationIds": 
["123auth456"
]
}

Update PSU Data for signing basket

This method update PSU data on the signing basket resource if needed. It may authorise a igning basket within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

basketId required	string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Read the SCA status of the signing basket authorisation

This method returns the SCA status of a signing basket's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

basketId required	string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Signing Baskets (SBS)

Create a signing basket resource

Create a signing basket resource for authorising several transactions with one SCA method. The resource identifications of these transactions are contained in the payload of this access method

Authorizations:

BearerAuthOAuth

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
Consent-ID	string (consentId) This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
TPP-Explicit-Authorisation-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

Request body for a confirmation of an establishing signing basket request

paymentIds	Array of strings (paymentIdList) non-empty A list of paymentIds
consentIds	Array of strings (consentIdList) non-empty A list of consentIds

Responses

Request samples

Payload

Content type

application/json

JSON Body of a signing basket request


{"paymentIds": 
["123qwert456789",
"12345qwert7899"
]
}

Response samples

Content type

application/json

Response (always with explicit authorisation start)


{"transactionStatus": "RCVD",
"basketId": "1234-basket-567",
"_links": 
{"self": 
{"href": "/v1/signing-baskets/1234-basket-567"
},
"status": 
{"href": "/v1/signing-baskets/1234-basket-567/status"
},
"startAuthorisation": 
{"href": "/v1/signing-baskets/1234-basket-567/authorisations"
}
}
}

Returns the content of an signing basket object.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"payments": 
["1234pay567",
"1234pay568",
"1234pay888"
],
"transactionStatus": "ACTC"
}

Delete the signing basket

Delete the signing basket structure as long as no (partial) authorisation has yet been applied. The undlerying transactions are not affected by this deletion.

Remark: The signing basket as such is not deletable after a first (partial) authorisation has been applied. Nevertheless, single transactions might be cancelled on an individual basis on the XS2A interface.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type


{"tppMessages": 
[
{"category": "ERROR",
"code": "FORMAT_ERROR",
"path": "string",
"text": "string"
}
],
"_links": 
{"scaRedirect": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaOAuth": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuIdentification": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateProprietaryData": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updatePsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"updateEncryptedPsuAuthentication": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithAuthenticationMethodSelection": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"selectAuthenticationMethod": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"startAuthorisationWithTransactionAuthorisation": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"authoriseTransaction": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"self": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"status": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"scaStatus": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"account": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"balances": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"transactionDetails": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardAccount": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"cardTransactions": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"first": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"next": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"previous": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"last": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"download": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property1": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
},
"property2": 
{"href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
}
}
}

Read the status of the signing basket

Returns the status of a signing basket object.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"transactionStatus": "RCVD"
}

Start the authorisation process for a signing basket

Create an authorisation sub-resource and start the authorisation process of a signing basket. The message might in addition transmit authentication and authorisation related data.

This method is iterated n times for a n times SCA authorisation in a corporate context, each creating an own authorisation sub-endpoint for the corresponding PSU authorising the signing-baskets.

The ASPSP might make the usage of this access method unnecessary in case of only one SCA process needed, since the related authorisation resource might be automatically created by the ASPSP after the submission of the payment data with the first POST signing basket call.

The start authorisation process is a process which is needed for creating a new authorisation or cancellation sub-resource.

This applies in the following scenarios:

The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Initiation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms.
- 'startAuthorisationWithPsuIdentfication',
- 'startAuthorisationWithPsuAuthentication'
- 'startAuthorisationWithEncryptedPsuAuthentication'
- 'startAuthorisationWithAuthentciationMethodSelection'
The related payment initiation cannot yet be executed since a multilevel SCA is mandated.
The ASPSP has indicated with an 'startAuthorisation' hyperlink in the preceding Payment Cancellation Response that an explicit start of the authorisation process is needed by the TPP. The 'startAuthorisation' hyperlink can transport more information about data which needs to be uploaded by using the extended forms as indicated above.
The related payment cancellation request cannot be applied yet since a multilevel SCA is mandate for executing the cancellation.
The signing basket needs to be authorised yet.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
TPP-Redirect-Preferred	string Enum: "true" "false" If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
TPP-Redirect-URI	string <uri> URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field. Remark for Future: This field might be changed to mandatory in the next version of the specification.
TPP-Nok-Redirect-URI	string <uri> If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

null

Response samples

Content type

application/json


{"scaStatus": "received",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Get Signing Basket Authorisation Sub-Resources Request

Read a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.

Authorizations:

BearerAuthOAuth

path Parameters

basketId

required

string (basketId)

Example: 1234-basket-567

This identification of the corresponding signing basket object.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"authorisationIds": 
["123auth456"
]
}

Update PSU Data for signing basket

This method update PSU data on the signing basket resource if needed. It may authorise a igning basket within the Embedded SCA Approach where needed.

Independently from the SCA Approach it supports e.g. the selection of the authentication method and a non-SCA PSU authentication.

This methods updates PSU data on the cancellation authorisation resource if needed.

There are several possible Update PSU Data requests in the context of a consent request if needed, which depends on the SCA approach:

Redirect SCA Approach: A specific Update PSU Data Request is applicable for
- the selection of authentication methods, before choosing the actual SCA approach.
Decoupled SCA Approach: A specific Update PSU Data Request is only applicable for
- adding the PSU Identification, if not provided yet in the Payment Initiation Request or the Account Information Consent Request, or if no OAuth2 access token is used, or
- the selection of authentication methods.
Embedded SCA Approach: The Update PSU Data Request might be used
- to add credentials as a first factor authentication data of the PSU and
- to select the authentication method and
- transaction authorisation.

The SCA Approach might depend on the chosen SCA method. For that reason, the following possible Update PSU Data request can apply to all SCA approaches:

Select an SCA method in case of several SCA methods are available for the customer.

There are the following request types on this access path:

Update PSU Identification
Update PSU Authentication
Select PSU Autorization Method WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.
Transaction Authorisation WARNING: This method need a reduced header, therefore many optional elements are not present. Maybe in a later version the access path will change.

Authorizations:

BearerAuthOAuth

path Parameters

basketId required	string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-ID	string Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.
PSU-ID-Type	string Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.
PSU-Corporate-ID	string Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

One of

any

Responses

Request samples

Payload

Content type

application/json

Example

{ }

Response samples

Content type

application/json

Example

Response of an Update PSU Identification for a payment initiation request for the decoupled approach.


{"scatransactionStatus": "psuIdentified",
"psuMessage": "Please use your BankApp for transaction Authorisation.",
"_links": 
{"scaStatus": 
{"href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
}
}
}

Read the SCA status of the signing basket authorisation

This method returns the SCA status of a signing basket's authorisation sub-resource.

Authorizations:

BearerAuthOAuth

path Parameters

basketId required	string (basketId) Example: 1234-basket-567 This identification of the corresponding signing basket object.
authorisationId required	string (authorisationId) Example: 123auth456 Resource identification of the related SCA.

header Parameters

X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= Is contained if and only if the "Signature" element is contained in the header of the request.
Signature	string Example: keyId="SN=9FA1,CA=CN=D-TRUST CA 2-1 2015,O=D-Trust GmbH,C=DE",algorithm="rsa-sha256", headers="Digest X-Request-ID PSU-ID TPP-Redirect-URI Date", signature="Base64(RSA-SHA256(signing string))" A signature of the request by the TPP on application level. This might be mandated by ASPSP.
TPP-Signature-Certificate	string <byte> The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 need to be unaltered until removal from device.
PSU-Geo-Location	string Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response samples

Content type

application/json


{"scaStatus": "psuAuthenticated"
}

Mbanq PSD2 API (NextGenPSD2 XS2A v1.3.6 - 2020-07-31 - )

Summary

General Remarks on Data Types

License and External References

Authentication

BearerAuthOAuth

Payment Initiation Service (PIS)

Payment initiation request

Variants of Payment Initiation Requests

Single and mulitilevel SCA Processes

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/jsonapplication/xmlmultipart/form-data

Responses

Request samples

Response samples

Get Payment Information

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Payment Cancellation Request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Payment initiation status request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Start the authorisation process for a payment initiation

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Payment Initiation Authorisation Sub-Resources Request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Read the SCA Status of the payment authorisation

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update PSU data for payment initiation

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Start the authorisation process for the cancellation of the addressed payment

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Read the SCA status of the payment cancellation's authorisation.

Authorizations:

path Parameters

header Parameters

Responses

Request Body schema:
application/json
application/json
application/xml
multipart/form-data