How to use IBM® App Connect with Yapily

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to Yapily

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your Yapily administrator to obtain these values.

• If using basic authentication to establish a secure connection, specify the Application key and Application secret for connecting to the Yapily API.
• If using token-based authentication to make authorised requests for financial data, specify the access token for connecting to the Yapily API, and leave the Application key and Application secret fields blank. The access token takes precedence over the application key and secret.

Yapily connection fields:

Application key

If using basic authentication to establish a secure connection, specify the application key for connecting to the Yapily API.

• Required: False

Application secret

If using basic authentication to establish a secure connection, specify the application secret for connecting to the Yapily API.

• Required: False

Access token

If using token-based authentication to make authorised requests for financial data, specify the access token for connecting to the Yapily API, and leave the Application key and Application secret fields blank. The access token takes precedence over the application key and secret.

• Required: False

To obtain the connection values for Yapily, see Obtaining connection values for Yapily.

To connect to a Yapily endpoint from the App Connect Designer Catalog page for the first time, expand Yapily, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with Yapily, take note of the following considerations:

• (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

  For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

Yapily events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Yapily actions

Your flow completes these actions on this application.

Account statements

Retrieve account statements

Retrieve statement file content

Accounts

Retrieve accounts

Application

Retrieve application

Application users

Create user

Retrieve users

Delete user

Authorization requests

Create account authorization request

Create single payment authorization request

Re-authorize consent

Available features

Retrieve available features for institutions

Consents

Retrieve consents

Delete consent

Send API key

Send access token

Exchange one time token

Institutions

Retrieve institutions

Payments

Create single payment

Retrieve payment status

Transactions

Retrieve transactions