Api documentation

Api documentation get started

Api documentation

References - NextGenPSD2XS2AFrameworkforCroatia 1.3.3 Aug 19th 2019 - HR Country Specific Json Yaml

Read transaction list of an account

GET /v1/card-accounts/{account-id}/transactions

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

Parameter Type/Format Description
deltaList
Optional

Query / 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
Optional

Query / 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.

bookingStatus
Required

Query / string

Permitted codes are

  • "booked",
  • "pending" and
  • "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend

entryReferenceFrom
Optional

Query / 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.

dateTo
Optional

Query / string

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.

dateFrom
Optional

Query / string

Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.

For booked transactions, the relevant date is the booking date.

For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

account-id
Required

Path /

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.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests

Create consent

POST /v1/consents

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.

Optional Extension: As an option, an ASPSP might optionally accept a specific access right on the access on all psd2 related services for all available accounts.

As another option an ASPSP might optionally also accept a command, where only access rights are inserted without mentioning the addressed account. The relation to accounts is then handled afterwards between PSU and ASPSP. This option is not supported for the Embedded SCA Approach. As a last option, an ASPSP might in addition accept a command with access rights

  • to see the list of available payment accounts or
  • to see the list of available payment accounts with balances.

Consumes
application/json
Parameter Type/Format Description
PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

TPP-Explicit-Authorisation-Preferred
Optional

Header / string

If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.

If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

consents
Required

body / object

Requestbody for a consents request

Sample Request

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

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "consentStatus": "received",
  "consentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/authentication/1234-wertiq-983"
    },
    "status": {
      "href": "/v1/consents/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "v1/consents/1234-wertiq-983/authorisations/123auth567"
    }
  }
}

Get Consent Request

GET /v1/consents/{consentId}

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

Parameter Type/Format Description
consentId
Required

Path /

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

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

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-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept-Charset
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "access": {
    "balances": [
      {
        "iban": "DE2310010010123456789"
      },
      {
        "iban": "DE2310010010123456789"
      }
    ],
    "transactions": [
      {
        "iban": "DE2310010010123456789"
      },
      {
        "iban": "DE2310010010123456789"
      },
      {
        "pan": "123456xxxxxx3457"
      },
      {
        "pan": "123456xxxxxx3457"
      }
    ]
  },
  "recurringIndicator": "true",
  "validUntil": "2017-11-01",
  "frequencyPerDay": "4",
  "consentStatus": "valid",
  "_links": {
    "account": {
      "href": "/v1/accounts"
    }
  }
}

Delete Consent

DELETE /v1/consents/{consentId}

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

Parameter Type/Format Description
PSU-Geo-Location
Optional

Header / string

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

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

consentId
Required

Path /

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

Response

400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests

Consent status request

GET /v1/consents/{consentId}/status

Read the status of an account information consent resource.

Parameter Type/Format Description
Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

consentId
Required

Path /

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "consentStatus": "valid"
}

Get Consent Authorisation Sub-Resources Request

GET /v1/consents/{consentId}/authorisations

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.

Parameter Type/Format Description
PSU-Geo-Location
Optional

Header / string

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

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

consentId
Required

Path /

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "authorisationIds": [
    "123auth456"
  ]
}

Read card account balances

GET /v1/card-accounts/{account-id}/balances

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

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

Parameter Type/Format Description
account-id
Required

Path /

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.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "cardAccount": {
    "maskedPan": "525412******3241"
  },
  "balances": [
    {
      "balanceType": "interimBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "14355.78"
      }
    },
    {
      "balanceType": "interimBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "14355.78"
      }
    },
    {
      "balanceType": "nonInvoiced",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "4175.86"
      }
    },
    {
      "balanceType": "nonInvoiced",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "4175.86"
      }
    }
  ]
}

Reads details about a card account

GET /v1/card-accounts/{account-id}

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

Parameter Type/Format Description
PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

account-id
Required

Path /

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.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "cardAccount": {
    "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
    "maskedPan": "525412******3241",
    "currency": "EUR",
    "name": "Main",
    "product": "Basic Credit",
    "status": "enabled",
    "creditLimit": {
      "currency": "EUR",
      "amount": "15000"
    },
    "balances": [
      {
        "balanceType": "interimBooked",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "14355.78"
        }
      },
      {
        "balanceType": "interimBooked",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "14355.78"
        }
      },
      {
        "balanceType": "nonInvoiced",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "4175.86"
        }
      },
      {
        "balanceType": "nonInvoiced",
        "balanceAmount": {
          "currency": "EUR",
          "amount": "4175.86"
        }
      }
    ],
    "_links": {
      "transactions": {
        "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
      }
    }
  }
}

Read Transaction Details

GET /v1/accounts/{account-id}/transactions/{resourceId}

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

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

Parameter Type/Format Description
account-id
Required

Path /

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

resourceId
Required

Path /

This identification is given by the attribute resourceId of the corresponding entry of a transaction list.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "transactionsDetails": {
    "transactionId": "1234567",
    "creditorName": "John Miles",
    "creditorAccount": {
      "iban": "DE67100100101306118605"
    },
    "mandateId": "Mandate-2018-04-20-1234",
    "transactionAmount": {
      "currency": "EUR",
      "amount": "-256.67"
    },
    "bookingDate": "2017-10-25",
    "valueDate": "2017-10-26",
    "remittanceInformationUnstructured": "Example 1",
    "bankTransactionCode": "PMNT-RCVD-ESDD"
  }
}

Reads a list of card accounts

GET /v1/card-accounts

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

Parameter Type/Format Description
X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "cardAccounts": [
    {
      "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
      "maskedPan": "525412******3241",
      "currency": "EUR",
      "name": "Main",
      "product": "Basic Credit",
      "status": "enabled",
      "creditLimit": {
        "currency": "EUR",
        "amount": "15000"
      },
      "balances": [
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "nonInvoiced",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        },
        {
          "balanceType": "nonInvoiced",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        }
      ],
      "_links": {
        "transactions": {
          "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
        }
      }
    },
    {
      "resourceId": "3d9a81b3-a47d-4130-8765-a9c0ff861b99",
      "maskedPan": "525412******3241",
      "currency": "EUR",
      "name": "Main",
      "product": "Basic Credit",
      "status": "enabled",
      "creditLimit": {
        "currency": "EUR",
        "amount": "15000"
      },
      "balances": [
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "interimBooked",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "14355.78"
          }
        },
        {
          "balanceType": "nonInvoiced",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        },
        {
          "balanceType": "nonInvoiced",
          "balanceAmount": {
            "currency": "EUR",
            "amount": "4175.86"
          }
        }
      ],
      "_links": {
        "transactions": {
          "href": "/v1/card-accounts/3d9a81b3-a47d-4130-8765-a9c0ff861b99/transactions"
        }
      }
    }
  ]
}

Read Account List

GET /v1/accounts

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

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

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

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

Parameter Type/Format Description
withBalance
Optional

Query / 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.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "accounts": [
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "DE2310010010123456789",
      "currency": "EUR",
      "product": "Girokonto",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
      "iban": "DE2310010010123456789",
      "currency": "EUR",
      "product": "Girokonto",
      "cashAccountType": "CACC",
      "name": "Main Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
        },
        "transactions": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "DE2310010010123456788",
      "currency": "USD",
      "product": "Fremdw?hrungskonto",
      "cashAccountType": "CACC",
      "name": "US Dollar Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    },
    {
      "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e81g",
      "iban": "DE2310010010123456788",
      "currency": "USD",
      "product": "Fremdw?hrungskonto",
      "cashAccountType": "CACC",
      "name": "US Dollar Account",
      "_links": {
        "balances": {
          "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e81g/balances"
        }
      }
    }
  ]
}

Read Account Details

GET /v1/accounts/{account-id}

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

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

Give detailed information about the addressed account.

Give detailed information about the addressed account together with balance information

Parameter Type/Format Description
account-id
Required

Path /

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.

withBalance
Optional

Query / 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.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "account": {
    "resourceId": "3dc3d5b3-7023-4848-9853-f5400a64e80f",
    "iban": "FR7612345987650123456789014",
    "currency": "EUR",
    "product": "Girokonto",
    "cashAccountType": "CACC",
    "name": "Main Account",
    "_links": {
      "balances": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/balances"
      },
      "transactions": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f/transactions"
      }
    }
  }
}

Read Balance

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

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.

Parameter Type/Format Description
PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Accept-Language
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

account-id
Required

Path /

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.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "account": {
    "iban": "FR7612345987650123456789014"
  },
  "balances": [
    {
      "balanceType": "closingBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "500.00"
      },
      "referenceDate": "2017-10-25"
    },
    {
      "balanceType": "closingBooked",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "500.00"
      },
      "referenceDate": "2017-10-25"
    },
    {
      "balanceType": "expected",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "900.00"
      },
      "lastChangeDateTime": "2017-10-25T15:30:35.035Z"
    },
    {
      "balanceType": "expected",
      "balanceAmount": {
        "currency": "EUR",
        "amount": "900.00"
      },
      "lastChangeDateTime": "2017-10-25T15:30:35.035Z"
    }
  ]
}

Read transaction list of an account

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

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.

Parameter Type/Format Description
PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Encoding
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-ID
Required

Header /

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

account-id
Required

Path /

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.

dateFrom
Optional

Query / string

Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required.

For booked transactions, the relevant date is the booking date.

For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.

dateTo
Optional

Query / string

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
Optional

Query / 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

Query / string

Permitted codes are

  • "booked",
  • "pending" and
  • "both" "booked" shall be supported by the ASPSP. To support the "pending" and "both" feature is optional for the ASPSP, Error code if not supported in the online banking frontend

deltaList
Optional

Query / 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
Optional

Query / 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.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "account": {
    "iban": "DE2310010010123456788"
  },
  "transactions": {
    "booked": [
      {
        "transactionId": "1234567",
        "creditorName": "John Miles",
        "creditorAccount": {
          "iban": "DE67100100101306118605"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "256.67"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 1"
      },
      {
        "transactionId": "1234567",
        "creditorName": "John Miles",
        "creditorAccount": {
          "iban": "DE67100100101306118605"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "256.67"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 1"
      },
      {
        "transactionId": "1234568",
        "debtorName": "Paul Simpson",
        "debtorAccount": {
          "iban": "NL76RABO0359400371"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "343.01"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 2"
      },
      {
        "transactionId": "1234568",
        "debtorName": "Paul Simpson",
        "debtorAccount": {
          "iban": "NL76RABO0359400371"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "343.01"
        },
        "bookingDate": "2017-10-25",
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 2"
      }
    ],
    "pending": [
      {
        "transactionId": "1234569",
        "creditorName": "Claude Renault",
        "creditorAccount": {
          "iban": "FR7612345987650123456789014"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "-100.03"
        },
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 3"
      },
      {
        "transactionId": "1234569",
        "creditorName": "Claude Renault",
        "creditorAccount": {
          "iban": "FR7612345987650123456789014"
        },
        "transactionAmount": {
          "currency": "EUR",
          "amount": "-100.03"
        },
        "valueDate": "2017-10-26",
        "remittanceInformationUnstructured": "Example 3"
      }
    ],
    "_links": {
      "account": {
        "href": "/v1/accounts/3dc3d5b3-7023-4848-9853-f5400a64e80f"
      }
    }
  }
}

Start the authorisation process for a consent

POST /v1/consents/{consentId}/authorisations

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

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

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

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

This applies in the following scenarios:

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

Consumes
application/json
Parameter Type/Format Description
consentId
Required

Path /

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

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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


Required

body /

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Read the SCA status of the consent authorisation.

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

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

Parameter Type/Format Description
consentId
Required

Path /

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

authorisationId
Required

Path /

Resource identification of the related SCA.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests

Update PSU Data for consents

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

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

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

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

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

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

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

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

There are the following request types on this access path:

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

Consumes
application/json
Parameter Type/Format Description
consentId
Required

Path /

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

authorisationId
Required

Path /

Resource identification of the related SCA.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-IP-Address
Optional

Header / string

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
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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


Required

body /

Sample Request

{}

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
406 - Not Acceptable
409 - Conflict
429 - Too Many Requests
{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Confirmation of Funds Request

POST /v1/funds-confirmations

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

Consumes
application/json
Parameter Type/Format Description
X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Consent-ID
Optional

Header /

This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

confirmationOfFunds
Required

body / object

Request body for a confirmation of funds request.

Sample Request

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "fundsAvailable": "true"
}

Create a signing basket resource

POST /v1/signing-baskets

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

Consumes
application/json
Parameter Type/Format Description
Consent-ID
Optional

Header /

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

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

TPP-Explicit-Authorisation-Preferred
Optional

Header / string

If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.

If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

signingBasket
Required

body / object

Request body for a confirmation of an establishing signing basket request

Sample Request

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

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "transactionStatus": "RCVD",
  "basketId": "1234-basket-567",
  "_links": {
    "self": {
      "href": "/v1/signing-baskets/1234-basket-567"
    },
    "status": {
      "href": "/v1/signing-baskets/1234-basket-567/status"
    },
    "startAuthorisation": {
      "href": "/v1/signing-baskets/1234-basket-567/authorisations"
    }
  }
}

Returns the content of an signing basket object.

GET /v1/signing-baskets/{basketId}

Returns the content of an signing basket object.

Parameter Type/Format Description
PSU-Accept-Charset
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

basketId
Required

Path /

This identification of the corresponding signing basket object.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "payments": [
    "1234pay567",
    "1234pay568",
    "1234pay888"
  ],
  "transactionStatus": "ACTC"
}

Delete the signing basket

DELETE /v1/signing-baskets/{basketId}

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

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

Parameter Type/Format Description
PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Geo-Location
Optional

Header / string

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

basketId
Required

Path /

This identification of the corresponding signing basket object.

Response

400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

Read the status of the signing basket

GET /v1/signing-baskets/{basketId}/status

Returns the status of a signing basket object.

Parameter Type/Format Description
X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

basketId
Required

Path /

This identification of the corresponding signing basket object.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

Start the authorisation process for a signing basket

POST /v1/signing-baskets/{basketId}/authorisations

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

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

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

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

This applies in the following scenarios:

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

Consumes
application/json
Parameter Type/Format Description
basketId
Required

Path /

This identification of the corresponding signing basket object.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Accept-Language
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.


Required

body /

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Get Signing Basket Authorisation Sub-Resources Request

GET /v1/signing-baskets/{basketId}/authorisations

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.

Parameter Type/Format Description
PSU-Accept-Charset
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

basketId
Required

Path /

This identification of the corresponding signing basket object.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "authorisationIds": [
    "123auth456"
  ]
}

Update PSU Data for signing basket

PUT /v1/signing-baskets/{basketId}/authorisations/{authorisationId}

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

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

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

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

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

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

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

There are the following request types on this access path:

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

Consumes
application/json
Parameter Type/Format Description
PSU-Accept-Charset
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Accept-Language
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Encoding
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

basketId
Required

Path /

This identification of the corresponding signing basket object.

authorisationId
Required

Path /

Resource identification of the related SCA.


Required

body /

Sample Request

{}

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Read the SCA status of the signing basket authorisation

GET /v1/signing-baskets/{basketId}/authorisations/{authorisationId}

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

Parameter Type/Format Description
basketId
Required

Path /

This identification of the corresponding signing basket object.

authorisationId
Required

Path /

Resource identification of the related SCA.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

PSU-Geo-Location
Optional

Header / string

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

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

Update PSU data for payment initiation

PUT /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

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

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

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

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

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

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

There are the following request types on this access path:

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

Consumes
application/json
Parameter Type/Format Description
payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

authorisationId
Required

Path /

Resource identification of the related SCA.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.


Required

body /

Sample Request

{}

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Start the authorisation process for a payment initiation

POST /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

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

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

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

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

This applies in the following scenarios:

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

Consumes
application/json
Parameter Type/Format Description
PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.


Required

body /

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Get Payment Initiation Authorisation Sub-Resources Request

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations

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.

Parameter Type/Format Description
payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "authorisationIds": [
    "123auth456"
  ]
}

Read the SCA Status of the payment authorisation

GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

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

Parameter Type/Format Description
Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

authorisationId
Required

Path /

Resource identification of the related SCA.

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

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

GET /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}

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

Parameter Type/Format Description
PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Geo-Location
Optional

Header / string

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

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

cancellationId
Required

Path /

Identification for cancellation resource.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

Update PSU Data for payment initiation cancellation

PUT /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}

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

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

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

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

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

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

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

There are the following request types on this access path:

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

Consumes
application/json
Parameter Type/Format Description
Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Geo-Location
Optional

Header / string

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

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

cancellationId
Required

Path /

Identification for cancellation resource.

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments


Required

body /

Sample Request

{}

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scatransactionStatus": "psuIdentified",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Start the authorisation process for the cancellation of the addressed payment

POST /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

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

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

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

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

This applies in the following scenarios:

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

Parameter Type/Format Description
TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

Response

201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "scaStatus": "received",
  "psuMessage": "Please use your BankApp for transaction Authorisation.",
  "_links": {
    "scaStatus": {
      "href": "/v1/payments/qwer3456tzui7890/authorisations/123auth456"
    }
  }
}

Payment initiation request

POST /v1/{payment-service}/{payment-product}

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

Variants of Payment Initiation Requests

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

There are the following payment products:

  • Payment products with payment information in JSON format:

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

    • pain.001-credit-transfers

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

Furthermore the request body depends on the payment-service

  • payments: A single payment initiation request.

    In case of single payments, only the JSON format is mandatory. The pain.001 message implementations are ASPSP specific, see individual standard descriptions for your ASPSP.

  • bulk-payments: A collection of several payment iniatiation requests.

    In case of a pain.001 message there are more than one payments contained in the pain.001 message.

Single and mulitilevel SCA Processes

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

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

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

Consumes
application/json
Parameter Type/Format Description
PSU-Geo-Location
Optional

Header / string

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

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Accept-Language
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-ID
Optional

Header / string

Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. Is not contained if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

PSU-ID-Type
Optional

Header / string

Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. It is mandatory in case the PSU-ID is supplied by the TPP.

PSU-Corporate-ID
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context.

PSU-Corporate-ID-Type
Optional

Header / string

Might be mandated in the ASPSP's documentation. Only used in a corporate context. In case PSU-Corporate-ID is provided this field is mandatory.

Consent-ID
Optional

Header /

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

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

TPP-Redirect-Preferred
Optional

Header / string

If it equals "true", the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.

TPP-Redirect-URI
Optional

Header / string

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

Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.

Remark for Future: This field might be changed to mandatory in the next version of the specification.

TPP-Nok-Redirect-URI
Optional

Header / string

If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

TPP-Explicit-Authorisation-Preferred
Optional

Header / string

If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.

If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.

TPP-Rejection-NoFunds-Preferred
Optional

Header / string

If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available.

If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment.

This parameter might be ignored by the ASPSP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

paymentInitiation
Required

body /

JSON request body for a payment inition request message

There are the following payment-products supported:

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

There are the following payment-services supported:

  • "payments"
  • "bulk-paments"

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

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

Sample Request

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

Response

201 - CREATED
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "transactionStatus": "RCVD",
  "paymentId": "1234-wertiq-983",
  "_links": {
    "scaRedirect": {
      "href": "https://www.testbank.com/asdfasdfasdf"
    },
    "self": {
      "href": "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/v1/payments/1234-wertiq-983/status"
    },
    "scaStatus": {
      "href": "/v1/payments/1234-wertiq-983/authorisations/123auth456"
    }
  }
}

Get Payment Information

GET /v1/{payment-service}/{payment-product}/{paymentId}

Returns the content of a payment object

Parameter Type/Format Description
payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict

Payment Cancellation Request

DELETE /v1/{payment-service}/{payment-product}/{paymentId}

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

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

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

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

Parameter Type/Format Description
payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / 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
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

Response

202 - Received
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "transactionStatus": "ACTC",
  "_links": {
    "self": {
      "href": "/v1/payments/123456scheduled789"
    },
    "status": {
      "href": "/v1/payments/123456scheduled789/status"
    },
    "startAuthorisation": {
      "href": "/v1/payments/123456scheduled789/cancellation-authorisations"
    }
  }
}

Payment initiation status request

GET /v1/{payment-service}/{payment-product}/{paymentId}/status

Check the transaction status of a payment initiation.

Parameter Type/Format Description
PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
Optional

Header / string

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

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "transactionStatus": "ACCP"
}

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

GET /v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations

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

Parameter Type/Format Description
payment-service
Required

Path / string

Payment service:

Possible values are:

  • payments
  • bulk-payments

payment-product
Required

Path / string

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

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

The following payment products are supported for single payments:

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

The following payment products are supported for bulk payments:

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

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

paymentId
Required

Path /

Resource identification of the generated payment initiation resource.

X-Request-ID
Required

Header / string

ID of the request, unique to the call, as determined by the initiating party.

Digest
Optional

Header / string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature
Optional

Header / string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
Optional

Header / string

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

PSU-IP-Address
Optional

Header / string

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
Optional

Header / string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept-Charset
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Geo-Location
Optional

Header / string

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

PSU-Device-ID
Optional

Header / string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Http-Method
Optional

Header / string

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

PSU-User-Agent
Optional

Header / string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Accept-Language
Optional

Header / 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
Optional

Header / string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

Response

200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not found
405 - Method Not Allowed
409 - Conflict
{
  "cancellationIds": [
    "123auth456"
  ]
}

POST /v1/{payment-service}/{payment-product}/fees

TransactionFeeCheck

Consumes
application/json
Parameter Type/Format Description

Sample Request

{test sample}

Response

{test sample}

POST /v1/{payment-service}/{payment-product}/validate

PaymentValidationInCBS

Consumes
application/json
Parameter Type/Format Description

Response