Summary

Nikulipe provides access to E-Money bank accounts of its Clients over the Open Banking API. This API is offered as part of PSD2 regulation.

This API document is based on the NextGenPSD2 Framework Version 1.3.6 (with errata) created by The Berlin Group and was modified to match Nikulipe's API implementation.

The NextGenPSD2 Framework Version 1.3.6 (with errata) offers a modern, open, harmonised and interoperable set of Application Programming Interfaces (APIs) as the safest and most efficient way to provide data securely. The NextGenPSD2 Framework reduces XS2A complexity and costs, addresses the problem of multiple competing standards in Europe and, aligned with the goals of the Euro Retail Payments Board, enables European banking customers to benefit from innovative products and services ('Banking as a Service') by granting TPPs safe and secure (authenticated and authorised) access to their bank accounts and financial data.

The possible Approaches supported by Nikulipe UAB are:

  • Redirect SCA Approach

    Not every message defined in this API definition is necessary for all approaches. Furthermore this API definition does not differ between methods which are mandatory, conditional, or optional. Therefore for a particular implementation of a Berlin Group PSD2 compliant API it is only necessary to support a certain subset of the methods defined in this API definition.

  • Please have a look at the implementation guidelines if you are not sure which message has to be used for the approach you are going to use.*

General Remarks on Data Types

The Berlin Group definition of UTF-8 strings in context of the PSD2 API has 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

Payment Initiation Service (PIS)

The component 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 a JSON body.

There are the following payment products:

  • Payment products with payment information in JSON format:
    • sepa-credit-transfers

Nikulipe only offers single level SCA Processes

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

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. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Rejection-NoFunds-Preferred
boolean

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.

TPP-Brand-Logging-Information
string

This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. This header might be ignored by the ASPSP.

TPP-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related 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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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

JSON request body for a payment inition request message.

There are the following payment-products supported:

  • "sepa-credit-transfers" with JSON-Body

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

One of
  • paymentInitiation_json
endToEndIdentification
string <= 35 characters
debtorAccount
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
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
instructedAmount
required
object (amount)
creditorAccount
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
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
creditorAgent
string (bicfi) [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}

BICFI

creditorAgentName
string (creditorAgentName) <= 70 characters

Creditor agent name.

creditorName
required
string (creditorName) <= 70 characters

Creditor name.

creditorAddress
object (address)
remittanceInformationUnstructured
string (remittanceInformationUnstructured) <= 140 characters

Unstructured remittance information.

Responses

201

CREATED

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/payments/{payment-product}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "instructedAmount":
    {
    },
  • "debtorAccount":
    {
    },
  • "creditorName": "Merchant123",
  • "creditorAccount":
    {
    },
  • "remittanceInformationUnstructured": "Ref Number Merchant"
}

Response samples

Content type
application/json

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

Copy
Expand all Collapse all
{
  • "transactionStatus": "RCVD",
  • "paymentId": "1234-wertiq-983",
  • "_links":
    {
    }
}

Get payment information

Returns the content of a payment object

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "endToEndIdentification": "string",
  • "debtorAccount":
    {
    },
  • "instructedAmount":
    {
    },
  • "creditorAccount":
    {
    },
  • "creditorAgent": "AAAADEBBXXX",
  • "creditorName": "Creditor Name",
  • "creditorAddress":
    {
    },
  • "remittanceInformationUnstructured": "Ref Number Merchant",
  • "transactionStatus": "ACCP"
}

Payment initiation status request

Check the transaction status of a payment initiation.

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}/status

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/status

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/status

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "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 operation is currently not required, as Nikulipe only provides SCA Redirect approach/single SCA payments and initiating a payment implicitly creates the requires authorisation.

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.

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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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
any

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Request samples

Content type
application/json
Copy
Expand all Collapse all
null

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "received",
  • "authorisationId": "123auth456",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links":
    {
    }
}

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:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "authorisationIds":
    [
    ]
}

Read the SCA status of the payment authorisation

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

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "psuAuthenticated",
  • "trustedBeneficiaryFlag": false
}

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 addressed by IBAN and TPP respectively. If the related extended services are used a conditional Consent-ID is contained in the header. This field is contained but commented out in this specification.

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.

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.

account
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
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
payee
string <= 70 characters

Name payee.

instructedAmount
required
object (amount)

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/funds-confirmations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/funds-confirmations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/funds-confirmations

Request samples

Content type
application/json

Request body for a confirmation of funds.

Copy
Expand all Collapse all
{
  • "account":
    {
    },
  • "instructedAmount":
    {
    }
}

Response samples

Content type
application/json

Response for a confirmation of funds request.

Copy
Expand all Collapse all
{
  • "fundsAvailable": "true"
}

Account Information Service (AIS)

The Account Information Service (AIS) offers the following services:

  • Transaction reports for a given account including balances if applicable
  • Balances of a given account
  • A list of available accounts
  • Account details of a given account or of the list of all accessible accounts 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.

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:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/accounts

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/accounts

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/accounts

Response samples

Content type
application/json
Example

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

Copy
Expand all Collapse all
{
  • "accounts":
    [
    ]
}

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.

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:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/accounts/{account-id}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/accounts/{account-id}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/accounts/{account-id}

Response samples

Content type
application/json
Example

Account details for a regular Account.

Copy
Expand all Collapse all
{
  • "account":
    {
    }
}

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:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/accounts/{account-id}/balances

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/accounts/{account-id}/balances

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/accounts/{account-id}/balances

Response samples

Content type
application/json
Example

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

Copy
Expand all Collapse all
{
  • "account":
    {
    },
  • "balances":
    [
    ]
}

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:
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 and if bookingStatus does not equal "information.

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: "information" "booked" "pending" "both"

Permitted codes are

  • "information",
  • "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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/accounts/{account-id}/transactions

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/accounts/{account-id}/transactions

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/accounts/{account-id}/transactions

Response samples

Content type
application/json
Example

Response in JSON format for an access on a regular account.

Copy
Expand all Collapse all
{
  • "account":
    {
    },
  • "transactions":
    {
    }
}

Create consent

This method create a consent resource, defining access rights to dedicated accounts of a given PSU-ID. These accounts are addressed explicitly in the method as parameters as a core function.

Side Effects When this consent request is a request where the "recurringIndicator" equals "true", and if it exists already a former consent for recurring access on account information for the addressed PSU, then the former consent automatically expires as soon as the new consent request is authorised by the PSU.

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.

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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Brand-Logging-Information
string

This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. This header might be ignored by the ASPSP.

TPP-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related 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-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. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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 consents request.

access
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 defining a valid until date (including the mentioned 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.

If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4.

combinedServiceIndicator
required
boolean (combinedServiceIndicator)

If "true" indicates that a payment initiation service will be addressed in the same "session".

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/consents

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents

Request samples

Content type
application/json
Example

Consent request on dedicated accounts.

Copy
Expand all Collapse all
{
  • "access":
    {
    },
  • "recurringIndicator": "true",
  • "validUntil": "2017-11-01",
  • "frequencyPerDay": "4"
}

Response samples

Content type
application/json

Consent request response in case of a redirect.

Copy
Expand all Collapse all
{
  • "consentStatus": "received",
  • "consentId": "1234-wertiq-983",
  • "_links":
    {}
}

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 redirect SCA Approach.

Authorizations:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}

Response samples

Content type
application/json

Consent request on account list or without indication of accounts.

Copy
Expand all Collapse all
{
  • "access":
    {
    },
  • "recurringIndicator": "true",
  • "validUntil": "2017-11-01",
  • "frequencyPerDay": "4",
  • "consentStatus": "valid",
  • "_links":
    {
    }
}

Delete consent

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

Authorizations:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

delete/v1/consents/{consentId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}

Response samples

Content type
Copy
Expand all Collapse all
{
  • "tppMessages":
    [
    ],
  • "_links":
    {
    }
}

Consent status request

Read the status of an account information consent resource.

Authorizations:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/status

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/status

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/status

Response samples

Content type
application/json

Response for a consent status request.

Copy
Expand all Collapse all
{
  • "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 operation is currently not required, as Nikulipe only provides SCA Redirect approach and creating a consent implicitly creates the requires authorisation.

Authorizations:
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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.

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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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
any

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/consents/{consentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Request samples

Content type
application/json
Copy
Expand all Collapse all
null

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "received",
  • "authorisationId": "123auth456",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links":
    {
    }
}

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:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "authorisationIds":
    [
    ]
}

Read the SCA status of the consent authorisation

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

Authorizations:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/authorisations/{authorisationId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations/{authorisationId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations/{authorisationId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "psuAuthenticated",
  • "trustedBeneficiaryFlag": false
}

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 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) 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 operation is currently not required, as Nikulipe only provides SCA Redirect approach/single SCA payments and initiating a payment implicitly creates the requires authorisation.

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.

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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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
any

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Request samples

Content type
application/json
Copy
Expand all Collapse all
null

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "received",
  • "authorisationId": "123auth456",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links":
    {
    }
}

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:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "authorisationIds":
    [
    ]
}

Read the SCA status of the payment authorisation

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

Authorizations:
path Parameters
payment-product
required
string
Value: "sepa-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 following payment products are supported:

  • sepa-credit-transfers
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/payments/{payment-product}/{paymentId}/authorisations/{authorisationId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "psuAuthenticated",
  • "trustedBeneficiaryFlag": false
}

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 operation is currently not required, as Nikulipe only provides SCA Redirect approach and creating a consent implicitly creates the requires authorisation.

Authorizations:
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.

PSU-ID-Type
string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.

In this case, the mean and use are then defined in the ASPSP’s documentation.

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.

TPP-Redirect-URI
required
string <uri>

URI of the TPP, where the transaction flow shall be redirected to after a Redirect.

Mandated for the Redirect SCA Approach.

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-Notification-URI
string

URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP.

For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP. The following applies:

URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction- id/notifications would be compliant.

Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.

TPP-Notification-Content-Preferred
string

The string has the form

status=X1, ..., Xn

where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics:

SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP.

PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.

This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.

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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
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
any

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post/v1/consents/{consentId}/authorisations

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations

Request samples

Content type
application/json
Copy
Expand all Collapse all
null

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "received",
  • "authorisationId": "123auth456",
  • "psuMessage": "Please use your BankApp for transaction Authorisation.",
  • "_links":
    {
    }
}

Read the SCA status of the consent authorisation

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

Authorizations:
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 needs to be unaltered until removal from device.

PSU-Geo-Location
string GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}
Example: GEO:52.506931;13.144558

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

409

Conflict

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

get/v1/consents/{consentId}/authorisations/{authorisationId}

Nikulipe PSD2 live server

https://oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations/{authorisationId}

Nikulipe PSD2 test server

https://sandbox-oba.nikulipe.com/psd2/v1/consents/{consentId}/authorisations/{authorisationId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scaStatus": "psuAuthenticated",
  • "trustedBeneficiaryFlag": false
}