• Not the first time here? Here are your quick-links 🚀

🎮 Go To Your Playground

Start testing with the FinHub API playground

🔌 Integration

View integration flows and guides

🚀 Go-Live Process

Learn about the production deployment process

⚙️ Exploitation

Manage your production environment

​
API Client V2 Overview

This guide provides a comprehensive overview of the process to become a FinHub API client, from initial registration to full production deployment.

​
Client Journey

The journey to becoming a fully integrated FinHub API client consists of several phases:

​
1. Registration and Product Selection

The first step in your journey is registering as a FinHub API client and selecting the products you wish to integrate:
  • Registration: Complete the application form on the FinHub Developer Portal
  • Product Selection: Choose from our suite of financial products (payments, accounts, cards, etc.)
  • Agreement: Review and sign the API client agreement
  • Compliance Check: Pass the initial compliance verification

​
2. Sandbox Configuration

After registration approval:
  • Sandbox Credentials: Receive your sandbox tenant credentials
  • Environment Setup: Configure your development environment
  • Documentation Access: Gain access to complete API documentation
  • Support Channel: Get connected to the developer support team

​
3. Playground Phase

The playground phase allows you to explore and test the FinHub APIs:
  • API Exploration: Familiarize yourself with available endpoints
  • Test Transactions: Perform test transactions in the sandbox
  • Feature Validation: Validate that all required features are available
  • Support Engagement: Engage with our support team for questions

​
4. Integration Phase

Once you’re comfortable with the APIs and have signed a contract for your selected products:
  • Development: Build your integration with FinHub APIs
  • Testing: Comprehensive testing of all integration points
  • Technical Reviews: Regular reviews with FinHub technical team
  • Issue Resolution: Address any issues identified during testing

​
5. Certification

Before going live:
  • Integration Certification: Complete the certification checklist
  • Security Review: Pass the security assessment
  • Performance Testing: Validate performance under expected load
  • Final Approval: Receive final approval from the FinHub team

​
6. Go-Live Process

Transitioning to production:
  • Production Credentials: Receive production tenant credentials
  • Gradual Rollout: Implement a phased rollout strategy
  • Monitoring Setup: Configure monitoring and alerting
  • Production Validation: Validate the first production transactions

​
7. Exploitation Phase

Ongoing operation and optimization:
  • Performance Monitoring: Monitor API performance and usage
  • Feature Updates: Stay informed about new features and updates
  • Scaling: Scale your integration as your business grows
  • Continuous Improvement: Regular reviews and optimization

​
Next Steps