API Documentation

The Yapily API enables connections between your application and your users' banks to process payments or retrieve financial data. Learn more about how to build with our API, follow our tutorials and gain Open Banking insights here.

Getting Started

Understand how Yapily works and how to get started with integrating Yapily into your application.

Get Started

API Reference

A complete reference documentation for Yapily's powerful API, detailing endpoints, methods and models.

API Reference

Demos & Resources

Checkout Yapily Hub for some inspiring Open Banking demos.

Hub ↗

Getting Started

Yapily empowers financial applications to connect with their customers through Open Banking. Our API supports Account Information (AIS) and Payment Initiation services (PIS) that will enrich your customer's experience and create financial opportunity.

Quickstart

Getting started with Yapily typically takes just a few minutes. After following these steps, you'll be ready to start your integration.

  1. 1

    Sign-up (1 min)

    Sign up here for a free Yapily account.

    If you have received an invitation to join an existing Yapily organization, you can access Yapily after signing in.

  2. 2

    Create an Application (1 min)

    After creating an account, you'll need to generate a new Application.

  3. 3

    Configure Callback URL (1 min)

    You'll need to configure the Application Callback URL for testing. In the dashboard:

    • Select your Application
    • Go to the Settings tab and click 'Add Callback'
    • Add https://display-parameters.herokuapp.com/ to your authorized callbacks

  4. 4

    Configure Sandbox (2 mins)

    Before going live, you'll want to test your integration to Yapily so you'll need to configure a sandbox. In the dashboard:

    • Select your Application
    • Go to the Institutions tab and click 'Add Institution'
    • Search for modelo-sandbox and click 'Open'
    • Add modelo-sandbox to your Application

  5. 5

    Send your first API request (1 min)

    Let's make your first API request to test that you are ready to start your integration. 

    							    curl --location --request GET 'https://api.yapily.com/institutions' \
  --header 'Authorization: Basic {authToken}'

    Congratulations on sending your first Yapily API request!

Registration

Before going live your company will need to be registered through one of the registration options. Registration is the process of taking electronic identification certificates such as eIDAS, and using them to declare your company, the nature of your business and named software applications that will be making connections, to both the Open Banking directory (the OBIE in the UK) and all of the banks (ASPSPs) that you wish to connect to.

Learn more ↗

Next Steps

Next we recommend that you follow one of our tutorials for payments or financial data.

Alternatively, check out one of the quick links below.

Support

If you can't find what you're looking for in the documentation, reach out at support@yapily.com.

Feedback

Do you have any feedback for us? Complete this short form to let us know!