Accessibility
  • Font size

    Ordinary

    Large

  • Letter spacing

    Ordinary

    Large

  • Color scheme

    Ordinary

    Black and white

Contact us

Dedicated API Functionality

Dedicated API Functionality
Version Change Description Date
v.1.0 Initial version 30.04.26
v.1.1 Clarified Section 2.4 regarding the 31-day transaction history period 05.06.26
v.1.2 Updated the link to the page with the detailed specification version descriptions 08.05.26

 

This document provides a general overview of the dedicated APIs. Detailed documentation for the specification version used by the ASPSP is available at: https://docs.api.upc.ua/ua/api-servisi/regulyatorni-api

 

1. PIS (Payment Initiation Service) — Payment Initiation Service

The Payment Initiation Service (PIS) enables a Third Party Provider (TPP) to initiate payments on behalf of a Payment Service User (PSU). To initiate a payment, the TPP must obtain the PSU's authorization (transaction confirmation). The PSU provides consent during a Strong Customer Authentication (SCA) session.

 

Main PIS functions

 

1.1. Payment initiation

The TPP initiates a payment by sending a request using the POST /pis/v2/payments/{payment-product} endpoint. The request includes the payer's account details (IBAN), the transfer amount and currency, the beneficiary's details (name, identifier, and IBAN), and the payment purpose. The platform returns a unique transaction identifier (paymentId) and the initial payment status (RCVD — Received).

 

1.2. Starting the authorization (SCA)

After initiating the payment, the TPP explicitly starts the authorization process by calling the POST /pis/v2/payments/{payment-product}/{payment-id}/authorisations endpoint. Two SCA approaches are supported:

  • Decoupled SCA. The platform returns a message for the PSU ($.psuMessage), for example: "Authorize the payment in the bank's mobile application." The PSU authorizes the payment directly in the bank's application (for example, via a push notification).
  • Redirect SCA. The platform returns a redirect URL ($.links.scaRedirect.href). The TPP redirects the PSU to the bank's authentication page to authenticate and confirm the payment. Once the authorization is completed, the bank redirects the PSU back to the TPP using the specified Client-Redirect-URI.

 

1.3. Checking the payment status

The TPP can check the current payment status using the GET /pis/v2/payments/{payment-product}/{payment-id}/status endpoint. The platform returns the current transaction status ($.transactionStatus), for example, ACCC (AcceptedSettlementCompleted).

 

Supported payment product: instant-credit-transfers.

 

2. AIS (Account Information Service) — Account Information Service

The Account Information Service (AIS) enables a Third Party Provider (TPP) to access a Payment Service User's (PSU) account information. Before accessing the information, the TPP must obtain the PSU's authorization (consent confirmation). Based on the confirmed consent, the TPP can access the PSU's account information, including balances, transaction history, and other relevant data.

Main AIS functions:


2.1. Creating an account access consent

The TPP creates a consent by sending a request to POST /ais/v2/consents/account-access. The request includes the account IBAN, access rights (accountDetails, balances, transactions), the consent type, the recurring access indicator (recurringIndicator), the consent validity date (validTo), and the maximum request frequency per day (frequencyPerDay, up to four requests per day). The platform returns a unique consent identifier (consentId).

 

2.2. Consent authorization (SCA)

After creating the consent, the TPP starts the authorization process using POST /ais/v2/consents/account-access/{consent-id}/authorisations. Two SCA approaches are supported (Decoupled and Redirect, as described for PIS). The TPP checks the consent status using GET /ais/v2/consents/account-access/{consent-id}/status until the consent status becomes valid or rejected.

 

2.3. Retrieving the list of accounts

The TPP retrieves the PSU's accounts using GET /ais/v2/accounts?withBalance=true, providing the Consent-ID header containing the identifier of the confirmed consent. The platform returns a list of accounts including the IBAN, currency, resource identifier, account name, and current balances.

 

2.4. Retrieving transaction history

The TPP retrieves an account's transaction history using GET /ais/v2/accounts/{account-id}/transactions. The bank provides transaction history for the previous 31 days, counted from the date of the request. If the bank provides transaction history covering a period of 31 to 90 days, the request may be processed without additional SCA authorization. To access transaction history older than 90 days, a one-time AIS consent (recurringIndicator: false) is required. Pagination is supported using the limit and offset parameters.