Resources

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
Account Information Service (AIS)
  • /accounts
  • /accounts/{account-id}
  • /accounts/{account-id}/balances
  • /accounts/{account-id}/transactions
  • /accounts/{account-id}/transactions/{transactionId}
  • /consents
  • /consents/{consentId}
  • /consents/{consentId}/authorisations
  • /consents/{consentId}/authorisations/{authorisationId}
  • /consents/{consentId}/status
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE GET
  • GET POST
  • GET PUT
  • GET
The Account Information Service (AIS) offers the following services
  • Transaction reports for a given account or card account including balances if applicable.
  • Balances of a given account or card account,
  • A list of available accounts or card account,
  • Account details of a given account or card account or of the list of all accessible accounts or card account relative to a granted consent
Confirmation of Funds Service (PIIS)
  • /funds-confirmations
  • POST
Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the ASPSP.
Payment Initiation Service (PIS)
  • /{payment-service}/{payment-product}
  • /{payment-service}/{payment-product}/{paymentId}
  • /{payment-service}/{payment-product}/{paymentId}/authorisations
  • /{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
  • /{payment-service}/{payment-product}/{paymentId}/status
  • POST
  • GET
  • GET POST
  • GET PUT
  • GET
The Description for Payment Initiation Service (PIS) offers the following services:
  • Initiation and update of a payment request
  • Status information of a payment

Data Types

JSON

type description
AccountAccess

Requested access services for a consent.

NOTE: All permitted "access" attributes ("accounts", "balances" and "transactions") used in this message shall carry a non-empty array of account references, indicating the accounts where the type of access is requested. Please note that a "transactions" or "balances" access right also gives access to the generic /accounts endpoints, i.e. is implicitly supporting also the "accounts" access.

AccountBalanceResponse Body of the response for a successful read balance for an account request.
AccountDetails Details about an account
AccountGroup A group of accounts
AccountReference

Reference to an account by either

  • IBAN, of a payment accounts, or
  • BBAN, for payment accounts if there is no IBAN, or
  • the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
  • the Primary Account Number (PAN) of a card in a masked form, or
  • an alias to access a payment account via a registered mobile phone number (MSISDN).
AccountStatus Account status.
AccountTransactions Body of the JSON response for a successful read card account transaction list request. This card account report contains transactions resulting from the query parameters.
Accounts A list of AccountDetails.
Amount An amount of money in a certain currency
AuthenticationObject A method for strong customer authentication
AuthenticationType A specific type of an authentication method
AuthorisationUpdate Different Authorisation Bodies.
Authorisations An array of all authorisationIds
Balance A single balance element
BalanceType Type of balance.
BankTransactionCode

Bank transaction code as used by the ASPSP and using the sub elements of this structured code defined by ISO 20022.

This code type is concatenating the three ISO20022 Codes

  • Domain Code,
  • Family Code, and
  • SubFamiliy Code by hyphens, resulting in DomainCode-FamilyCode-SubFamilyCode.

Example: PMNT-RCDT-ESCT defining a transaction assigned to the PayMeNT Domain (PMNT), belonging to the family of ReceivedCreDitTransfer (RCDT) that facilitated the EuropeanSEPACreditTransfer (ESCT)

Challenge It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
Consent A consent.
ConsentCreationRequest Content of the body of a consent request.
ConsentCreationResult The response for a consent creation
ConsentData Basic information about the consent.
ConsentStatus This is the overall lifecycle status of the consent.
ConsentStatusResponse Body of the JSON response for a successful get status request for a consent.
ExternalCashAccountType1Code ExternalCashAccountType1Code
ExternalPurpose1Code The purpose of a transaction
FundsConfirmationRequest JSON Request body for the "Confirmation of Funds Service"
FundsConfirmationResponse JSON Response body for the "Confirmation of Funds Service"
HrefType Link to a resource
Links Definition of _link types. Remark: All links can be relative or full links, to be decided by the ASPSP.
LinksAccountDetails Links to the account, which can be directly used for retrieving account information from this dedicated account. Links to "balances" and/or "transactions" These links are only supported, when the corresponding consent has been already granted.
LinksAccountReport Type of links admitted in this response
LinksAll A _link object with all available link types
LinksConsents Type of links admitted in this response
LinksDownload Type of links admitted in this response. This feature shall only be used where camt-data is requested which has a huge size.
LinksGetConsent Type of links admitted in this response
LinksPaymentInitiation Type of links admitted in this response
LinksPaymentInitiationCancel Type of links admitted in this response
LinksSelectPsuAuthenticationMethod Type of links admitted in this response
LinksSigningBasket Type of links admitted in this response
LinksStartScaProcess Type of links admitted in this response
LinksTransactionDetails Type of links admitted in this response
LinksUpdatePsuAuthentication Type of links admitted in this response
LinksUpdatePsuIdentification Type of links admitted in this response
MessageCode2XX Message codes for HTTP Error codes 2XX.
OtpFormat The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
PaymentInitiationResponse Body of the response for a successful payment initiation request.
PaymentStatusResponse Body of the response for a successful payment initiation status request in case of an JSON based endpoint.
PsuData

PSU Data for PSU Authentication.

The password or encryptedPassword subfield is used, depending on encryption requirements of the ASPSP as indicated in the corresponding hyperlink contained in the last response message of the ASPSP.

Remark for Future: More details on the encrypted password transport will be published by a future bulletin.

ScaStatus
ScaStatusResponse Body of the JSON response with SCA Status.
ScaprocessResponse Common type for a sca process response.
StartScaprocessResponse Body of the JSON response for a Start SCA authorisation request.
TppMessage
TppMessage2XX
TppMessageCategory Category of the TPP message category
TransactionDetails Transaction details
TransactionLists

JSON based account report. This account report contains transactions resulting from the query parameters.

'booked' shall be contained if bookingStatus parameter is set to "booked" or "both".

'pending' is not contained if the bookingStatus parameter is set to "booked".

TransactionStatus The state of a transaction
UpdatePsuDataResponse Body of the JSON response for a Update SCA authorisation request.
Usage Specifies the usage of the account