How to use IBM® App Connect with Yapily
Yapily is a single API interface that connects your product to all banks for payments and data access.
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 page (previously the Catalog page) or flow editor. If necessary, work with your Yapily administrator to obtain these values.
Yapily has the following connection fields.
- Application key
- If you use basic authentication to establish a secure connection, specify the application key to connect to the Yapily API.
- Application secret
- If you use basic authentication to establish a secure connection, specify the application secret to connect to the Yapily API.
- Access token
- If you use token-based authentication to make authorized requests for financial data, specify the access token to connect to the Yapily API, and don't complete the Application key and Application secret fields. The access token takes precedence over the application key and secret.
To obtain the connection values for Yapily, see Obtaining connection values for Yapily.
To connect to a Yapily endpoint from the App Connect Designer Applications and APIs page for the first time, expand Yapily, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
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.
| Object | Action | Description |
|---|---|---|
| Account statements | Retrieve account statements | Retrieves account statement details for a specific account |
| Retrieve statement file content | Retrieves the content of an account statement file | |
| Accounts | Retrieve accounts | Retrieves account details |
| Application | Retrieve application | Retrieves an application's details |
| Application users | Create user | Creates an application user |
| Delete user | Deletes a user in your application | |
| Retrieve users | Retrieves users in your application | |
| Authorization requests | Create account authorization request | Initiates the authorization process that requires a user to give their consent for access to account data |
| Create single payment authorization request | Initiates the authorization process that requires a user to give their consent for a single payment | |
| Re-authorize consent | Initiates the re-authorisation process of a user's consent | |
| Available features | Retrieve available features for institutions | Provides descriptions for each of the institutions' features. Features available for each institution can be seen in the features field of the institution payload. |
| Consents | Delete consent | Deletes a user's consent for access to financial data or funds |
| Exchange one-time token | Retrieves a consent by supplying a one time token | |
| Retrieve consents | Retrieves consent details about access to financial data or funds | |
| Send access token | Creates a Yapily consent token by sending OAuth2 access token or API key data | |
| Send API key | Creates a Yapily consent token by sending an API key | |
| Institutions | Retrieve institutions | Retrieves an institution's details |
| Payments | Create single payment | Initiates a single payment to a third party |
| Retrieve payment status | Retrieves the status of a payment by using the ID returned when the payment was submitted | |
| Transactions | Retrieve transactions | Retrieves the transactions for a specific account |
Examples
Use templates to quickly create flows for Yapily
Learn how to use App Connect templates to quickly create flows that complete actions on Yapily. For example, go to the Discover page and search for Yapily.