### Example response for e-invoicing settings (JSON)

Source: https://docs.qonto.com/api-reference/business-api/expense-management/e-invoicing/retrieve-settings

This JSON object shows an example response when retrieving e-invoicing settings. It includes the sending and receiving status of e-invoicing for the organization.

```JSON
{
  "sending_status": "enabled",
  "receiving_status": "enabled"
}
```

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

### Qonto API List Transactions Example

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

Demonstrates a GET request to the Qonto API to retrieve transactions, including query parameters for pagination and filtering. The response shows the structure of the transaction list and meta information for pagination.

```http
GET https://thirdparty.qonto.com/v2/transactions?iban=FR7616798000010000004321396&per_page=20&page=2
```

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

### Install Qonto Embed SDK using npm

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

Installs the Qonto Embed SDK using the npm package manager. This is the first step to integrate Qonto banking features into your web application.

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

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

### Install Qonto Embed SDK using pnpm

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

Installs the Qonto Embed SDK using the pnpm package manager. This command is an alternative to npm for managing project dependencies.

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

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

### Example of Client Email

Source: https://docs.qonto.com/api-reference/business-api/clients/update-a-client

Provides an example of the email format for a client in the Qonto API.

```JSON
"john.doe@qonto.com"
```

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

### Install Qonto Embed SDK using yarn

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

Installs the Qonto Embed SDK using the yarn package manager. This command is another alternative for dependency management in JavaScript projects.

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

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

### Example HTTP Headers for Signing

Source: https://docs.qonto.com/get-started/business-api/authentication/qsealc

This example shows the HTTP headers that need to be included when computing the signature. It includes the Digest, Date, Content-Type, Content-Length, and various PSU-prefixed headers.

```http
Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=
Date: Fri, 16 Dec 2022 15:01:13 GMT
Content-Type: application/json
Content-Length: 0
PSU-Date: Fri, 16 Dec 2022 15:01:13 GMT

```

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

### Qonto API Authentication cURL Example

Source: https://docs.qonto.com/get-started/business-api/authentication/api-key

This example demonstrates how to make a cURL request to the Qonto API, including the authentication header with specific login and secret key values.

```bash
curl --location --globoff 'https://thirdparty.qonto.com/v2/organization' \
--header 'Authorization: pied-piper-7132:62885d39f3a0ddedd3d3ee0432a43ccr'
```

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

### Set up Postman for Qonto Sandbox

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

This snippet details the steps to set up Postman for interacting with the Qonto Sandbox environment. It involves forking a Postman collection and selecting the appropriate environment.

```Postman
1. Fork our **Postman collection and environments**
2. On your workspace, select the ‘Qonto Sandbox’ environment.
```

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

### Example JSON Response for Get Payment Link

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/payment-links/show

This is an example of the JSON response received when successfully retrieving a payment link. It includes details such as ID, status, expiration date, amount, items, and the payment link URL.

```JSON
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "expiration_date": "2021-01-01T00:00:00Z",
  "potential_payment_methods": [
    "credit_card"
  ],
  "amount": {
    "value": "13.30",
    "currency": "EUR"
  },
  "items": [
    {
      "title": "Item 1",
      "type": "good",
      "description": "Item 1 description",
      "quantity": 1,
      "measure_unit": "unit",
      "unit_price": {
        "value": "10.99",
        "currency": "EUR"
      },
      "vat_rate": "21.0"
    }
  ],
  "reusable": true,
  "created_at": "2021-01-01T00:00:00Z",
  "url": "https://pay.qonto.com/019788b3-57ab-727c-b26e-86b95c16e93f?resource_id=4c56f862-6117-4b20-a3e3-7fa6fccea029"
}
```

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

### Initiate Qonto Registration

Source: https://docs.qonto.com/get-started/onboarding-api/flows/existing-company

This snippet demonstrates how to initiate the company registration process by calling the Create a registration endpoint. It's the first step for a company to open a Qonto account.

```HTTP
POST /v2/registrations
```

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

### Example Response for Connection Status

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/payment-links/get-connection

This is an example of the JSON response received when checking the connection status. It includes the connection location, status, and bank account ID.

```JSON
{
  "connection_location": "<string>",
  "status": "not_connected",
  "bank_account_id": "46e9e0d2-f1af-4d2e-a6be-a536a604b89e"
}
```

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

### Initialize Qonto Embed SDK

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

Initializes the Qonto Embed SDK with an access token. This is a required step for client-side usage before interacting with Qonto's banking features.

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

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

```

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

### SEPA Transfer Response Example

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/sepa-transfers/sepa-transfers/show

This is an example of a successful JSON response when retrieving SEPA transfer details. It includes various attributes of the transfer such as ID, amount, status, and timestamps.

```json
{
  "transfer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "initiator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 1100.5,
    "amount_cents": 110050,
    "amount_currency": "EUR",
    "status": "pending",
    "beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "Lease payment",
    "note": "Lease payment for offices in Paris",
    "declined_reason": "beneficiary_bic_invalid",
    "scheduled_date": "2023-12-25",
    "created_at": "2025-04-22T12:00:00Z",
    "updated_at": "2025-04-22T12:00:00Z",
    "processed_at": "2025-04-22T12:00:00Z",
    "completed_at": "2025-04-22T12:00:00Z",
    "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recurring_transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
```

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

### Initialize SDK for Staging Environment with MFA UI Element

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

Shows how to initialize the SDK for a staging environment, specifically targeting the sandbox branch, and configuring a DOM element for rendering MFA UI.

```javascript
import { initialize, constants } from '@qonto/embed-sdk/common';

const initializeParams = {
  accessToken: 'an-access-token',
  environment: constants.ENVIRONMENTS.STAGING,
  operationSettings: {
    uiParentElementId: 'mfa-container',
  },
};
initialize(initializeParams);
```

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

### Update International Beneficiary

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/international-transfers/introduction

Update the details of an existing international beneficiary. This is necessary if additional information was collected after the initial setup.

```HTTP
PUT /v2/international/beneficiaries/{beneficiaryId}
```

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

### Check International Beneficiary Requirements

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/international-transfers/introduction

Determine the specific information required to complete a beneficiary setup for international transfers. This ensures compliance with country-specific regulations.

```HTTP
POST /v2/international/beneficiaries/requirements
```

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

### Initialize SDK with Access Token

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

Demonstrates the simplest way to initialize the Qonto Embed SDK by providing only the required access token.

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

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

initialize(initializeParams);
```

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

### Retrieve Organization and Bank Accounts

Source: https://docs.qonto.com/faq-articles/api-questions/api-questions-reference

Retrieves organization details and lists all bank accounts. This is a starting point to get bank account IDs/IBANs needed for transaction retrieval.

```HTTP
GET /v2/organization
```

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

### Create Registration Endpoint

Source: https://docs.qonto.com/get-started/onboarding-api/flows/company-creation

Initiates the company registration process by calling the Create a registration endpoint. This is the first step before uploading documents or redirecting the customer.

```HTTP
POST /registrations
```

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

### Example Business Account Response

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

This JSON object represents a successful response when retrieving business account details. It includes information such as account ID, name, status, balance, and currency.

```JSON
{
  "bank_account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Primary bank account",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "active",
    "main": true,
    "iban": "FR7610004000000112345678901",
    "bic": "BNPAFRPPXXX",
    "currency": "EUR",
    "balance": 142188.43,
    "balance_cents": 14218843,
    "authorized_balance": 141148.12,
    "authorized_balance_cents": 14114812,
    "updated_at": "2024-04-03T12:00:00Z",
    "is_external_account": false,
    "account_number": 1234567890
  }
}
```

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

### API Response for Currencies (JSON)

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/international-transfers/list-available-currencies

This is an example of the JSON response received from the Qonto API when requesting available currencies. It lists currencies with their codes, associated country codes, and a suggestion priority.

```JSON
{
  "currencies": [
    {
      "currency_code": "EUR",
      "country_code": "FR",
      "suggestion_priority": 1
    }
  ]
}
```

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

### List Qonto Transactions

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

Retrieve a list of transactions for a given bank account. This requires calling two endpoints: first to get the organization and bank accounts, then to list the transactions using the account ID or IBAN.

```HTTP
GET https://thirdparty.qonto.com/v2/organization
GET https://thirdparty.qonto.com/v2/transactions
```

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

### Initiate OAuth Flow with Qonto

Source: https://docs.qonto.com/get-started/business-api/authentication/oauth/login-endpoint

This example demonstrates how to construct the URL to initiate the OAuth 2.0 authentication flow with Qonto. It includes essential query parameters like client ID, redirect URI, response type, scopes, and state.

```bash
https://oauth.qonto.com/oauth2/auth? \
  client_id=my-company-name-v1& \
  redirect_uri=https%3A%2F%2Fmy-company-server.com%2F& \
  response_type=code& \
  scope=organization.read%20offline_access%20attachment.write%20internal_transfer.write& \
  state=123456789
```

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

### Initialize Qonto SDK with Constants

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

Demonstrates how to initialize the Qonto Embed SDK using constants for environment and locale settings. It imports the necessary functions and constants from the SDK.

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

initialize({
  environment: ENVIRONMENTS.STAGING,
  locale: LOCALES.FR,
});
```

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

### Order a Card using Qonto Embed SDK

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

Demonstrates how to order a new card using the 'cards' namespace of the Qonto Embed SDK. This function requires a 'cardConfig' object.

```javascript
import { cards } from '@qonto/embed-sdk/cards';

const newCard = cards.orderCard(cardConfig);

```

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

### Card Operations using Qonto Embed SDK

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

Shows examples of performing various card operations using the 'cards' object from the Qonto Embed SDK, including displaying, getting, ordering, and unlocking cards.

```javascript
await cards.displayCard(/* params here */);
await cards.getCards();
await cards.orderCard(/* params here */);
await cards.unlockCard(/* params here */);
```

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

### Update SEPA Beneficiary using Qonto SDK

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/proxy-endpoint-implementation

This JavaScript code snippet shows how to use the Qonto Embed SDK to update a SEPA beneficiary. After the SDK is initialized with the proxy function, this example calls the `updateSepaBeneficiary` method with the beneficiary's ID and new data, then logs the response.

```JavaScript
import { beneficiaries } from '@qonto/embed-sdk/beneficiaries';

const response = await beneficiaries.updateSepaBeneficiary({
  beneficiaryId: 'beneficiary-id',
  data: {
    name: 'New Name',
    email: 'the-new-email@example.com',
  },
});

console.log('Beneficiary updated:', response);

```

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

### Send Qonto Redirection Link

Source: https://docs.qonto.com/get-started/onboarding-api/flows/existing-company

This snippet illustrates how to send a redirection link to the account owner, facilitating the customer's completion of the registration flow on the Qonto platform.

```HTTP
POST /v2/registrations/{registration_id}/send_redirection_link
```

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

### Get SEPA Transfer Details

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/sepa-transfers/sepa-transfers/show

This snippet shows how to retrieve a specific SEPA transfer by its ID using a GET request to the Qonto API. It requires an Authorization header with a Bearer token.

```curl
curl --request GET \
  --url https://thirdparty.qonto.com/v2/sepa/transfers/{id} \
  --header 'Authorization: Bearer <token>'
```

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

### Sample JSON Response for Registrations

Source: https://docs.qonto.com/api-reference/onboarding-api/endpoints/registrations/list-company-creation-registrations

This is a sample JSON response from the Qonto API when listing company creation registrations. It includes details about the registration, organization, and stakeholders.

```JSON
{
  "registrations": [
    {
      "id": "a584b060-8c96-488d-8bbb-74f0d3d2803c",
      "legal_flow": "company_creation",
      "flow": {
        "type": "seamless",
        "breakdown": [
          {
            "code": "<string>",
            "detail": "<string>",
            "source": {
              "pointer": "<string>"
            }
          }
        ]
      },
      "status": "pending",
      "redirection_link": "https://xyz.qonto.com/registrations/ID",
      "partner_redirect_url": "https://example.com/users/123456/dashboard",
      "created_at": "2021-08-17T12:31:32.689Z",
      "updated_at": "2021-08-17T14:00:00.689Z",
      "locale": "fr",
      "partner_user": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "example-partner-user@qonto.com"
      },
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entity_type": "company",
        "legal_name": "Olinda",
        "legal_form": "SAS",
        "legal_number": "<string>",
        "legal_sector": "K.64.11",
        "legal_registration_date": "2023-12-25",
        "legal_vat_number": "<string>",
        "address": {
          "line_1": "Rue La Fayette 20B",
          "line_2": "Room 5",
          "postal_code": "75009",
          "city": "Paris",
          "country": "FR"
        },
        "total_capital_amount": {
          "value": "1023.43",
          "currency": "EUR"
        }
      },
      "stakeholders": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "capital_amount": {
            "value": "1023.43",
            "currency": "EUR"
          },
          "is_owner": true,
          "first_name": "Leeroy",
          "last_name": "Jenkins",
          "email": "leeroy.jenkins@qonto.com",
          "gender": "male",
          "phone_number": "0033123456789",
          "nationality": "FR",
          "birth_date": "2021-08-17T12:31:32.689Z",
          "birth_address": {
            "postal_code": "75009",
            "city": "Paris",
            "country": "FR"
          },
          "residence_address": {
            "line_1": "Rue La Fayette 20B",
            "postal_code": "75009",
            "city": "Paris",
            "country": "FR"
          },
          "shareholding_type": "physical",
          "legal_entities": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "legal_name": "Olinda",
              "legal_number": 123456789,
              "legal_country": "FR",
              "capital_amount": "1023.43"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "total_pages": 2,
    "total_count": 27,
    "per_page": 25
  }
}
```

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

### Get Available Currencies (cURL)

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/international-transfers/list-available-currencies

This snippet demonstrates how to make a GET request to the Qonto API to retrieve a list of supported currencies for international transfers. It requires an Authorization header with a Bearer token.

```cURL
curl --request GET \
  --url https://thirdparty.qonto.com/v2/international/currencies \
  --header 'Authorization: Bearer <token>'
```

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

### Configure Qonto SDK with Proxy Function

Source: https://docs.qonto.com/api-reference/sdk-libraries/doc-pages/proxy-endpoint-implementation

This JavaScript code demonstrates how to configure the Qonto Embed SDK on the client-side to use the previously created intermediary endpoint. It passes a `proxyRequestFunction` to the `initialize` method of the SDK, which handles making POST requests to the backend endpoint and returning the response text.

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

initialize({
  operationSettings: {
    proxyRequestFunction: async (payload: string) => {
      // Call our newly created intermediary endpoint
      const response = await fetch('/api/embed-intermediary', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
        },
        // Include the payload in the body without any modification
        body: payload,
      });
      // The response comes as plain text from our intermediary endpoint implementation,
      // so we return the response text directly. The SDK will receive it and be able
      // to decode it and use it as needed.
      return await response.text();
    },
  },
});

```

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

### Sample JSON Response for Listing Clients

Source: https://docs.qonto.com/api-reference/business-api/clients/list-clients

This is an example of the JSON response received when listing clients from the Qonto API. It includes a list of clients with their details and pagination information.

```json
{
  "clients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "+33123456789",
      "phone": {
        "country_code": "+33",
        "number": "123456789"
      },
      "type": "company",
      "email": "john.doe@qonto.eu",
      "extra_emails": [
        "additional@email.com",
        "backup@email.com"
      ],
      "currency": "EUR",
      "e_invoicing_address": "1234567890",
      "vat_number": "<string>",
      "tax_identification_number": "<string>",
      "address": "<string>",
      "city": "<string>",
      "zip_code": "<string>",
      "province_code": "<string>",
      "country_code": "<string>",
      "billing_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "province_code": "<string>",
        "country_code": "fr"
      },
      "delivery_address": {
        "street_address": "123 Main Street",
        "city": "Paris",
        "zip_code": "75009",
        "province_code": "<string>",
        "country_code": "fr"
      },
      "recipient_code": "<string>",
      "created_at": "<string>",
      "locale": "fr"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 11,
    "total_count": 210,
    "per_page": 20
  }
}
```

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

### Create File via cURL

Source: https://docs.qonto.com/api-reference/onboarding-api/endpoints/files/create-a-file

This snippet demonstrates how to create a file using a cURL command. It includes the necessary POST request to the Qonto API endpoint, specifying headers for authorization and content type, and form data for file type, stakeholder ID, and the file itself.

```cURL
curl --request POST \
  --url https://thirdparty-sandbox.staging.qonto.co/register/registrations/{registrationId}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'Qonto-Partner-Id: <api-key>' \
  --header 'X-Qonto-Staging-Token: <api-key>' \
  --form file_type=organization-deposit-certificate \
  --form stakeholder_id=a3818b4d-4240-4098-bae4-87124b5add31 \
  --form file=@example-file
```

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

### Get Bulk Transfer Status (cURL)

Source: https://docs.qonto.com/api-reference/business-api/payments-transfers/sepa-transfers/sepa-bulk-transfers/show

This snippet shows how to make a GET request to the Qonto API to retrieve the status of a specific bulk transfer. It requires an authorization token in the header and the bulk transfer's unique ID in the URL path.

```cURL
curl --request GET \
  --url https://thirdparty.qonto.com/v2/sepa/bulk_transfers/{id} \
  --header 'Authorization: Bearer <token>'
```