Introduction

The Business API supports 2 authentication methods:

Depending on who will be using your integration and which endpoints you will be calling, you could need to use OAuth 2.0 (instead of the API key).

Which authentication method do I need?

You need to automate your own business

To authenticate to the Business API with your own Qonto account, you have 2 options depending on the endpoints you will be calling (cf. the table below to identify if you need to use an endpoint which is only accessible through OAuth).

API key
OAuth 2.0

Follow those steps.

You need to build an integration for your customers

Sign up to the Developer Portal to get your credentials (as well as an access to our Sandbox environment);
Implement the OAuth flow.

Endpoints access

Endpoint	OAuth 2.0	API key	SCA	OAuth scope
SEPA Beneficiaries
List SEPA beneficiaries	✔️	✔️		`organization.read`
Add a SEPA beneficiary	✔️			`payment.write`
Retrieve a SEPA beneficiary	✔️	✔️		`organization.read`
Update a SEPA beneficiary	✔️			`payment.write`
Trust SEPA beneficiaries	✔️		✔️	`beneficiary.trust`
Untrust SEPA beneficiaries	✔️			`payment.write`
International transfers
List Intenational transfer requirements	✔️			`international_transfer.write`
Create International Transfers	✔️		✔️	`international_transfer.write`
List requirements for an international beneficiary	✔️			`international_transfer.write`
Update an international beneficiary	✔️			`international_transfer.write`
Create an international beneficiary	✔️			`international_transfer.write`
Delete an international beneficiary	✔️			`international_transfer.write`
Create a new international transfer quote	✔️			`international_transfer.write`
Attachments
Upload an attachment	✔️	✔️		`attachment.write`
Retrieve an attachment	✔️	✔️		`attachment.read`
Labels
List labels	✔️	✔️		`organization.read`
Retrieve a label	✔️	✔️		`organization.read`
Memberships
List memberships	✔️	✔️		`organization.read`
Retrieve the authenticated membership	✔️			`membership.read`
Create a membership	✔️			`membership.write`
Organization
Retrieve the authenticated organization and list bank accounts	✔️	✔️		`organization.read`
Subscription
Retrieve the organization’s current subscription plan	✔️	✔️		`subscription.read`
Attachments in transactions
List attachments for a transaction	✔️	✔️		`attachment.read`
Upload an attachment to a transaction	✔️	✔️		`attachment.write`
Remove all attachments from a transaction	✔️	✔️		`attachment.write`
Remove an attachment from a transaction	✔️	✔️		`attachment.write`
Transactions
List transactions	✔️	✔️		`organization.read`
Retrieve a transaction	✔️	✔️		`organization.read`
List child transaction links	✔️	✔️		`organization.read`
Internal transfers
Create an internal transfer	✔️	✔️		`internal_transfer.write`
Requests
List requests	✔️	✔️		`organization.read`
Create a flash card request	✔️			`request_transfers.write`
Create a virtual card request	✔️			`request_transfers.write`
Create multi transfer request	✔️			`request_transfers.write`
Approve a request	✔️		✔️	`request_transfers.write`
Decline a request	✔️			`request_transfers.write`
Supplier invoices
Retrieve a supplier invoice	✔️	✔️		`supplier_invoice.read`
List supplier invoices	✔️	✔️		`supplier_invoice.read`
Create supplier invoices	✔️	✔️		`supplier_invoice.write`
Client invoices
List client invoices	✔️	✔️		`client_invoices.read`
Create a client invoice	✔️	✔️		`client_invoice.write`
Retrieve a client invoice	✔️	✔️		`client_invoices.read`
Update a client invoice	✔️	✔️		`client_invoice.write`
Mark a client invoice as canceled	✔️	✔️		`client_invoice.write`
Unmark a client invoice as paid	✔️	✔️		`client_invoice.write`
Delete a client invoice	✔️	✔️		`client_invoice.write`
Mark a client invoice as paid	✔️	✔️		`client_invoice.write`
Credit notes
List credit notes	✔️	✔️		`client_invoices.read`
Retrieve a credit note	✔️	✔️		`client_invoices.read`
Clients
Retrieve a client	✔️	✔️		`client.read`
List clients	✔️	✔️		`client.read`
Create a client	✔️	✔️		`client.write`
Update a client	✔️	✔️		`client.write`
Delete a client	✔️	✔️		`client.write`
Products
List products	✔️	✔️		`product.read`
Create a product	✔️	✔️		`product.write`
Teams
List teams	✔️			`team.read`
Create a team	✔️			`team.write`
Statements
Retrieve a statement	✔️	✔️		`organization.read`
List statements	✔️	✔️		`organization.read`
Insurance contracts
Create an insurance contract	✔️			`insurance_contract.write`
Retrieve an insurance contract	✔️			`insurance_contract.read`
Update an insurance contract	✔️			`insurance_contract.write`
Upload a document to an insurance contract	✔️			`insurance_contract.write`
Remove a document from an insurance contract	✔️			`insurance_contract.write`
Cards
List cards	✔️			`card.read`
Create a card	✔️		✔️	`card.write`
Bulk Create a card	✔️		✔️	`card.write`
Retrieve a card iframe url	✔️			`card.read`
Report a physical card as lost	✔️			`card.write`
Report a physical card as stolen	✔️			`card.write`
Discard a card	✔️			`card.write`
Lock a card	✔️			`card.write`
Unlock a card	✔️		✔️	`card.write`
Update a card’s limits	✔️		✔️	`card.write`
Update a card’s restrictions	✔️			`card.write`
Update a card’s options	✔️			`card.write`
Update a card’s nickname	✔️			`card.write`
Business Accounts
List business accounts	✔️	✔️		`organization.read`
Retrieve a business account	✔️	✔️		`organization.read`
Create a business account	✔️			`bank_account.write`
Update a business account	✔️			`bank_account.write`
Close a business account	✔️		✔️	`bank_account.write`
Payment Links
Connect to the payment links provider	✔️			`payment_link.write`
Get the connection status	✔️			`payment_link.read`
List payment links	✔️			`payment_link.read`
Create a payment link	✔️			`payment_link.write`
Retrieve a payment link	✔️			`payment_link.read`
Deactivate a payment link	✔️			`payment_link.write`
List payments for a payment link	✔️			`payment_link.read`
List available payment methods	✔️			`payment_link.read`
Webhooks
List webhook subscriptions	✔️			`webhook`
Create a new webhook subscription	✔️			`webhook`
Get a webhook subscription	✔️			`webhook`
Update a webhook subscription	✔️			`webhook`
Delete a webhook subscription	✔️			`webhook`
E-invoicing
Retrieve e-invoicing settings	✔️			`einvoicing.read`
Incoming SEPA Direct Debit
List SEPA Direct Debit mandates	✔️			`sepa_direct_debit.read`
Get a SEPA Direct Debit mandate	✔️			`sepa_direct_debit.read`
Create a SEPA Direct Debit mandate	✔️			`sepa_direct_debit.write`
List SEPA Direct Debit subscriptions	✔️			`sepa_direct_debit.read`
Get a SEPA Direct Debit subscription	✔️			`sepa_direct_debit.read`
Create a SEPA Direct Debit subscription	✔️			`sepa_direct_debit.write`
List SEPA Direct Debit collections	✔️			`sepa_direct_debit.read`
Get a SEPA Direct Debit collection	✔️			`sepa_direct_debit.read`
Terminals
List terminals	✔️			`terminal.read`
Get a terminal payment	✔️			`terminal.read`
Create a terminal payment	✔️			`terminal.write`
Cash flow categories
List cash flow categories	✔️			`cash_flow_category.read`
Create a cash flow category	✔️			`cash_flow_category.write`
Create a cash flow subcategory	✔️			`cash_flow_category.write`
Assign a cash flow category to transactions	✔️			`cash_flow_category.write`
Unassign a cash flow category from transactions	✔️			`cash_flow_category.write`

General

Business API

Onboarding API

SDKs & Libraries

Introduction

Which authentication method do I need?

Endpoints access

​Which authentication method do I need?

​Endpoints access

Which authentication method do I need?

Endpoints access