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.

API Reference

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

Demos & Resources

Checkout Yapily Hub for some inspiring Open Banking demos.

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.

  2. 2

    Create an Application (1 min)

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

    • Go to My Applications and click 'Add New'
    • Choose a name for the Application and click 'Create'
    • Download the key and secret
  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.com/ to your authorized callbacks

  4. 4

    Configure Sandbox (2 mins)

    In order to test Yapily you'll need to configure a sandbox in the dashboard, this will allow you perform API requests against a Mock Bank:

    • Select your Application
    • Go to the Institutions tab and click 'Add Institution'
    • Search for modelo-sandbox (or change the filter 'All Environments' to 'Preconfigured Sandbox') and click 'Open'
    • Click 'Select' to add modelo-sandbox to your Application and select 'Yes, Preconfigured Credentials'

  5. 5

    Send your first API request (1 min)

    • Using the application's Key and Secret you downloaded before, generate the authToken used to authenticate your requests to your application
    • 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!

  6. 6

    What's Next

    You have successfully completed our Getting Started Guide! Consider checking the Next Steps section below.

Next Steps

Are you interested in...

  1. 1

    Contacting Yapily

    If you are interested in becoming a customer, you want to discuss with a Yapily's representative, or you want to move into using real banks, please consider filling the Contact Form.

  2. 2

    Keep testing our API

    We recommend that you follow one of our tutorials for financial data or payments:

    Or that you explore our Postman collection via navigating to Yapily's Dashboard > My Applications > Your application > Tools.

Support

If you have an issue while using the API or documentation, check out our Support article for how to raise an issue.

Feedback

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