API recipes overview
API recipes are practical examples or step-by-step guides that show you how to accomplish specific tasks using the Banqup APIs. They provide detailed instructions and code snippets to help you understand how to use various endpoints and functionalities offered by the APIs.
- API Access
- eInvoicing
- Payments
- Clients
- Platform
Grant Banqup permissionsGrant Banqup API permissions to developers, in the Banqup app.
2 steps
Grant app access to clientsGrant the API app access to the client spaces you want to interact with.
1 step
Create and manage app credentialsCreate and revoke app credentials on the Banqup Developer Portal.
4 steps
Get access token with app credentialsGenerate access tokens with app credentials to make authorized API calls.
2 steps
Implement authorization code flowImplement the OAuth 2.0 authorization code flow.
3 steps
AFNOR - Look up a companyLook up a company and its details in the AFNOR directory.
3 stepsFrance only
AFNOR - Receive invoicesSearch for, receive and download purchase invoices.
3 stepsFrance only
AFNOR - Send invoicesSend, track and download sales invoices.
3 stepsFrance only
AFNOR - Set up webhooksCreate, verify, and manage webhook subscriptions.
4 stepsFrance only
Create and send Factur-X documentsCreate, validate and send a valid Factur-X document.
3 stepsFrance only
Create and send UBL/PDF documents
Create, validate and send invoices/credit notes in UBL/PDF format.
3 steps
Create invoices with line discountsCreate sales invoices with line discounts using JSON metadata.
4 steps
Process sales invoicesUpload invoice, validate it, and send it to your customer.
4 steps
Process purchase invoicesPerform tasks on purchase invoices, e.g.: approve, mark as paid etc.
6 steps
Create business partnerCreate new business partners and set up delivery channels.
3 steps
Useful information - Documents
- How to get the Space and Entity IDs? Read more about spaces and entities.
- How to get the Plugin Interface IDs?
- How to get the Connection IDs?
- How to get the Payment Account IDs? Read more about payment accounts.
Pay purchase invoicesPay one or more invoices and view payment status.
3 steps
Pay foreign currency invoicesHandle multi-currency cross-border invoice settlements.
6 steps
Direct foreign currency transfersHandle multi-currency cross-border direct account settlements.
4 steps
Transfer fundsTransfer funds between accounts, including Banqup accounts.
2 steps
Set up a debit cardSet up the details to start using a Banqup physical or virtual debit card.
4 steps
Useful information - Payments
- How to get the Space and Entity IDs? Read more about spaces and entities.
- How to get the Payment Account IDs? Read more about payment accounts.
- How to get the End to End IDs? Read more about payment initiation.
- How to get the Card IDs?
