Skip to main content
@qonto/embed-sdk / organizations

Variable: organizations

const organizations: object = organizationsNamespace.organizations
The organizations namespace contains all the functions related to organizations’ operations such as retrieving bank accounts. It can be accessed like this:
import { organizations } from '@qonto/embed-sdk/organizations';
await organizations.getBankAccounts({accessToken, stagingToken});

Type declaration

getBankAccounts()

getBankAccounts: (operationSettings) => Promise<BankAccount[]>
Retrieves the bank accounts for the organization.

Parameters

operationSettings
OperationSettings An object with operation-level settings such as proxyRequestFunction (preferred over using the access token flow), accessToken, stagingToken, and other optional parameters. See OperationSettings.

Returns

Promise<BankAccount[]> A promise that resolves to the bank accounts for the organization.

Throws

AuthenticationError If both the proxyRequestFunction and accessToken are invalid or missing within operationSettings.

Throws

EmbedApiError If the API request fails or returns an error.

getOrganization()

getOrganization: (operationSettings) => Promise<Organization>
Retrieves the organization information.

Parameters

operationSettings
OperationSettings An object with operation-level settings such as proxyRequestFunction (preferred over using the access token flow), accessToken, stagingToken, and other optional parameters. See OperationSettings.

Returns

Promise<Organization> A promise that resolves to the organization the current user belongs to.

Throws

AuthenticationError If both the proxyRequestFunction and accessToken are invalid or missing within operationSettings.

Throws

EmbedApiError If the API request fails or returns an error.