API reference

TPP Client Registration — OAuth2 Technical Setup

Dynamic client registration endpoints (RFC 7591/7592) a TPP uses to provision and manage its client_id with the ASPSP.

• post/registerClient Registration request
• delete/register/{clientId}Delete the actual registration for a given client_id
• get/register/{clientId}Retrieve the actual registration for a given client_id
• put/register/{clientId}Update the actual registration for a given client_id

AISP — Account Information Service Provider

Endpoints exposed to AISPs to retrieve PSU account, balance, transaction and identity data, and to manage consent.

• get/accountsRetrieval of the PSU accounts (AISP)
• get/accounts/{accountResourceId}/balancesRetrieval of an account balances report (AISP)
• get/accounts/{accountResourceId}/overdraftsRetrieval of an account overdraft (AISP)
• get/accounts/{accountResourceId}/ownersRetrieval of an account owners (AISP)
• get/accounts/{accountResourceId}/transactionsRetrieval of an account transaction set (AISP)
• get/accounts/{accountResourceId}/transactions/{transactionResourceId}/detailsRetrieval of transaction details (AISP)
• put/consentsForwarding the PSU consent (AISP)
• get/end-user-identityRetrieval of the identity of the end-user (AISP)
• get/trusted-beneficiariesRetrieval of the trusted beneficiaries list (AISP)

PISP — Payment Initiation Service Provider

Endpoints exposed to PISPs to initiate, retrieve, update and confirm payment requests on behalf of the PSU.

• post/payment-requestsPayment request initiation (PISP)
• get/payment-requests/{paymentRequestResourceId}Retrieval of a payment request (PISP)
• put/payment-requests/{paymentRequestResourceId}Cancellation of a Payment/Transfer Request (PISP)
• post/payment-requests/{paymentRequestResourceId}/confirmationConfirmation of a payment request using an OAUTH2 Authorization code grant (PISP)
• get/payment-requests/{paymentRequestResourceId}/transactionsRetrieval of the Credit Transfert Transactions that were processed for a given payment request (PISP)

CBPII — Card-Based Payment Instrument Issuer

Endpoints exposed to CBPIIs to obtain on-demand confirmation that funds are available on a designated payment account.

• post/funds-confirmationsPayment coverage check request (CBPII)

Resources

All 122 structures of the OpenAPI definition, each on its own page: fields, types, enums and the endpoints that use it.