@qonto/embed-sdk / sepaTransfers

​
Variable: sepaTransfers

const sepaTransfers: object = sepaTransfersNamespace.sepaTransfers
The sepaTransfers namespace contains all the functions related to SEPA transfer operations, including both single and bulk transfers. It can be accessed like this: 
import { sepaTransfers } from '@qonto/embed-sdk/sepa-transfers';
Then, the sepaTransfers object contains the functions to perform SEPA transfer operations: 
// Single SEPA transfers
await sepaTransfers.getSepaTransfers();
await sepaTransfers.getSepaTransfer({ sepaTransferId: '...' });

// Bulk transfers are nested under sepaTransfers.bulkTransfers
const { bulkTransfers } = sepaTransfers;
await bulkTransfers.getBulkTransfers();

// Or access bulk transfers directly
await sepaTransfers.bulkTransfers.getBulkTransfers();
await sepaTransfers.bulkTransfers.getBulkTransfer({ bulkTransferId: '...' });

​
Type declaration

​
bulkTransfers

bulkTransfers: object

​
bulkTransfers.createBulkTransfer()

createBulkTransfer: (params) => Promise<BulkTransfer>
Creates a new SEPA bulk transfer from the current user to one or more beneficiaries. Depending on the beneficiaries’ trust status, this function may either create the bulk transfer directly via the API or open the UI to complete the SCA process for untrusted beneficiaries.
Parameters
params
BulkTransferParams<NewBulkTransfer> An object containing the settings for the bulk transfer, including:
  • bulkTransferSettings: An object that contains the mandatory bankAccountId and an array of bulkTransfers.
  • operationSettings: An object with operation-level settings such as accessToken, stagingToken, and other optional parameters. See BulkTransferParams. If the transfer needs to be created for an untrusted beneficiary, the operationSettings object must also include the uiParentElementId property. This has to specify the ID of the DOM element where the UI for MFA will be displayed. Note that this means that creating transfers for untrusted beneficiaries can only happen in the client side. The createBulkTransfer function requires an idempotencyKey as well. If this property is not passed as part of operationSettings, a new one will be generated automatically. You can also specify an mfaPreference in the operationSettings to choose the multi-factor authentication method to use for the SCA flow (e.g., ‘passkey’, ‘sms-otp’, or ‘paired-device’). If not provided, the default MFA method will be used.
Returns
Promise<BulkTransfer> A promise that resolves to a BulkTransfer object containing details of the created bulk transfer.
Throws
AuthenticationError If the access token is invalid or missing. Ensure initialize has been called before using this function if you are not passing the access token.
Throws
InvalidParametersError If the transfer parameter is not an object or is missing, or if the required properties of the transfer object are missing or invalid. Also thrown if uiParentElementId is not provided in the operationSettings, which is required for the iframe flow.
Throws
EmbedApiError If the API request fails or returns an error.
Throws
InvalidRuntimeError If the function is called in a non-browser environment. This operation can only be performed from a browser since it requires an iframe.

​
bulkTransfers.getBulkTransfer()

getBulkTransfer: (params) => Promise<BulkTransfer>
Fetches a specific SEPA bulk transfer by its ID.
Parameters
params
SepaTransferParams<GetBulkTransfer> An object containing:
  • sepaTransferSettings: An object that contains the mandatory bulkTransferId to identify the bulk transfer to retrieve.
  • operationSettings: An object with operation-level settings such as accessToken, stagingToken, and other optional parameters. See SepaTransferParams.
Returns
Promise<BulkTransfer> A promise that resolves to a BulkTransfer object containing details of the requested bulk transfer.
Throws
AuthenticationError If the access token is invalid or missing.
Throws
ValidationError If the provided parameters fail validation. Ensure initialize has been called before using this function if you are not passing the access token.
Throws
InvalidParametersError If the bulkTransferId parameter is not a string or missing.
Throws
EmbedApiError If the API request fails or returns an error.

​
bulkTransfers.getBulkTransfers()

getBulkTransfers: (getBulkTransfersParams?) => Promise<GetBulkTransfersResponse>
Fetches the list of SEPA bulk transfers for the current user.
Parameters
getBulkTransfersParams?
SepaTransferParams<never> An optional object containing operationSettings. The operationSettings object can include:
  • accessToken: If not provided, the function will use the token from initialize.
  • stagingToken: Optional, required only for staging environments.
  • paginationSettings: Optional object with page and itemsPerPage properties for pagination control.
Returns
Promise<GetBulkTransfersResponse> A promise that resolves to an object containing an array of bulk transfers and a meta object containing pagination state.
Throws
AuthenticationError If the access token is invalid or missing.
Throws
ValidationError If the provided parameters fail validation. Ensure initialize has been called before using this function if you are not passing the access token.
Throws
EmbedApiError If the API request fails or returns an error.

​
cancelSepaTransfer()

cancelSepaTransfer: (cancelSepaTransferParams) => Promise<void>
Cancels an existing SEPA transfer identified by the provided sepaTransferId.

​
Parameters

cancelSepaTransferParams
SepaTransferParams<CancelSepaTransferParams> An object with the parameters to cancel the transfer. If it was not provided when calling the SDK’s initialize function, an operationSettings object has to be passed too with the accessToken and stagingToken values.

​
Returns

Promise<void> A promise that resolves without return value.

​
Throws

AuthenticationError If the access token is invalid or missing. Ensure initialize has been called before using this function if you are not passing the access token.

​
Throws

InvalidParametersError If the sepaTransferId parameter is missing, or if the provided value is not a string.

​
Throws

EmbedApiError If the API request fails or returns an error.

​
createSepaTransfer()

createSepaTransfer: (createTransferParams) => Promise<SepaTransfer>
Creates a new SEPA transfer from the current user to a given beneficiary. Depending on the beneficiary’s trust status, this function will either create the transfer directly via API or open the UI to complete the SCA process.

​
Parameters

createTransferParams
SepaTransferParams<NewSepaTransfer> An object with the parameters to create the transfer. If it was not provided when calling the SDK’s initialize function, an operationSettings object has to be passed too with the accessToken and stagingToken values. If the transfer needs to be created for an untrusted beneficiary, the operationSettings object must also include the uiParentElementId property. This has to specify the ID of the DOM element where the UI for MFA will be displayed. Note that this means that creating transfers for untrusted beneficiaries can only happen in the client side. The createSepaTransfer function requires an idempotencyKey as well. If this property is not passed as part of operationSettings, a new one will be generated automatically. You can also specify an mfaPreference in the operationSettings to choose the multi-factor authentication method to use for the SCA flow (e.g., ‘passkey’, ‘sms-otp’, or ‘paired-device’). If not provided, the default MFA method will be used.

​
Returns

Promise<SepaTransfer> A promise that resolves to the created SEPA transfer.

​
Throws

AuthenticationError If the access token is invalid or missing. Ensure initialize has been called before using this function if you are not passing the access token.

​
Throws

InvalidParametersError If the transfer parameter is not an object or is missing, or if the required properties of the transfer object are missing or invalid.

​
Throws

EmbedApiError If the API request fails or returns an error.

​
Throws

InvalidRuntimeError If a transfer for an untrusted beneficiary is attempted to be created in the server. This scenario requires to be performed from a browser.

​
getSepaTransfer()

getSepaTransfer: (Object) => Promise<SepaTransfer>
Fetches a single SEPA transfer of the current user by ID.

​
Parameters

Object
SepaTransferParams<GetSepaTransfer> An object with the sepaTransferId and the optional accessToken and stagingToken properties.

​
Returns

Promise<SepaTransfer> A promise that resolves to a SEPA transfer.

​
Throws

AuthenticationError If the access token is invalid or missing. Ensure initialize has been called before using this function if you are not passing the access token.

​
Throws

InvalidParametersError If the sepaTransferId parameter is not a string or is missing.

​
Throws

EmbedApiError If the API request fails or returns an error.

​
getSepaTransfers()

getSepaTransfers: (getSepaTransfersParams?) => Promise<GetSepaTransfersResponse>
Fetches the list of SEPA transfers for the current user.

​
Parameters

getSepaTransfersParams?
SepaTransferParams<never> An optional object containing accessToken and stagingToken parameters. If the accessToken is not provided, the function will use the token previously passed to the initialize function. The stagingToken is optional, but it has to be passed to use the SDK in staging environments (it will be ignored in production). This function also allows managing pagination by passing the paginationSettings property, which accepts an object with the page and itemsPerPage properties.

​
Returns

Promise<GetSepaTransfersResponse> A promise that resolves to an object containing an array of SEPA transfers and a meta object containing pagination state.

​
Throws

AuthenticationError If the access token is invalid or missing. Ensure initialize has been called before using this function if you are not passing the access token.

​
Throws

EmbedApiError If the API request fails or returns an error.