# Yapily API Documentation

## Docs

- [Create application beneficiary](https://docs.yapily.com/api-reference/application-beneficiaries/create-application-beneficiary.md): Creation of beneficiaries for a given application.
- [Delete application beneficiary by id](https://docs.yapily.com/api-reference/application-beneficiaries/delete-application-beneficiary-by-id.md): Delete application beneficiary.
- [Get all application beneficiaries](https://docs.yapily.com/api-reference/application-beneficiaries/get-all-application-beneficiaries.md): Get all application beneficiaries from an application.
- [Get application beneficiary by id](https://docs.yapily.com/api-reference/application-beneficiaries/get-application-beneficiary-by-id.md): Get user beneficiary by id.
- [Create application VRP configuration by Application Id](https://docs.yapily.com/api-reference/application-management/create-application-vrp-configuration-by-application-id.md): Create application vrp configuration
- [Creates a sub-application for the root application id provided in the authentication token](https://docs.yapily.com/api-reference/application-management/creates-a-sub-application-for-the-root-application-id-provided-in-the-authentication-token.md): Creates a sub-application under the given root application id provided in the authentication token. The sub-application can use the root's credentials to call the API
- [Delete an application](https://docs.yapily.com/api-reference/application-management/delete-an-application.md): Deletes the application with the given ID in the path
- [Get application details](https://docs.yapily.com/api-reference/application-management/get-application-details.md): Retrieves an application by the id provided in the path
- [Get application VRP configuration by Application Id](https://docs.yapily.com/api-reference/application-management/get-application-vrp-configuration-by-application-id.md): Get application vrp configuration
- [Retrieve sub-applications for the root application provided in the authentication token.](https://docs.yapily.com/api-reference/application-management/retrieve-sub-applications-for-the-root-application-provided-in-the-authentication-token.md): Retrieves sub-applications for the root application provided in the authentication token. If a sub-application is provided in the authentication token, it will return an empty list.
- [Update an Application](https://docs.yapily.com/api-reference/application-management/update-an-application.md): Updates the application properties for the application with the given ID in the path
- [Update application VRP configuration by Application Id](https://docs.yapily.com/api-reference/application-management/update-application-vrp-configuration-by-application-id.md): Update application vrp configuration
- [Authentication](https://docs.yapily.com/api-reference/authentication.md): Learn how to authenticate with the Yapily API
- [Create Account Authorisation](https://docs.yapily.com/api-reference/authorisations/create-account-authorisation.md): Used to initiate the authorisation process and direct users to the login screen of their financial institution in order to give consent to access account data.
- [Create Bulk Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/create-bulk-payment-authorisation.md): Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a bulk payment.
- [Create Embedded Account Authorisation](https://docs.yapily.com/api-reference/authorisations/create-embedded-account-authorisation.md): Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_ACCOUNT_REQUEST` feature in order to obtain the the user's authorisation to access their account information.
- [Create Embedded Bulk Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/create-embedded-bulk-payment-authorisation.md): Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_BULK_PAYMENT` feature in order to obtain the the user's authorisation for a bulk payment. See [Bulk Payments](/payments/bulk-payments/additional-information) for more information. Feature: `…
- [Create Embedded Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/create-embedded-payment-authorisation.md): Used to initiate the embedded authorisation process for an `Institution` that contains the `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT` feature in order to obtain the the user's authorisation for a payment. Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`
- [Create Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/create-payment-authorisation.md): Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a payment. This endpoint is used to initiate all the different payment listed below. Based on the type of payment you wish to make, you may be required to…
- [Create Payment Pre-authorisation](https://docs.yapily.com/api-reference/authorisations/create-payment-pre-authorisation.md): Used to initiate the pre-authorisation process for payments for CBI Globe institutions that contain the `INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS` feature to authenticate the user.
- [Create Pre-authorisation](https://docs.yapily.com/api-reference/authorisations/create-pre-authorisation.md): Used to initiate the pre-authorisation process for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature to authenticate the user.
- [Re-authorise Account Consent](https://docs.yapily.com/api-reference/authorisations/re-authorise-account-consent.md): Used to prompt the account holder for continued access to their financial data. This endpoint should be used when a `Consent` that was previously `AUTHORIZED` can no longer be used to retrieve data.
- [Update Account Pre-authorisation](https://docs.yapily.com/api-reference/authorisations/update-account-pre-authorisation.md): Used to continue the authorisation process and for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature and direct user to the login screen of their financial institution in order to give consent to access account data.
- [Update Embedded Account Authorisation](https://docs.yapily.com/api-reference/authorisations/update-embedded-account-authorisation.md): Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to access the user's financial data.
- [Update Embedded Bulk Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/update-embedded-bulk-payment-authorisation.md): Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to initiate a bulk payment. See [Bulk Payments](/payments/bulk-payments/additional-informa…
- [Update Embedded Payment Authorisation](https://docs.yapily.com/api-reference/authorisations/update-embedded-payment-authorisation.md): Used to pass the SCA Code received from the `Institution` (and the SCA method selected by the user where multiple SCA methods are supported by the `Institution`) in order to complete the embedded authorisation to initiate a payment. Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`
- [Update Payment Pre-authorisation](https://docs.yapily.com/api-reference/authorisations/update-payment-pre-authorisation.md): Used to continue the authorisation process and for any `Institution` that contains the `INITIATE_PRE_AUTHORISATION` feature and direct user to the login screen of their financial institution in order to give consent to initiate a payment. Feature: `INITIATE_PRE_AUTHORISATION`
- [Delete Consent](https://docs.yapily.com/api-reference/consents/delete-consent.md): Delete a consent using the consent Id
- [Exchange OAuth2 Code](https://docs.yapily.com/api-reference/consents/exchange-oauth2-code.md): Used to obtain a Yapily Consent object containing the `consentToken` once the user has authenticated and you have an OAuth2 authorisation code `auth-code` and state `auth-state`.
- [Exchange One Time Token](https://docs.yapily.com/api-reference/consents/exchange-one-time-token.md): Exchange a One-time-token for the consent token
- [Extend Consent](https://docs.yapily.com/api-reference/consents/extend-consent.md): Used to indicate to Yapily that reconfirmation has occurred for a given Consent, and to update lastUpdatedAt and reconfirmBy for that Consent. Returns the Consent.
- [Get Consent](https://docs.yapily.com/api-reference/consents/get-consent.md): Get consent using the consent Id
- [Get Consents](https://docs.yapily.com/api-reference/consents/get-consents.md): Used to retrieve all the consents created for each user within an application. At least one of the following filters needs to be applied: filter[applicationUserId], filter[userUuid]=, limit=.
- [Get Data Constraints Rules](https://docs.yapily.com/api-reference/constraints/get-data-constraints-rules.md): Get Data Constraints Rules against an Institution for Account Authorisation requests
- [Get Payment Constraints Rules](https://docs.yapily.com/api-reference/constraints/get-payment-constraints-rules.md): Retrieve institution specific constraints for payment authorisation and submission requests
- [Enrichment](https://docs.yapily.com/api-reference/data-plus/enrichment.md): Trigger categorisation for transactions provided in the request.
- [Get Categorised Transactions (Deprecated)](https://docs.yapily.com/api-reference/data-plus/get-categorised-transactions-deprecated.md): __Deprecated__. Retrieve categorised transactions by Categorisation ID.
- [Get Enrichment Labels](https://docs.yapily.com/api-reference/data-plus/get-enrichment-labels.md): Returns the list of categories that can be returned for a specific account type (consumer or business).
- [Get Enrichment Results](https://docs.yapily.com/api-reference/data-plus/get-enrichment-results.md): Retrieve categorised transactions by Categorisation ID.
- [Transactions and Enrichment](https://docs.yapily.com/api-reference/data-plus/transactions-and-enrichment.md): Trigger categorisation for transactions from [AIS (see Get Transactions endpoint)](/api-reference/getTransactions) in the specified time range.
- [Get Account](https://docs.yapily.com/api-reference/financial-data/get-account.md): Returns the account and balance information for a user's specified account.
- [Get Account Balances](https://docs.yapily.com/api-reference/financial-data/get-account-balances.md): Returns the balance for the end user associated with the presented consent token.
- [Get Account Beneficiaries](https://docs.yapily.com/api-reference/financial-data/get-account-beneficiaries.md): Returns all the beneficiaries of a user's account.
- [Get Account Direct Debits](https://docs.yapily.com/api-reference/financial-data/get-account-direct-debits.md): Returns the list of direct debits for an account.
- [Get Account Periodic Payments](https://docs.yapily.com/api-reference/financial-data/get-account-periodic-payments.md): Returns the list of periodic payments (standing orders in the UK) for an account.
- [Get Account Scheduled Payments](https://docs.yapily.com/api-reference/financial-data/get-account-scheduled-payments.md): Returns the list of scheduled payments for an account.
- [Get Account Statement](https://docs.yapily.com/api-reference/financial-data/get-account-statement.md): Returns a statement for an account.
- [Get Account Statement File](https://docs.yapily.com/api-reference/financial-data/get-account-statement-file.md): Returns a PDF file of a statement for an account.
- [Get Account Statements](https://docs.yapily.com/api-reference/financial-data/get-account-statements.md): Returns the list of statements for an account.
- [Get Account Transactions](https://docs.yapily.com/api-reference/financial-data/get-account-transactions.md): Returns the account transactions for an account.
- [Get Accounts](https://docs.yapily.com/api-reference/financial-data/get-accounts.md): Returns all accounts and balances for the end user associated with the presented consent token.
- [Get Identity](https://docs.yapily.com/api-reference/financial-data/get-identity.md): Returns the identity information for an account.
- [Get Real Time Account Transactions](https://docs.yapily.com/api-reference/financial-data/get-real-time-account-transactions.md): Used to get the account transactions for an account in real time with cursor pagination
- [Create Hosted Consent Request](https://docs.yapily.com/api-reference/hosted-consent-pages/create-hosted-consent-request.md): Used to initiate a consent request using Yapily Hosted Pages.
- [Get Hosted Consent Request](https://docs.yapily.com/api-reference/hosted-consent-pages/get-hosted-consent-request.md): Used to get details of a hosted consent request
- [Check Funds Availability](https://docs.yapily.com/api-reference/hosted-payment-pages/check-funds-availability.md): Confirms whether there are available funds on the Payer account to execute a Variable Recurring Payment after obtaining the user's authorisation.
- [Create Hosted payment request](https://docs.yapily.com/api-reference/hosted-payment-pages/create-hosted-payment-request.md): Used to initiate a payment request using Yapily Hosted Pages.
- [Create Pay By Link](https://docs.yapily.com/api-reference/hosted-payment-pages/create-pay-by-link.md): Used to created a long lived payment request for Pay By Link
- [Create VRP Consent](https://docs.yapily.com/api-reference/hosted-payment-pages/create-vrp-consent.md): Used to initiate a VRP consent / mandate request through Yapily Hosted Pages
- [Create VRP Payment](https://docs.yapily.com/api-reference/hosted-payment-pages/create-vrp-payment.md): Creates a Variable Recurring Payment
- [Get Hosted payment request](https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-payment-request.md): Used to get details of a payment request
- [Get Hosted VRP Consent Request](https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-request.md): Used to get details of a VRP Consent Request
- [Get Hosted VRP Consent Requests](https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-requests.md): Used to get all VRP consent requests initiated through Yapily Hosted Pages
- [Get VRP payment](https://docs.yapily.com/api-reference/hosted-payment-pages/get-vrp-payment.md): Used to get details of a VRP Payment
- [Revoke Hosted VRP Consent Request](https://docs.yapily.com/api-reference/hosted-payment-pages/revoke-hosted-vrp-consent-request.md): Revoke Hosted VRP Consent Request
- [Get Institution](https://docs.yapily.com/api-reference/institutions/get-institution.md): Used to retrieves details of a specific `Institution` within an application
- [Get Institutions](https://docs.yapily.com/api-reference/institutions/get-institutions.md): Used to retrieve all `Institutions` within an application
- [API Reference](https://docs.yapily.com/api-reference/introduction.md): Complete reference for the Yapily API
- [Create Event Subscription](https://docs.yapily.com/api-reference/notifications/create-event-subscription.md): Used to subscribe to notifications relating to a specified event type.
- [Delete Event Subscription](https://docs.yapily.com/api-reference/notifications/delete-event-subscription.md): Used to unsubscribe to notifications relating to a specified event type.
- [Get Event Subscription](https://docs.yapily.com/api-reference/notifications/get-event-subscription.md): Used to get details of your subscription to a specified event type.
- [Get Event Subscriptions](https://docs.yapily.com/api-reference/notifications/get-event-subscriptions.md): Get all event subscriptions that your application is subscribed to
- [Create Bulk Payment](https://docs.yapily.com/api-reference/payments/create-bulk-payment.md): Creates a bulk payment after obtaining the user's authorisation.
- [Create Payment](https://docs.yapily.com/api-reference/payments/create-payment.md): Creates a payment after obtaining the user's authorisation.
- [Get Bulk Payment File Status](https://docs.yapily.com/api-reference/payments/get-bulk-payment-file-status.md): Returns the bulk file status of the bulk payment for given bulkPaymentId
- [Get Payment Details](https://docs.yapily.com/api-reference/payments/get-payment-details.md): Returns the details of a payment.
- [Approve Beneficiary](https://docs.yapily.com/api-reference/user-beneficiaries/approve-beneficiary.md): End-user has approved the beneficiary details
- [Create Beneficiary](https://docs.yapily.com/api-reference/user-beneficiaries/create-beneficiary.md): Creation of beneficiaries for a given application User.
- [Delete user beneficiary by id.](https://docs.yapily.com/api-reference/user-beneficiaries/delete-user-beneficiary-by-id.md): Delete user beneficiary by id.
- [Get all users beneficiaries](https://docs.yapily.com/api-reference/user-beneficiaries/get-all-users-beneficiaries.md): Get all users beneficiaries from an userId.
- [Get beneficiary by id](https://docs.yapily.com/api-reference/user-beneficiaries/get-beneficiary-by-id.md): Get user beneficiary by id.
- [Patch User Beneficiary](https://docs.yapily.com/api-reference/user-beneficiaries/patch-user-beneficiary.md): Patch the beneficiary details for a given application user and beneficiary
- [Reject Beneficiary](https://docs.yapily.com/api-reference/user-beneficiaries/reject-beneficiary.md): End-user has rejected the beneficiary details
- [Create User](https://docs.yapily.com/api-reference/users/create-user.md): Create a new user in your application
- [Delete User](https://docs.yapily.com/api-reference/users/delete-user.md): Delete a user from your application along with any sub-resources (including consent resources on institution APIs if they exist)
- [Get User](https://docs.yapily.com/api-reference/users/get-user.md): Get a specific user using the user UUID
- [Get Users](https://docs.yapily.com/api-reference/users/get-users.md): Retrieves all users created in your application for a specified applicationUserId using the filter[applicationUserId] query parameter. If filter[applicationUserId] is not provided, the response will include up to 50,000 users.
- [Update User](https://docs.yapily.com/api-reference/users/update-user.md): Update the users information
- [Confirm Funds for Variable Recurring Payment](https://docs.yapily.com/api-reference/variable-recurring-payments/confirm-funds-for-variable-recurring-payment.md): Confirms whether there are available funds on the Payer account to execute a Variable Recurring Payment after obtaining the user's authorisation.
- [Create Sweeping Variable Recurring Payment Authorisation](https://docs.yapily.com/api-reference/variable-recurring-payments/create-sweeping-variable-recurring-payment-authorisation.md): Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for Sweeping Variable Recurring Payments. The request would return an Authorization URL and an Identifier for the consent created at the Institution. First ma…
- [Create Variable Recurring Payment](https://docs.yapily.com/api-reference/variable-recurring-payments/create-variable-recurring-payment.md): Creates a Variable Recurring Payment transaction after obtaining the user's authorisation.
- [Get Sweeping Variable Recurring Payment Consent Details](https://docs.yapily.com/api-reference/variable-recurring-payments/get-sweeping-variable-recurring-payment-consent-details.md): Get Sweeping Variable Recurring Payments consent details using the consent Id
- [Get Variable Recurring Payment Details](https://docs.yapily.com/api-reference/variable-recurring-payments/get-variable-recurring-payment-details.md): Get Variable Recurring Payment details using the Payment Id
- [Delete Webhook Event](https://docs.yapily.com/api-reference/webhooks/delete-webhook-event.md): Delete a webhook event for a specified webhook ID, unregistering it from receiving any further notifications for the subscribed event categories in your application.
- [Get Webhook Categories](https://docs.yapily.com/api-reference/webhooks/get-webhook-categories.md): Retrieve a comprehensive list of event categories that can be registered for webhook notifications in your application. These event categories can be used to subscribe a webhook to specific events, enabling your application to receive real-time notifications when these events occur.
- [Register Webhook Event](https://docs.yapily.com/api-reference/webhooks/register-webhook-event.md): Register a webhook to one or multiple event categories to receive real-time notifications when specific events occur in your application.
- [Reset Webhook Secret](https://docs.yapily.com/api-reference/webhooks/reset-webhook-secret.md): Reset webhook secret for a webhook that is already registered to your application
- [Retrieve All Webhook Events](https://docs.yapily.com/api-reference/webhooks/retrieve-all-webhook-events.md): Retrieve the list of registered webhooks for your application
- [Understanding Consents](https://docs.yapily.com/concepts/consent-lifecycle.md): How consents work in open banking, their lifecycle, status transitions, and management for data access and payments.
- [Hosted Pages vs Direct API](https://docs.yapily.com/concepts/hosted-vs-api.md): Compare Hosted Pages and the Direct API to find the right integration approach for your use case.
- [Licensing & Registration](https://docs.yapily.com/concepts/licensing-and-registration.md): TPP licensing options, how bank registration works, and what you need in place before integrating.
- [Open Banking 101](https://docs.yapily.com/concepts/open-banking-101.md): The fundamentals of open banking, how it works, and what it means for your integration.
- [Building a Payment Request](https://docs.yapily.com/concepts/payment-request-anatomy.md): How to construct payment requests across countries, payment types, and bank requirements.
- [Categorisation](https://docs.yapily.com/data/data-plus/categorisation.md): Automatically categorise transactions using Yapily's Categorisation Engine. Assign spending categories for budgeting apps, personal finance management, and financial analysis.
- [Definition of Categories](https://docs.yapily.com/data/data-plus/categorisation-list.md): List of all categorisation categories for consumer and business accounts
- [Introduction](https://docs.yapily.com/data/data-plus/overview.md): Enhance raw financial data with Yapily's Data Plus enrichment features. Get categorised transactions, income insights, balance prediction, and AI-powered financial analysis.
- [Tutorial: Get Transactions and Enrichment](https://docs.yapily.com/data/data-plus/tutorial-categorisation.md): This tutorial walks you through each of the steps required to obtain Categorisation.
- [Tutorial: Get Enrichment Only](https://docs.yapily.com/data/data-plus/tutorial-enrichment.md): Step-by-step tutorial for using enrichment with your own transaction data
- [Accounts and Balances](https://docs.yapily.com/data/financial-data-resources/accounts-and-balances.md): Reference guide for account and balance data returned by Yapily's API. Understand account types, balance fields, currency handling, and institution-specific data variations.
- [Data Restrictions](https://docs.yapily.com/data/financial-data-resources/data-restrictions.md): Known AIS data restrictions imposed by institutions using Yapily's API. Covers limitations on account types, transaction history depth, and data field availability.
- [Financial Data Consents](https://docs.yapily.com/data/financial-data-resources/financial-data-consents.md): Manage AIS consents in Yapily. Learn how to create, renew, and revoke data access consents and understand the consent token lifecycle for financial data retrieval.
- [Financial Data Features](https://docs.yapily.com/data/financial-data-resources/financial-data-features.md): Explore the financial data features supported by each institution in Yapily's network. Compare account, transaction, identity, and balance data availability across banks.
- [Pagination](https://docs.yapily.com/data/financial-data-resources/pagination.md): Implement pagination for large transaction sets from Yapily's API. Covers cursor-based pagination, configuring page sizes, and handling multi-page transaction retrieval.
- [Transaction Hash](https://docs.yapily.com/data/financial-data-resources/transaction-hash.md): Learn to use Yapily Transaction Hash
- [90 Day AIS Consent Changes](https://docs.yapily.com/data/financial-data-resources/uk-data-consent-changes.md): Understand the 90-day re-authentication requirement for UK AIS consents. Learn how Yapily handles the re-consent flow and what this means for your data integration.
- [Yapily Data](https://docs.yapily.com/data/overview.md): Access real-time financial data from banks using Yapily's Open Banking data API. Retrieve accounts, balances, transactions, and identity information with user consent.
- [Tutorial: Get account and transaction data](https://docs.yapily.com/data/tutorial-account-and-trans-data.md): Step-by-step tutorial for retrieving a user's account and transaction data using the Yapily API. Covers consent, account selection, and pagination of transaction history.
- [Validate Overview](https://docs.yapily.com/data/validate/overview.md): Verify financial account ownership with Yapily's account validation service. Confirm customer identity and reduce fraud by checking bank account details in real time.
- [Tutorial: Validate a user](https://docs.yapily.com/data/validate/tutorial-validate-user.md): Step-by-step tutorial for validating a user's bank account with Yapily. Initiate validation, handle user consent, and retrieve account ownership verification results.
- [Application Management](https://docs.yapily.com/getting-started/application-management.md): Manage Yapily sub-applications for reseller and merchant use cases. Learn how to create, configure, and manage applications in the Yapily dashboard.
- [Set Up Your Environment](https://docs.yapily.com/getting-started/get-started.md): Getting started with Yapily typically takes just a few minutes. After following these steps, you'll be ready to start your integration.
- [Glossary](https://docs.yapily.com/getting-started/glossary.md): Comprehensive glossary of Open Banking terms, regulatory concepts, and Yapily-specific terminology to help developers understand the open banking ecosystem.
- [API Authentication](https://docs.yapily.com/getting-started/integration-setup/api-authentication.md): Learn how to authenticate requests to the Yapily API using Basic Auth. Understand how to manage application credentials and secure your open banking integration.
- [European Prerequisites](https://docs.yapily.com/getting-started/integration-setup/prerequisites/european-prereqs.md): European PSD2 prerequisites for regulated AISPs and PISPs using Yapily. Covers eIDAS certificate setup, national competent authority registration, and QWAC configuration.
- [UK Prerequisites](https://docs.yapily.com/getting-started/integration-setup/prerequisites/uk-prereqs.md): UK Open Banking Directory setup guide for regulated AISPs and PISPs. Covers OBIE registration, software statement creation, and transport certificate configuration.
- [Introduction](https://docs.yapily.com/getting-started/integration-setup/registration.md): Registration is required to access the Open Banking network. Learn about Yapily's two registration options: using Yapily's existing licence or your own permissions.
- [Registration Maintenance](https://docs.yapily.com/getting-started/integration-setup/registration-update.md): Guide for updating and renewing certificates for bank registrations
- [Start Here](https://docs.yapily.com/getting-started/overview.md): Discover Yapily's Open Banking products, compare integration approaches, check institution coverage by country, and find tutorials to start building.
- [3 Banken Gruppe](https://docs.yapily.com/institution-configurations/austria/3-Banken-Gruppe.md)
- [BAWAG PSK / Easybank](https://docs.yapily.com/institution-configurations/austria/Easybank.md)
- [Erste & Sparkassen](https://docs.yapily.com/institution-configurations/austria/Erste-Sparkassen.md)
- [Raiffeisen Bank](https://docs.yapily.com/institution-configurations/austria/Raiffeisen-Bank.md)
- [Volksbank Banks](https://docs.yapily.com/institution-configurations/austria/Volksbank.md)
- [SEB Baltics (Estonia, Latvia, Lithuania)](https://docs.yapily.com/institution-configurations/baltics/SEB-Baltics.md)
- [BNP Paribas](https://docs.yapily.com/institution-configurations/belgium/BNP-Paribas.md)
- [Belfius](https://docs.yapily.com/institution-configurations/belgium/Belfius.md)
- [KBC Belgium](https://docs.yapily.com/institution-configurations/belgium/KBC-Belgium.md)
- [SMBC](https://docs.yapily.com/institution-configurations/belgium/SMBC.md)
- [DSK Bank](https://docs.yapily.com/institution-configurations/bulgaria/DSK-Bank.md)
- [Unicredit Bulgaria](https://docs.yapily.com/institution-configurations/bulgaria/Unicredit-Bulgaria.md)
- [Raiffeisen](https://docs.yapily.com/institution-configurations/croatia/Raiffeisen.md)
- [Bank of Cyprus](https://docs.yapily.com/institution-configurations/cyprus/Bank-of-Cyprus.md)
- [Hellenic Bank](https://docs.yapily.com/institution-configurations/cyprus/Hellenic.md)
- [Danske Bank Finland](https://docs.yapily.com/institution-configurations/finland/Danske-Bank-Finland.md)
- [Handelsbanken Finland](https://docs.yapily.com/institution-configurations/finland/Handelsbanken-Finland.md)
- [Chase UK](https://docs.yapily.com/institution-configurations/finland/OPBank-Finland.md)
- [Arkea Group](https://docs.yapily.com/institution-configurations/france/Arkea-Group.md)
- [BNP](https://docs.yapily.com/institution-configurations/france/BNP.md)
- [BPCE](https://docs.yapily.com/institution-configurations/france/BPCE.md)
- [Boursorama](https://docs.yapily.com/institution-configurations/france/Boursorama.md)
- [CIC](https://docs.yapily.com/institution-configurations/france/CIC.md)
- [Credit Du Nord](https://docs.yapily.com/institution-configurations/france/Credit-Du-Nord.md)
- [Credit Lyonnais](https://docs.yapily.com/institution-configurations/france/Credit-Lyonnais.md)
- [Credit Lyonnais Business](https://docs.yapily.com/institution-configurations/france/Credit-Lyonnais-Business.md)
- [Credit Agricole](https://docs.yapily.com/institution-configurations/france/CreditAgricole.md)
- [CreditMutuel](https://docs.yapily.com/institution-configurations/france/CreditMutuel.md)
- [LabanquePostale](https://docs.yapily.com/institution-configurations/france/LabanquePostale.md)
- [Qonto](https://docs.yapily.com/institution-configurations/france/Qonto.md)
- [SocieteGenerale](https://docs.yapily.com/institution-configurations/france/SocieteGenerale.md)
- [Bank fur Sozialwirtschaft](https://docs.yapily.com/institution-configurations/germany/Bank-fur-Sozialwirtschaft.md)
- [C24](https://docs.yapily.com/institution-configurations/germany/C24.md)
- [Commerzbank AG](https://docs.yapily.com/institution-configurations/germany/Commerzbank-AG.md)
- [Consors Bank](https://docs.yapily.com/institution-configurations/germany/Consors-Bank.md)
- [DKB](https://docs.yapily.com/institution-configurations/germany/DKB.md)
- [Deutsche Bank](https://docs.yapily.com/institution-configurations/germany/Deutsche-Bank.md)
- [Deutsche Handelsbank](https://docs.yapily.com/institution-configurations/germany/Deutsche-Handelsbank.md)
- [Fiducia and Gad IT](https://docs.yapily.com/institution-configurations/germany/Fiducia-and-Gad-IT.md)
- [N26](https://docs.yapily.com/institution-configurations/germany/N26.md)
- [N26 Token IO](https://docs.yapily.com/institution-configurations/germany/N26-Token-IO.md)
- [Postbank](https://docs.yapily.com/institution-configurations/germany/Postbank.md)
- [Solaris](https://docs.yapily.com/institution-configurations/germany/Solaris.md)
- [Sparda Banks](https://docs.yapily.com/institution-configurations/germany/Sparda-Banks.md)
- [Sparkassen](https://docs.yapily.com/institution-configurations/germany/Sparkassen.md)
- [Institution configurations](https://docs.yapily.com/institution-configurations/index.md): How to register each institution or institution group in each country
- [Allied Irish Bank](https://docs.yapily.com/institution-configurations/ireland/Allied-Irish-Bank.md)
- [Danske Bank Ireland Business](https://docs.yapily.com/institution-configurations/ireland/Danske-Bank-Ireland-Business.md)
- [Permanent TSB](https://docs.yapily.com/institution-configurations/ireland/Permanent-TSB.md)
- [Banca BNL](https://docs.yapily.com/institution-configurations/italy/Banca-BNL.md)
- [Banca Monte dei Paschi Di SIENA](https://docs.yapily.com/institution-configurations/italy/Banca-Monte-dei-Paschi-Di-SIENA.md)
- [Banca Popolare - Volksbank](https://docs.yapily.com/institution-configurations/italy/Banca-Popolare-Volksbank.md)
- [Banco BPM](https://docs.yapily.com/institution-configurations/italy/Banco-BPM.md)
- [CBI Globe Allitude](https://docs.yapily.com/institution-configurations/italy/CBI-Globe-Allitude.md)
- [CBI Globe BCC](https://docs.yapily.com/institution-configurations/italy/CBI-Globe-BCC.md)
- [CBI Globe BPER](https://docs.yapily.com/institution-configurations/italy/CBI-Globe-BPER.md)
- [CBI Globe Credit Agricole](https://docs.yapily.com/institution-configurations/italy/CBI-Globe-Credit-Agricole.md)
- [CEDACRI and Banca Mediolanum](https://docs.yapily.com/institution-configurations/italy/CEDACRI-and-Banca-Mediolanum.md)
- [Credito Emiliano](https://docs.yapily.com/institution-configurations/italy/Credito-Emiliano.md)
- [Fineco](https://docs.yapily.com/institution-configurations/italy/Fineco.md)
- [Intesa Sanpaolo](https://docs.yapily.com/institution-configurations/italy/Intesa-Sanpaolo.md)
- [Poste Italiane](https://docs.yapily.com/institution-configurations/italy/Poste-Italiane.md)
- [Raiffeisen Italy - Casa Centrale](https://docs.yapily.com/institution-configurations/italy/Raiffeisen-Italy-Casa-Centrale.md)
- [Soldo](https://docs.yapily.com/institution-configurations/italy/Soldo.md)
- [Unicredit](https://docs.yapily.com/institution-configurations/italy/Unicredit.md)
- [Danske bank Luxembourg](https://docs.yapily.com/institution-configurations/luxembourg/Danske-bank-Luxembourg.md)
- [Handelsbanken Luxembourg](https://docs.yapily.com/institution-configurations/luxembourg/Handelsbanken-Luxembourg.md)
- [ABN AMRO](https://docs.yapily.com/institution-configurations/netherlands/ABN-AMRO.md)
- [Devolksbank Group](https://docs.yapily.com/institution-configurations/netherlands/Devolksbank-Group.md)
- [Handelsbanken Netherlands](https://docs.yapily.com/institution-configurations/netherlands/Handelsbanken-Netherlands.md)
- [Knab](https://docs.yapily.com/institution-configurations/netherlands/Knab.md)
- [Rabobank](https://docs.yapily.com/institution-configurations/netherlands/Rabobank.md)
- [BEC](https://docs.yapily.com/institution-configurations/nordics/BEC.md)
- [BankData](https://docs.yapily.com/institution-configurations/nordics/BankData.md)
- [DNB](https://docs.yapily.com/institution-configurations/nordics/DNB.md)
- [Danske Bank Denmark](https://docs.yapily.com/institution-configurations/nordics/Danske-Bank-Denmark.md)
- [Danske Bank Norway](https://docs.yapily.com/institution-configurations/nordics/Danske-Bank-Norway.md)
- [Danske Bank Sweden](https://docs.yapily.com/institution-configurations/nordics/Danske-Bank-Sweden.md)
- [Handelsbanken Finland](https://docs.yapily.com/institution-configurations/nordics/Handelsbanken-Finland.md)
- [Handelsbanken Sweden](https://docs.yapily.com/institution-configurations/nordics/Handelsbanken-Sweden.md)
- [Luminor](https://docs.yapily.com/institution-configurations/nordics/Luminor.md)
- [Nordea](https://docs.yapily.com/institution-configurations/nordics/Nordea.md)
- [SEB Sweden](https://docs.yapily.com/institution-configurations/nordics/SEB-Sweden.md)
- [Swedbank (Lithuania, Sweden, Latvia and Estonia)](https://docs.yapily.com/institution-configurations/nordics/Swedbank.md)
- [BNP Poland](https://docs.yapily.com/institution-configurations/poland/BNP-Poland.md)
- [Bank Millennium](https://docs.yapily.com/institution-configurations/poland/Bank-Millennium.md)
- [Danske Bank Poland Business](https://docs.yapily.com/institution-configurations/poland/Danske-Bank-Poland-Business.md)
- [MBank](https://docs.yapily.com/institution-configurations/poland/MBank.md)
- [PKO Bank Polski](https://docs.yapily.com/institution-configurations/poland/PKO-Bank-Polski.md)
- [Pekao](https://docs.yapily.com/institution-configurations/poland/Pekao.md)
- [SIBS](https://docs.yapily.com/institution-configurations/portugal/SIBS.md)
- [Mbank SK](https://docs.yapily.com/institution-configurations/slovakia/Mbank-SK.md)
- [Slovenska Sporitelna](https://docs.yapily.com/institution-configurations/slovakia/Slovenska-Sporitelna.md)
- [Tatra Banka (Raffeisen)](https://docs.yapily.com/institution-configurations/slovakia/Tatra-Banka.md)
- [Unicredit SK](https://docs.yapily.com/institution-configurations/slovakia/Unicredit-SK.md)
- [VUB BANKA](https://docs.yapily.com/institution-configurations/slovakia/VUB-BANKA.md)
- [NOVA KREDITNA BANKA MARIBOR](https://docs.yapily.com/institution-configurations/slovenia/Nkbm.md)
- [Unicredit SI](https://docs.yapily.com/institution-configurations/slovenia/Unicredit-SI.md)
- [Redsys](https://docs.yapily.com/institution-configurations/spain/Redsys.md)
- [Skandia](https://docs.yapily.com/institution-configurations/sweden/Skandia.md)
- [AMEX](https://docs.yapily.com/institution-configurations/uk/AMEX.md)
- [Airwallex](https://docs.yapily.com/institution-configurations/uk/Airwallex.md)
- [Allica Bank](https://docs.yapily.com/institution-configurations/uk/Allica-Bank.md)
- [Allied Irish Bank](https://docs.yapily.com/institution-configurations/uk/Allied-Irish-Bank.md)
- [Bank of Ireland](https://docs.yapily.com/institution-configurations/uk/Bank-of-Ireland.md)
- [Bank of Scotland](https://docs.yapily.com/institution-configurations/uk/Bank-of-Scotland.md)
- [Barclays](https://docs.yapily.com/institution-configurations/uk/Barclays.md)
- [Capital On Tap](https://docs.yapily.com/institution-configurations/uk/Capital-On-Tap.md)
- [Capital One](https://docs.yapily.com/institution-configurations/uk/Capital-One.md)
- [Cash Plus](https://docs.yapily.com/institution-configurations/uk/Cash-Plus.md)
- [Cater Allen](https://docs.yapily.com/institution-configurations/uk/Cater-Allen.md)
- [Chase UK](https://docs.yapily.com/institution-configurations/uk/Chase-UK.md)
- [Chelsea Building Society](https://docs.yapily.com/institution-configurations/uk/Chelsea-Building-Society.md)
- [Clydesdale Bank](https://docs.yapily.com/institution-configurations/uk/Clydesdale-Bank.md)
- [Cumberland Building Society](https://docs.yapily.com/institution-configurations/uk/Cumberland-Building-Society.md)
- [Danske Bank UK](https://docs.yapily.com/institution-configurations/uk/Danske-Bank-UK.md)
- [Engage Bank](https://docs.yapily.com/institution-configurations/uk/Engage-Bank.md)
- [First Direct](https://docs.yapily.com/institution-configurations/uk/First-Direct.md)
- [First Trust Bank](https://docs.yapily.com/institution-configurations/uk/First-Trust-Bank.md)
- [Forgerock Open Banking Sandbox](https://docs.yapily.com/institution-configurations/uk/Forgerock-Open-Banking-Sandbox.md)
- [HSBC Corporate](https://docs.yapily.com/institution-configurations/uk/HSBC-Corporate.md)
- [HSBC Kinetic](https://docs.yapily.com/institution-configurations/uk/HSBC-Kinetic.md)
- [HSBC UK](https://docs.yapily.com/institution-configurations/uk/HSBC-UK.md)
- [Halifax](https://docs.yapily.com/institution-configurations/uk/Halifax.md)
- [Handelsbanken UK](https://docs.yapily.com/institution-configurations/uk/Handelsbanken-UK.md)
- [Hellenic Bank](https://docs.yapily.com/institution-configurations/uk/Hellenic-Bank.md)
- [Hoares Bank](https://docs.yapily.com/institution-configurations/uk/Hoares-Bank.md)
- [IBM Open Banking Sandbox](https://docs.yapily.com/institution-configurations/uk/IBM-Open-Banking-Sandbox.md)
- [ING Bank](https://docs.yapily.com/institution-configurations/uk/ING-Bank.md)
- [Lloyds](https://docs.yapily.com/institution-configurations/uk/Lloyds.md)
- [MBNA](https://docs.yapily.com/institution-configurations/uk/MBNA.md)
- [M&S Bank](https://docs.yapily.com/institution-configurations/uk/M_S-Bank.md)
- [Metro](https://docs.yapily.com/institution-configurations/uk/Metro.md)
- [METTLE](https://docs.yapily.com/institution-configurations/uk/Mettle.md)
- [Modelo Sandbox](https://docs.yapily.com/institution-configurations/uk/Modelo-Sandbox.md)
- [Monzo Bank](https://docs.yapily.com/institution-configurations/uk/Monzo-Bank.md)
- [Nationwide](https://docs.yapily.com/institution-configurations/uk/Nationwide.md)
- [Natwest](https://docs.yapily.com/institution-configurations/uk/Natwest.md)
- [PayPal](https://docs.yapily.com/institution-configurations/uk/PayPal.md)
- [Payoneer](https://docs.yapily.com/institution-configurations/uk/Payoneer.md)
- [Revolut](https://docs.yapily.com/institution-configurations/uk/Revolut.md)
- [Royal Bank of Scotland](https://docs.yapily.com/institution-configurations/uk/Royal-Bank-of-Scotland.md)
- [Sainsburys Bank](https://docs.yapily.com/institution-configurations/uk/Sainsburys-Bank.md)
- [Santander Bank](https://docs.yapily.com/institution-configurations/uk/Santander-Bank.md)
- [Silicon Valley Bank](https://docs.yapily.com/institution-configurations/uk/Silicon-Valley-Bank.md)
- [Soldo Bank](https://docs.yapily.com/institution-configurations/uk/Soldo-Bank.md)
- [Starling Bank](https://docs.yapily.com/institution-configurations/uk/Starling-Bank.md)
- [TSB Bank](https://docs.yapily.com/institution-configurations/uk/TSB-Bank.md)
- [Tesco Bank](https://docs.yapily.com/institution-configurations/uk/Tesco-Bank.md)
- [The Cooperative Bank](https://docs.yapily.com/institution-configurations/uk/The-Cooperative-Bank.md)
- [ThinkMoney](https://docs.yapily.com/institution-configurations/uk/ThinkMoney.md)
- [Tide](https://docs.yapily.com/institution-configurations/uk/Tide.md)
- [Ulster Bank](https://docs.yapily.com/institution-configurations/uk/Ulster-Bank.md)
- [Unity Trust Bank](https://docs.yapily.com/institution-configurations/uk/Unity-Trust-Bank.md)
- [Vanquis Bank](https://docs.yapily.com/institution-configurations/uk/Vanquis-Bank.md)
- [Wise](https://docs.yapily.com/institution-configurations/uk/Wise.md)
- [Yorkshire Bank](https://docs.yapily.com/institution-configurations/uk/Yorkshire-Bank.md)
- [Yorkshire Building Society](https://docs.yapily.com/institution-configurations/uk/Yorkshire-Building-Society.md)
- [Coutts and Company](https://docs.yapily.com/institution-configurations/uk/coutts-and-company.md)
- [Welcome to Yapily Docs](https://docs.yapily.com/introduction.md): Complete developer documentation for Yapily's Open Banking API. Build payment and data integrations with step-by-step guides, tutorials, and API references.
- [Callback URL](https://docs.yapily.com/open-banking-flow/handling-redirects/callback-url.md): Set up and handle callback URLs in Yapily integrations. Process the authorisation code returned after user consent and exchange it for a consent token.
- [QR code URL](https://docs.yapily.com/open-banking-flow/handling-redirects/qr-code.md): Use Yapily's QR code URL to handle open banking redirects from desktop to mobile. Ideal for improving the authorisation experience on non-mobile devices.
- [Redirect URL](https://docs.yapily.com/open-banking-flow/handling-redirects/redirect-url.md): Configure redirect URLs for Yapily open banking flows. Understand how users are returned to your application after authorising access at their bank's interface.
- [Embedded](https://docs.yapily.com/open-banking-flow/user-authorisation/embedded.md): Guide to Yapily's embedded authorisation flow. Allow users to authorise payments or data access directly within your application without external bank redirects.
- [Multiple Consents](https://docs.yapily.com/open-banking-flow/user-authorisation/multiple-consents.md): Manage multiple open banking consents with Yapily. Handle consent tokens, refresh expired consents, and support multi-bank authorisation in a single integration.
- [User authorisation flows](https://docs.yapily.com/open-banking-flow/user-authorisation/overview.md): Understand the user authorisation flows supported by Yapily: single redirect, embedded, pre-authorisation, and QR code — for obtaining open banking consent.
- [Pre-authorisation](https://docs.yapily.com/open-banking-flow/user-authorisation/pre-authorisation.md): Guide to Yapily's pre-authorisation flow for obtaining consent before initiating payments or data requests. Ideal for scheduled and future-dated payment scenarios.
- [PSU Identifiers](https://docs.yapily.com/open-banking-flow/user-authorisation/psu-identifiers.md): Learn how to use PSU identifiers with the Yapily API to improve user experience and institution compatibility during open banking authorisation consent flows.
- [Single redirect](https://docs.yapily.com/open-banking-flow/user-authorisation/single-redirect.md): Complete guide to Yapily's single redirect authorisation flow. Initiate consent requests, redirect users to their bank, and handle the authorisation callback.
- [Additional Information](https://docs.yapily.com/payments/bulk-payments/additional-information.md): Additional reference for bulk payment creation with Yapily, including payment file formats, amount limits, status tracking, and error handling for batch payments.
- [Bulk Payments Overview](https://docs.yapily.com/payments/bulk-payments/overview.md): Initiate multiple simultaneous bank payments in a single API request with Yapily's Bulk Payments. Reduce overhead and streamline batch payment processing workflows.
- [Tutorial: Make a bulk payment](https://docs.yapily.com/payments/bulk-payments/tutorial-bulk-payment.md): Step-by-step tutorial for completing a UK domestic bulk payment with Yapily's Open Banking API. Covers payment file structure, user consent, and status tracking.
- [Payments Overview](https://docs.yapily.com/payments/overview.md): Enable direct, account-to-account payments with no intermediaries using Yapily's Open Banking API. Supports single, scheduled, periodic, bulk, and VRP payment types.
- [European Payments](https://docs.yapily.com/payments/payment-resources/european-payments.md): Guide to European payment schemes supported by Yapily. Covers SEPA Credit Transfer, SEPA Instant, cross-border requirements, and EU-specific payment parameters.
- [Introduction to Payment Execution](https://docs.yapily.com/payments/payment-resources/intro-to-payment-execution.md): Learn how to construct and send payment requests with the Yapily API. Covers required fields, authentication, idempotency keys, and payment execution best practices.
- [Payment Consents](https://docs.yapily.com/payments/payment-resources/payment-consents.md): Manage payment consents in Yapily. Create, use, and revoke consent tokens for single-use and recurring payment authorisations across supported institutions.
- [Payment Constraints](https://docs.yapily.com/payments/payment-resources/payment-constraints.md): Understand payment constraints applied by institutions in Yapily's network. Covers amount limits, currency restrictions, and institution-specific payment rules.
- [Payment Features](https://docs.yapily.com/payments/payment-resources/payment-features.md): Discover which payment features are supported by each institution in Yapily's network. Compare domestic, international, scheduled, and periodic payment capabilities.
- [Payment Limits](https://docs.yapily.com/payments/payment-resources/payment-limits.md): Reference guide to payment scheme limits in Yapily. Covers maximum transaction amounts, daily limits, and scheme-specific constraints for UK and European payments.
- [Payment Notifications](https://docs.yapily.com/payments/payment-resources/payment-notifications.md): Receive real-time payment status notifications with Yapily webhooks. Configure event subscriptions and handle payment lifecycle events in your backend application.
- [Payment Status](https://docs.yapily.com/payments/payment-resources/payment-status.md): Track payment status updates from institutions using Yapily. Understand each stage of the payment lifecycle and how to handle status transitions in your integration.
- [Reverse Payments](https://docs.yapily.com/payments/payment-resources/reverse-payments.md): Initiate reverse payments (refunds) using the Yapily API. Understand eligibility criteria, required parameters, and institution support for payment reversal operations.
- [Verification of Payee (VoP)](https://docs.yapily.com/payments/payment-resources/verification-of-payee.md): Use Yapily's Verification of Payee (VoP) to confirm bank account ownership before sending payments. Reduce fraud risk and prevent misdirected payment transfers.
- [Periodic Payments](https://docs.yapily.com/payments/periodic-payments.md): Set up periodic (standing order) payments with Yapily. Configure payment frequency, amounts, and consent management for automated recurring bank payment instructions.
- [Scheduled Payments](https://docs.yapily.com/payments/scheduled-payments.md): Create future-dated scheduled payments using the Yapily Open Banking API. Learn how to set payment execution dates, manage consents, and handle status updates.
- [Single Payments](https://docs.yapily.com/payments/single-payments.md): Initiate single domestic and international payments using the Yapily API. Covers payment types, required fields, institution compatibility, and response handling.
- [Tutorial: Make a single payment](https://docs.yapily.com/payments/tutorial-single-payment.md): Step-by-step tutorial for completing a domestic UK single payment with Yapily's Open Banking API. Covers institution selection, user consent, and payment execution.
- [Additional Information](https://docs.yapily.com/payments/vrps/additional-information.md): Additional guidance for implementing Variable Recurring Payments with Yapily, including edge cases, error handling, and best practices for VRP API integrations.
- [Institution Coverage](https://docs.yapily.com/payments/vrps/coverage.md): Check which UK banks support Variable Recurring Payments (VRP) through Yapily's Open Banking API. Updated institution coverage list for VRP integrations.
- [Get Started](https://docs.yapily.com/payments/vrps/get-started.md): Getting started guide for Yapily Variable Recurring Payments. Learn how to create VRP consents, configure mandates, and initiate recurring payments programmatically.
- [Introduction](https://docs.yapily.com/payments/vrps/introduction.md): Introduction to Variable Recurring Payments (VRPs) with Yapily. Enable flexible, automated bank payments with customer-defined limits for open banking use cases.
- [Mandate Details](https://docs.yapily.com/payments/vrps/mandate-details.md): Technical reference for VRP mandate parameters in the Yapily API. Covers maximum amount, frequency, date ranges, and merchant category codes for recurring mandates.
- [Austria](https://docs.yapily.com/registration-configurations/countries/austria.md)
- [Baltics](https://docs.yapily.com/registration-configurations/countries/baltics.md)
- [Belgium](https://docs.yapily.com/registration-configurations/countries/belgium.md)
- [Bulgaria](https://docs.yapily.com/registration-configurations/countries/bulgaria.md)
- [Croatia](https://docs.yapily.com/registration-configurations/countries/croatia.md)
- [Cyprus](https://docs.yapily.com/registration-configurations/countries/cyprus.md)
- [Finland](https://docs.yapily.com/registration-configurations/countries/finland.md)
- [France](https://docs.yapily.com/registration-configurations/countries/france.md)
- [Germany](https://docs.yapily.com/registration-configurations/countries/germany.md)
- [Ireland](https://docs.yapily.com/registration-configurations/countries/ireland.md)
- [Italy](https://docs.yapily.com/registration-configurations/countries/italy.md)
- [Luxembourg](https://docs.yapily.com/registration-configurations/countries/luxembourg.md)
- [Netherlands](https://docs.yapily.com/registration-configurations/countries/netherlands.md)
- [Nordics](https://docs.yapily.com/registration-configurations/countries/nordics.md)
- [Poland](https://docs.yapily.com/registration-configurations/countries/poland.md)
- [Portugal](https://docs.yapily.com/registration-configurations/countries/portugal.md)
- [Slovakia](https://docs.yapily.com/registration-configurations/countries/slovakia.md)
- [Slovenia](https://docs.yapily.com/registration-configurations/countries/slovenia.md)
- [Spain](https://docs.yapily.com/registration-configurations/countries/spain.md)
- [Sweden](https://docs.yapily.com/registration-configurations/countries/sweden.md)
- [United Kingdom](https://docs.yapily.com/registration-configurations/countries/uk.md)
- [Registration Configurations](https://docs.yapily.com/registration-configurations/index.md)
- [Changelog](https://docs.yapily.com/resources/changelog.md): Latest updates, new features, bug fixes, and breaking changes to the Yapily Open Banking API and documentation. Subscribe to the RSS feed to stay current.
- [Client Libraries](https://docs.yapily.com/resources/client-libraries.md): Generate API client libraries for Yapily in your preferred language using the OpenAPI specification. Supports code generation for Java, Python, Node.js, and more.
- [Error Handling](https://docs.yapily.com/resources/errors.md): Handle Yapily API errors effectively. Covers error response structure, HTTP status codes, retry strategies, and solutions for the most common error scenarios.
- [Overview](https://docs.yapily.com/resources/overview.md): Essential resources for building with Yapily API
- [Sandbox Overview](https://docs.yapily.com/resources/sandbox/overview.md): Explore Yapily's sandbox environment for testing open banking integrations without live bank connections. Access test institutions, simulate payment flows, and validate consents.
- [Sandbox Credentials](https://docs.yapily.com/resources/sandbox/sandbox-credentials.md): Sandbox test credentials for Yapily institution integrations. Find test usernames, passwords, and OTP codes for each supported sandbox bank institution.
- [Test cases](https://docs.yapily.com/resources/sandbox/test-cases.md): Recommended test cases for validating your Yapily integration in the sandbox environment. Covers payment flows, data access scenarios, and error conditions to verify.
- [Support](https://docs.yapily.com/resources/support.md): Get help with your Yapily integration. Access documentation, raise a support ticket, or contact the team directly for technical assistance with the Yapily API.
- [Hosted Data Consent Statuses and Phases](https://docs.yapily.com/tools-and-services/hosted-pages/data-consent-statuses.md): Introduction to Yapily Hosted Pages data consent statuses and phases
- [Yapily Hosted Pages](https://docs.yapily.com/tools-and-services/hosted-pages/overview.md): Yapily Hosted Pages provides a fully managed open banking UI for payments and data access. Launch quickly without building institution selection or consent screens yourself.
- [Hosted Payment Statuses and Phases](https://docs.yapily.com/tools-and-services/hosted-pages/payment-status-and-phase.md): Understand payment status and phase values for Yapily Hosted Pages. Track payment lifecycle from initiation through completion, including all intermediate states.
- [Data tutorial using Yapily Hosted Pages](https://docs.yapily.com/tools-and-services/hosted-pages/payment-tutorial-hosted-data.md): Tutorial for accessing financial data using Yapily Hosted Pages. Create a data session and retrieve account information through the hosted open banking UI.
- [Payment tutorial using Yapily Hosted Pages](https://docs.yapily.com/tools-and-services/hosted-pages/payment-tutorial-hosted-pages.md): Tutorial for initiating a single payment using Yapily Hosted Pages. Generate a payment session URL and guide users through the complete open banking payment journey.
- [Hosted Payment Webhooks](https://docs.yapily.com/tools-and-services/hosted-pages/payment-webhooks.md): Receive real-time notifications on the status of hosted payments
- [Yapily Hosted Pages UI screens](https://docs.yapily.com/tools-and-services/hosted-pages/ui-screens.md): Visual guide to Yapily Hosted Pages UI screens for payment and data flows. See institution picker, consent, confirmation, and payment status screens shown to end users.
- [Open Banking Enrolment Guide](https://docs.yapily.com/tools-and-services/open-banking/enrolment-guide.md): To connect to an Open Banking Institution you will need to enrol onto the Open Banking Directory. Find out more here.
- [Yapily Pay By Link](https://docs.yapily.com/tools-and-services/pay-by-link/overview.md): Generate shareable open banking payment links with Yapily Pay By Link. Accept payments without a checkout integration — ideal for invoices, requests, and pay-by-demand.
- [Payment tutorial using Pay By Link](https://docs.yapily.com/tools-and-services/pay-by-link/payment-tutorial-pay-by-link.md): Tutorial for creating and sharing a Yapily Pay By Link payment request. Generate a payment link, customise parameters, share with payers, and track payment status.
- [Yapily Pay By Link UI screens](https://docs.yapily.com/tools-and-services/pay-by-link/ui-screens.md): Visual reference for Yapily Pay By Link screens. See the payment link landing page, institution selection, authorisation, and payment confirmation screens.
- [Webhooks Get Started](https://docs.yapily.com/tools-and-services/webhooks/get-started.md): Get started with Yapily Webhooks. Register webhook endpoints, verify event signatures, and handle payment and consent event notifications in your backend application.
- [Introduction](https://docs.yapily.com/tools-and-services/webhooks/introduction.md): Introduction to Yapily Webhooks for real-time event notifications. Receive payment status updates, consent events, and data access notifications via secure HTTP callbacks.
- [Migration Guide Notification API to Webhook API](https://docs.yapily.com/tools-and-services/webhooks/webhook-migration.md): This guide provides a comprehensive walkthrough of the necessary steps to seamlessly migrate from the deprecated Notification API to the enhanced Webhook API.
- [Yapily Connect Overview](https://docs.yapily.com/tools-and-services/yapily-connect/overview.md): Yapily Connect provides a ready-built, white-label open banking UI for AIS and PIS flows. Reduce development effort with pre-built institution selection and consent screens.
- [Yapily Connect AIS UX guidelines](https://docs.yapily.com/tools-and-services/yapily-connect/yapilyconnect-ux-ais-guidelines.md): UX design guidelines for Yapily Connect AIS flows. Best practices for institution selection, consent screens, and account selection for data access user journeys.
- [Yapily Connect PIS UX guidelines](https://docs.yapily.com/tools-and-services/yapily-connect/yapilyconnect-ux-pis-guidelines.md): UX design guidelines for Yapily Connect PIS flows. Best practices for payment initiation UI, institution selection, and confirmation screens for payment user journeys.

## OpenAPI Specs

- [openapi](https://docs.yapily.com/openapi.json)
- [openapi-converted](https://docs.yapily.com/openapi-converted.json)


Built with [Mintlify](https://mintlify.com).