Choose your integration
Prerequisites
Before you begin, make sure you have:
- A Banqup account → Register here
- API credentials (Client ID & Secret) → Create client credentials
- Basic knowledge of REST APIs and HTTP requests
- A tool to make API calls: curl, Postman, or your preferred programming language
Step 1: Identify your integration use case and authentication flow
Before you start coding, it's important to understand which integration type you need and its corresponding OAuth 2.0 flow.
A. Workflow integrations and automations
Authentication flow: Client Credentials Grant
This is the most common flow for:
- Integrating Banqup with your internal ERP/accounting system
- Automating invoice processing for your company
- Syncing data between Banqup and your own applications
- Building integrations for the Banqup Store (marketplace)
Example use case: "We want to automatically sync invoices from Banqup to our QuickBooks instance."
How it works:
- Your application uses a Client ID and Client Secret
- Exchange credentials directly for an access token
- No user interaction required
- Your business owner must whitelist your application ID
Check out how to make your first API call using the Client Credentials Grant flow.
B. Customer-facing integrations
Authentication flow: Authorization Code Grant (OAuth User Flow)
This flow is for:
- SaaS applications offering Banqup integration to customers
- Multi-tenant platforms where each customer connects their own Banqup account
- Apps where users authenticate with their Banqup credentials
Example use case: "We're a SaaS accounting platform and want to let our customers connect their Banqup accounts."
How it works:
- User clicks "Connect to Banqup" in your app
- User is redirected to Banqup login page
- User grants your app permission to access their data
- Your app receives an authorization code
- Exchange code for access token
Check out how to implement OAuth user flow.
Step 2: Choose your integration path
E-Invoicing Integration
Authentication type: Client Credentials Grant
Build automated invoice workflows:
- Sales Invoice Flow
- Purchase Invoice Flow
- Recipe: Upload a Sales Invoices
- Recipe: Upload a Purchase Invoices
Payments Integration
Authentication type: Client Credentials Grant
Accept and process payments:
- Payment Accounts Guide - Core payment concepts
- Payments Onboarding - Setup payment processing
- Recipe: Set Up Card Payments - Enable card transactions
- Recipe: Transfer Funds - Bank transfers
Platform Integration
Authentication type: Client Credentials Grant
Integrate with core Banqup services:
- Foundation Services - Core platform APIs
- Workspace Management - Manage entities and spaces
- User Permissions - Access control
- Recipe: Message Listeners - Real-time events
Advanced Authentication
Implement user-level authentication:
- Implement OAuth User Flow - User consent flow
- Grant Permissions - Permission management
- Manage Credentials - Credential lifecycle
Development Resources
- API Explorer - Interactive API testing and documentation
- API Recipes - Step-by-step integration guides
- Developer Portal - Manage credentials and apps
- Error Handling Guide - Troubleshooting and error codes
Key Concepts
Entity: Represents a company/organization in Banqup
Space: A workspace within an entity (e.g. certain sub-brand or branch)
User: Individual with access to entities and spaces
Feedback & Contribution
Help Us Improve
Is something unclear? Found an error? Help us improve this guide!
- Email documentation feedback to: support@banqup.com
Share Your Experience
Built something cool with Banqup APIs? We'd love to hear about it!
- Share your integration story
- Contribute code examples
- Write a guest blog post
Contact: support@banqup.com