Basic information

How to use AIS APIs?

 

Create Consent - Account


In order to retrieve a user’s account data, explicit consent has to be created and confirmed by the user. User’s account data are provided only for valid consents. By following the below listed steps a valid consent would be created:

 

1st step: POST/consents - Create consent
This method creates a consent resource, defining access rights to dedicated accounts of a given PSU-ID. For details please see call parameters description. TPP is also required to redirect the user to the authorisation server with appropriate data that is received from a successful first call (POST Create Consent), redirect links are provided within the response.

Important: Consent can be created for account data, transaction data, balance data with a single method. To obtain only account data, “accounts” has to contain valid account data in this method. To obtain transactions data, “accounts” and “transactions” in the method Create consent has to contain valid account data. To obtain balance data, “accounts” and “balances” in the method Create consent has to contain valid account data.

2nd step: GET/consents/{consentId}/status - Consent status request
Read the status of an account information consent resource. Once the »Consent status request« returns the “consentStatus” “valid”, the consent was properly authorised by the user and can be used in further flows for retrieving account data.

Optional methods:
• GET/consents/{consentId} - Get Consent Request
• DELETE/consents/{consentId} - Delete Consent
• GET/consents/{consentId}/authorisations - Get Consent Authorisation Sub-Resources Request
• GET/consents/{consentId}/authorisations/{authorisationId} - Read the SCA status of the consent authorisation.

Create consent

 

Get Account Details


Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” in the method Create consent.
Steps to get account data details:

 

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires to provide the consentID as a header parameter, and will return the correct account according to the provided consent.

2nd step: GET/accounts/{account-id} - Read Account Details
Returns details about an account based on the provided resource ID, obtained with the method Read Account List, with balances where applicable.

 

Get Account Transaction List and/or Transaction details


Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” and “transactions” in the method Create consent.
Steps to get transaction list and details data:

 

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires a consentID to be provided as a header parameter, according to which the correct account is returned.

2nd step: GET/accounts/{account-id}/transactions - Read Transaction List
Read transaction reports or transaction lists of a given account addressed by "account-id", depending on the steering parameter "bookingStatus" together with balances.
Important: The »Read Transaction List« call has some query parameters that can be used to narrow down the list of returned data, please check the specifications of this call for more details.

3rd step: GET/accounts/{account-id}/transactions/{transactionId} - Read Transaction Details
Reads transaction details from a given transaction addressed by "resourceId" on a given account addressed by "account-id". This call is only available on transactions as reported in a JSON format.

get_account_transactions
 

Read Account Balances


Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts” and “balances” in the method Create consent.
Steps to get balance data:

 

1st step: GET/accounts - Read Account List
Read the identifiers (resource ID) of the available payment account together with booking balance information, depending on the consent granted. This method requires a consentID to be provided as a header parameter, according to which the correct account is returned.

2nd step: GET/accounts/{account-id}/balances Read Balance
Reads account balance data from a given account addressed by "account-id".

How to use PIIS APIs?

Check Funds Available
Prerequisite: valid consent (see Create consent) with valid IBAN in “accounts”, parameters “confirmationOfFundsAllowed” with the value “true” and “validUntil” has to be set to “9999-12-31”, in addition, “accounts” has to contain valid account data, “transactions” and “balances” have to be empty in the method Create consent.

Steps to check if funds are available for payment execution:

1st step: POST/funds-confirmations - Confirmation of Funds Request
Checks whether a specific amount is available at the time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively.

How to use PIS APIs?

Initiate Payment – SCA required


Steps to initiate a payment:

 

1st step: POST/{payment-service}/{payment-product} - Payment initiation request
This method is used to initiate a payment at the ASPSP. Parameters of this call are described in details under the method specification. 
Important: After the initial »Payment Initiation Request« the user needs to be redirected to the authorisation URL provided in »scaRedirect« of the response.

2nd step: GET/{payment-service}/{payment-product}/{paymentId}/status - Payment initiation status request
This call is optional, but gives essential information regarding the transaction status of a payment initiation.

Optional methods:
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId} - Read the SCA Status of the payment authorisation
• GET/{payment-service}/{payment-product}/{paymentId} - Get Payment Information
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations - Get Payment Initiation Authorisation Sub-Resources Request

Initiate_payment_sca

Initiate Payment – SCA not required
Steps to initiate a payment:

1st step: POST/{payment-service}/{payment-product} - Payment initiation request
This method is used to initiate a payment at the ASPSP. Parameters of this call are described in details under the method specification.

2nd step: GET/{payment-service}/{payment-product}/{paymentId}/status - Payment initiation status request
This call is optional, but gives essential information regarding the transaction status of a payment initiation.

Optional methods:
• GET/{payment-service}/{payment-product}/{paymentId} - Get Payment Information
• GET/{payment-service}/{payment-product}/{paymentId}/authorisations - Get Payment Initiation Authorisation Sub-Resources Request

Glossary

AISPAccount Information Service provider
PISPPayment initiation service provider
PIISPPayment Instrument Issuer Service Providers
PSUPayment service user
TPPThird-party provider
ASPSPAccount Servicing Payment Service Providers
SCAStrong Customer Authentication