Welcome to the figo documentation! Here you will find all the necessary information to integrate figo into your application and leverage its powerful banking API.
Table of Contents
- Introduction
- Getting Started
- Authentication
- Bank Connections
- Transactions
- Balances
- Payments
- Webhooks
- Errors
Introduction
figo is a comprehensive banking API that allows developers to access and interact with bank data. It provides a seamless integration with various banking systems, enabling users to manage finances, retrieve transactions, and initiate payments programmatically.
Getting Started
To get started with figo, you need to sign up for an API key. Follow the steps outlined below:
- Visit the figo website.
- Create a developer account.
- Generate an API key.
Once you have obtained your API key, you can start integrating figo into your application.
Authentication
To authenticate with figo, you need to follow a three-legged OAuth 2.0 process:
- Direct the user to authorize figo access to their bank accounts.
- Receive the authorization code.
- Exchange the authorization code for an access token and a refresh token.
Bank Connections
With figo, you can establish secure connections with various banks and retrieve account information. Follow the steps below to connect to a bank:
- Call the respective endpoint to retrieve a list of supported banks.
- Redirect the user to the figo-connect interface to authorize the bank connection.
- Receive an access token for the respective bank.
- Access the user’s account data using the obtained access token.
Transactions
Retrieve and manage transaction data with figo. Use the provided endpoints to:
- Retrieve all transactions for a specific bank account.
- Filter transactions based on various criteria such as date or amount range.
- Create new transactions.
- Delete transactions.
Balances
Inquire about the balances of a specific bank account with figo. The following operations can be performed:
- Retrieve the balance for a specific account.
- Retrieve the balance for all accounts.
Payments
Initiate and manage payments programmatically using figo. Perform the following operations:
- Initiate a new payment order.
- Retrieve a list of payments for a specific account.
- Retrieve information about a specific payment.
Webhooks
Get real-time updates and notifications from figo by setting up webhooks. The following functionalities are available:
- Create a new webhook.
- List all registered webhooks.
- Delete a webhook.
Errors
Refer to the figo error codes and messages when encountering errors during API usage. The documentation provides details about the possible errors and their meanings.
That’s it! You now have a general overview of figo’s functionality. Dive into the specific documentation for each API endpoint to learn more about its usage and parameters.