Qonto

https://docs.qonto.com/
Admin
Qonto is a leading European business finance solution that simplifies everyday banking, financing,...
Tokens:622,604
Snippets:4,692
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### cURL request with X-Qonto-Staging-Token

Source: https://docs.qonto.com/get-started/general/sandbox-access

Example of a GET request to the Sandbox environment including the required Authorization and X-Qonto-Staging-Token headers.

```bash
curl -X GET 'https://thirdparty-sandbox.staging.qonto.co/v2/bank_accounts' \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'X-Qonto-Staging-Token: <your_staging_token>'
```

--------------------------------

### ClientBillingAddress Schema Example

Source: https://docs.qonto.com/api-reference/business-api/expense-management/client-quotes-notes/client-invoices/mark-a-client-invoice-as-paid

Example values for the ClientBillingAddress object fields.

```yaml
street_address: 123 Main Street
city: Paris
zip_code: '75009'
country_code: FR
```

--------------------------------

### Install the SDK with pnpm

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/getting-started

Install the SDK using the pnpm package manager.

```bash
pnpm install @qonto/embed-sdk
```

--------------------------------

### GET /v2/transactions

Source: https://docs.qonto.com/get-started/general/pagination

Example of a paginated request to the transactions endpoint.

```APIDOC
## GET /v2/transactions

### Description
Fetch a paginated list of transactions for a specific IBAN.

### Method
GET

### Endpoint
https://thirdparty.qonto.com/v2/transactions

### Parameters
#### Query Parameters
- **iban** (string) - Required - The IBAN of the account.
- **per_page** (integer) - Optional - Number of items per page (Min: 1, Max: 100, Default: 100).
- **page** (integer) - Optional - The page number to retrieve (Default: 1).

### Response
#### Success Response (200)
- **transactions** (array) - List of transaction objects.
- **meta** (object) - Pagination metadata including current_page, next_page, prev_page, total_pages, total_count, and per_page.

#### Response Example
{
  "transactions": [{}],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 11,
    "total_count": 210,
    "per_page": 20
  }
}
```

--------------------------------

### Full authLinks.request implementation example

Source: https://docs.qonto.com/api-reference/sdk-libraries/variables/authLinks

A complete example showing the import, the request call with specific action constants, and logging the resulting URL.

```typescript
import { authLinks } from '@qonto/embed-sdk/auth-links';
import { AUTH_LINK_ACTIONS } from '@qonto/embed-sdk/constants';

const result = await authLinks.request({
  requestSettings: {
    action: AUTH_LINK_ACTIONS.DISPLAY_CARD,
  },
  operationSettings: {
    proxyEndpointDescriptor: {
      path: '/api/qonto-proxy',
      method: 'POST',
    },
  }
});

console.log('Auth link URL:', result.url);
// Use the URL to load the requested UI element (e.g., in an iframe, modal, or new window)
```

--------------------------------

### Test API Connection

Source: https://docs.qonto.com/get-started/general/troubleshooting

A simple GET request to the List Bank Accounts endpoint to verify your API setup.

```bash
GET /v2/bank_accounts
```

--------------------------------

### Install the SDK with npm

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/getting-started

Install the SDK using the npm package manager.

```bash
npm install @qonto/embed-sdk
```

--------------------------------

### Retrieve SEPA Direct Debit collection details

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/sepa-direct-debit/introduction

Example response structure when retrieving a collection by ID via a GET request to /v2/sepa/direct_debit_collections/{direct_debit_collection_id}.

```json
{
  "direct_debit_collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "direct_debit_subscription_id": "497f6eca-6276-4993-bfeb-53cbbbba6f09",
    "amount": { "value": "250.00", "currency": "EUR" },
    "collection_date": "2026-01-01",
    "status": "completed",
    "unique_mandate_reference": "UMR-..."
  }
}
```

--------------------------------

### Create a Registration Example

Source: https://docs.qonto.com/api-reference/onboarding-api/endpoints/registrations/create-a-registration

A sample request body for initiating a company creation registration flow.

```json
{
  "legal_flow": "company_creation",
  "locale": "en",
  "partner_redirect_url": "https://example.com/users/123456/dashboard",
  "partner_user": {
    "first_name": "John",
    "last_name": "Doe"
  }
}
```

--------------------------------

### GET /v2/transactions/{id}/child_transaction_links

Source: https://docs.qonto.com/api-reference/business-api/transactions-statements/transactions/list-child-transaction-links

Retrieves child transaction links for the transaction identified by the id path parameter. This is useful for drilling down into linked transactions such as DDC repayment installments or related fees.

```APIDOC
## GET /v2/transactions/{id}/child_transaction_links

### Description
Retrieves child transaction links for the transaction identified by the `id` path parameter. Use this endpoint to drill down into linked transactions, such as DDC repayment installment transactions or related fee transactions.

### Method
GET

### Endpoint
/v2/transactions/{id}/child_transaction_links

### Parameters
#### Path Parameters
- **id** (string) - Required - UUID of the parent transaction.

#### Query Parameters
- **link_types[]** (array) - Optional - Filter links by type (ddc_repayment, related_fee, merged_fee).
- **page** (string) - Optional - Returned page number.
- **per_page** (string) - Optional - Number of links per page.

### Response
#### Success Response (200)
- **links** (array) - List of child transaction links.
  - **link_type** (string) - Type of relationship (ddc_repayment, related_fee, merged_fee).
  - **related_transaction_id** (string) - UUID of the parent transaction for this link.
```

--------------------------------

### Install the SDK with yarn

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/getting-started

Install the SDK using the yarn package manager.

```bash
yarn add @qonto/embed-sdk
```

--------------------------------

### amountCurrency Example

Source: https://docs.qonto.com/api-reference/sdk-libraries/interfaces/SepaTransfer

Example value for the amountCurrency property.

```ts
'EUR'
```

--------------------------------

### Transaction Object Example

Source: https://docs.qonto.com/api-reference/business-api/transactions-statements/transactions/retrieve-a-transaction

An example of a transaction from an external account.

```yaml
Transaction from an external account.:
  id: 0191221f-258b-7bac-b83e-235fe00ff591
  transaction_id: cooperative-boulangere-sud-2161-4-transaction-191221-f2535
  amount: 11.99
  amount_cents: 1199
  settled_balance: null
  settled_balance_cents: null
  attachment_ids: []
  logo:
    small: https://qonto.com/customized-qonto-brand-logos/small.png
    medium: https://qonto.com/customized-qonto-brand-logos/medium.png
  local_amount: 11.99
  local_amount_cents: 1199
  side: debit
  operation_type: other
  currency: EUR
  local_currency: EUR
  label: Arcade Software Inc.
  clean_counterparty_name: Arcade Software
  settled_at: '2024-06-25T00:00:00.000Z'
  emitted_at: '2024-06-25T00:00:00.000Z'
  created_at: '2024-06-25T00:00:00.000Z'
  updated_at: '2024-08-05T10:39:12.181Z'
  status: completed
  note: null
  reference: null
  vat_amount: null
  vat_amount_cents: null
  vat_rate: null
  initiator_id: null
  label_ids: []
  attachment_lost: false
  attachment_required: true
  card_last_digits: null
  category: other_expense
  cashflow_category:
    id: 38f3c1d2-2c0a-4e2e-9d0a-1a3a4f5b6c7d
    name: Others
  cashflow_subcategory:
    id: 7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d
    name: Tips
  subject_type: Other
  bank_account_id: 0191221f-2452-735f-9144-bff2ca4fa8a4
  is_external_transaction: true
```

--------------------------------

### X-Qonto-Idempotency-Key Parameter Example

Source: https://docs.qonto.com/api-reference/business-api/expense-management/attachments-in-transactions/upload-an-attachment-to-a-transaction

Example value for the required X-Qonto-Idempotency-Key header used to ensure idempotent requests.

```yaml
example: 123e4567-e89b-12d3-a456-426614174000
```

--------------------------------

### InitializeParams

Source: https://docs.qonto.com/api-reference/sdk-libraries/-internal-/interfaces/InitializeParams

Configuration parameters for initializing the Qonto SDK.

```APIDOC
## InitializeParams

### Description
An object containing the parameters required to initialize the SDK.

### Properties
- **accessToken** (string) - Optional - The access token to authenticate the user, generated via OAuth.
- **branch** ("master" | "sandbox" | "qa") - Optional - Sets the SDK's branch when the environment is 'staging'. Defaults to 'MASTER'.
- **environment** ("production" | "staging" | "local") - Optional - Sets the SDK's environment. Defaults to 'production'.
- **locale** (string) - Optional - The locale to use for the SDK UI. Defaults to English.
- **operationSettings** (OperationSettings) - Optional - Additional operation settings.
- **stagingToken** (string) - Optional - Token required for accessing the staging environment.
```

--------------------------------

### Card Nickname Example

Source: https://docs.qonto.com/api-reference/business-api/cards/report-a-physical-card-as-lost

Example value for the card_nickname field.

```yaml
example: 💳 for 🍗
```

--------------------------------

### Initialize the SDK

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/getting-started

Initialize the SDK in your client-side code using an access token.

```ts
import { initialize } from '@qonto/embed-sdk/common';

const accessToken =
'An access token you have previously generated from your app';
initialize({ accessToken });
```

--------------------------------

### ForbiddenError Schema Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/organizations/retrieve-the-authenticated-organization-and-list-bank-accounts

Example object structure for a ForbiddenError.

```json
{
  "code": "forbidden",
  "detail": "User does not have sufficient permissions for this action."
}
```

--------------------------------

### Using SDK Constants

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/constants

Demonstrates how to import and use constants for SDK initialization and entity status verification.

```APIDOC
## SDK Constants Usage

### Description
The `constants` object provides access to configuration values and entity status identifiers required for interacting with the SDK.

### Usage
```ts
import { initialize, constants } from '@qonto/embed-sdk/common';
const { ENVIRONMENTS, LOCALES } = constants;

// Initialize SDK
initialize({
  environment: ENVIRONMENTS.STAGING,
  locale: LOCALES.FR,
});

// Check entity status
import { getSepaTransfer } from '@qonto/embed-sdk/sepa-transfers';
const { TRANSFER_STATUSES } = constants;

const transfer = await getSepaTransfer('transfer-id');
if (transfer.status === TRANSFER_STATUSES.PENDING) {
  console.log('Transfer is pending');
}
```
```

--------------------------------

### UnauthorizedError Schema Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/organizations/retrieve-the-authenticated-organization-and-list-bank-accounts

Example object structure for an UnauthorizedError.

```json
{
  "code": "unauthorized",
  "detail": "Invalid credentials"
}
```

--------------------------------

### initialize(initializeParams)

Source: https://docs.qonto.com/api-reference/sdk-libraries/variables/initialize

Initializes the SDK with the provided parameters. This is recommended for stateful environments to avoid passing repetitive parameters to subsequent SDK function calls.

```APIDOC
## initialize(initializeParams)

### Description
Initializes the SDK with the provided parameters. Calling this function is recommended in stateful environments to pass data to the SDK that would otherwise be required in every function call.

### Parameters
- **initializeParams** (Object) - Required - An object containing initialization settings:
  - **accessToken** (string) - Optional (Required in server-side) - The access token for user authentication.
  - **environment** (string) - Optional - The SDK environment (e.g., ENVIRONMENTS.PRODUCTION, ENVIRONMENTS.STAGING).
  - **branch** (string) - Optional - The branch to use when environment is set to STAGING (e.g., BRANCHES.MASTER, BRANCHES.SANDBOX, BRANCHES.QA).
  - **operationSettings** (Object) - Optional - Configuration for SDK operations.
  - **uiParentElementId** (string) - Optional - The ID of the DOM element where the SDK will render UI.
  - **mfaPreference** (string) - Optional - The MFA method to use (e.g., MFA_METHODS.PASSKEY, MFA_METHODS.PAIRED_DEVICE, MFA_METHODS.SMS_OTP).
  - **locale** (string) - Optional - 2-digit language code for UI text.

### Returns
- **void**

### Throws
- **InvalidParametersError** - Thrown if the access token is missing or parameters are invalid.

### Example
```ts
import { initialize } from '@qonto/embed-sdk/common';

const initializeParams = {
  accessToken: 'an-access-token',
};

initialize(initializeParams);
```
```

--------------------------------

### BadRequestError Schema Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/organizations/retrieve-the-authenticated-organization-and-list-bank-accounts

Example object structure for a BadRequestError.

```json
{
  "code": "bad_request",
  "detail": "Authorization field missing"
}
```

--------------------------------

### Registration Example: Qonto Invoicing

Source: https://docs.qonto.com/api-reference/onboarding-api/endpoints/registrations/create-a-registration

Example payload for creating a registration using the qonto_invoicing legal flow.

```yaml
    post-qf-example:
      value:
        legal_flow: qonto_invoicing
        locale: fr
        partner_redirect_url: https://example.com/users/123456/dashboard
        partner_user:
          first_name: Jean
          last_name: Dupont
          email: jean.dupont@example.com
        organization:
          legal_name: Acme France
          legal_number: '81948962600013'
          legal_country: FR
          address:
            line_1: 42 Rue Etienne Marcel
            postal_code: '75002'
            city: Paris
            country: FR
```

--------------------------------

### OpenAPI NotFoundError Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/business-accounts/close

Example of a not found error response.

```yaml
x-examples:
  Object not found:
    code: not_found
    detail: Object not found
    source:
      parameter: id
```

--------------------------------

### Example usage of getPaymentLinkCreationFlowUrl

Source: https://docs.qonto.com/api-reference/sdk-libraries/variables/paymentLinks

A standalone example showing the parameters required for getPaymentLinkCreationFlowUrl.

```ts
const url = await paymentLinks.getPaymentLinkCreationFlowUrl({
  paymentLinkSettings: {
    items: [{ id: '1', title: 'Item 1', type: 'service', quantity: 1, measureUnit: 'unit', unitPrice: { currency: 'EUR', value: '10' }, vatRate: '20' }],
    callbackUrl: 'https://example.com/callback',
  },
  operationSettings: { proxyEndpointDescriptor }
});
```

--------------------------------

### ForbiddenError Schema Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/memberships/retrieve-the-authenticated-membership

Example object for the ForbiddenError schema.

```yaml
x-examples:
  Insufficient permissions:
    code: forbidden
```

--------------------------------

### UnauthorizedError Schema Example

Source: https://docs.qonto.com/api-reference/business-api/accounts-organizations/memberships/retrieve-the-authenticated-membership

Example object for the UnauthorizedError schema.

```yaml
x-examples:
  Invalid credentials:
    code: unauthorized
    detail: Invalid credentials
```

--------------------------------

### Usage of displayCard with DisplayCardSettings

Source: https://docs.qonto.com/api-reference/sdk-libraries/-internal-/interfaces/DisplayCardSettings

Example showing how to invoke the displayCard function with a configuration object conforming to the DisplayCardSettings interface.

```ts
displayCard({
  cardId: '123',
  allowPinReveal: true,
  allowBlocking: false,
});
```
Tokens:
Raw