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.

Yapily Dashboard

Configure your apps here to get them connected and fetch live and sandbox data from institutions.

API Reference

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

Ready to get started?

Reach out to our sales representative to learn about pricing.

QuickStart Guide

Yapily helps developers adopt Open Banking solutions into their applications. We have APIs to gather account data and initiate account to account payments for an impressive number of banks participating in the Open Banking ecosystem.

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
    • Click Download Secret to download the secret file containing the key (application-uuid) and secret (application-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 using Postman or cURL (1 min)

    • Using Postman,
      • Create a new basic HTTP request by selecting HTTP method as GET and entering request URL as https://api.yapily.com/institutions
      • Go to Authorization tab and select Basic Auth from Type dropdown
      • Enter the application's key and secret from the secret file you downloaded before (from Step 2) against Username and Password respectively to authenticate your requests to your application.
      • Click Send to make your first API request to test your integration.
    • Using cURL,
      • Execute the cURL command by directly applying the application's key and secret to test your integration (or)
                                      		curl -u key:secret 'https://api.yapily.com/institutions'
                                      	
                                          	curl -X GET 'https://api.yapily.com/institutions' -H 'Authorization: Basic {authToken}'
                                      	

    Congratulations! You have executed your first API call to retrieve all the institutions associated with your Yapily application.

  6. 6

    Next Steps

    Start using real banking data by submitting our Contact Form, or explore our Postman collection in the Yapily Dashboard > My Applications > Your application > Tools section.

Recommended Tutorials

Are you interested in...

  1. 1

    Financial Data

    This tutorial walks you through each of the steps required to obtain a user's account and transaction data.

  2. 2

    Payments

    This tutorial walks you through each of the steps required to complete an Open Banking payment using Yapily.

Support

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