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

​
Variable: sepaTransfers

const sepaTransfers: object
The sepaTransfers namespace contains all the client-side functions related to SEPA transfer operations. This version uses proxy-based authentication (proxyRequestFunction or proxyEndpointDescriptor) and is designed for browser environments. For server-side operations using access tokens, import from ‘@qonto/embed-sdk/sepa-transfers/server’. 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({
  operationSettings: { proxyRequestFunction }
});
await sepaTransfers.getSepaTransfer({
  sepaTransferSettings: { sepaTransferId: '...' },
  operationSettings: { proxyRequestFunction }
});

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

​
Type declaration

​
bulkTransfers

bulkTransfers: object

​
bulkTransfers.createBulkTransfer()

createBulkTransfer: (params) => AsyncGenerator<SingleBulkVopVerificationResult[], undefined | CreateBulkTransferResponse>
Creates a new SEPA bulk transfer with Verification of Payee (VoP) checks. This function is only available in client-side (browser) environments as it requires UI interaction. Note: This function currently uses accessToken + iframe flow. Support for proxy-based flow is planned for a future update.
Parameters
params
CreateBulkTransferClientParams An object containing bulk transfer settings and operation settings.
Returns
AsyncGenerator<SingleBulkVopVerificationResult[], undefined | CreateBulkTransferResponse> As a yielded value, VoP check results for all unique beneficiaries. As the final return value, an object containing the created bulk transfer and metadata including the idempotency key.

​
bulkTransfers.getBulkTransfer()

getBulkTransfer: (params) => Promise<BulkTransfer>
Fetches a specific SEPA bulk transfer by its ID.
Parameters
params
BulkTransferClientParams<GetBulkTransfer> An object containing the bulkTransferId and operation settings with proxyRequestFunction or proxyEndpointDescriptor (required).
Returns
Promise<BulkTransfer> A promise that resolves to a BulkTransfer object.

​
bulkTransfers.getBulkTransfers()

getBulkTransfers: (getBulkTransfersParams?) => Promise<GetBulkTransfersResponse>
Fetches the list of SEPA bulk transfers for the current user.
Parameters
getBulkTransfersParams?
BulkTransferClientParams<never> An optional object containing operation settings with proxyRequestFunction or proxyEndpointDescriptor (required).
Returns
Promise<GetBulkTransfersResponse> A promise that resolves to an object containing an array of bulk transfers and a meta object containing pagination state.

​
cancelSepaTransfer()

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

​
Parameters

cancelSepaTransferParams
SepaTransferClientParams<CancelSepaTransferParams> An object containing:
  • sepaTransferSettings: An object with the sepaTransferId property (string).
  • operationSettings: An object with operation-level settings such as proxyRequestFunction or proxyEndpointDescriptor (required).

​
Returns

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

​
Throws

InvalidParametersError If the sepaTransferId parameter is missing, not a string, or if neither proxyRequestFunction nor proxyEndpointDescriptor is provided.

​
Throws

EmbedApiError If the API request fails or returns an error.

​
createSepaTransfer()

createSepaTransfer: (createTransferParams) => AsyncGenerator<VopVerificationResult, undefined | CreateSepaTransferResponse>
Creates a new SEPA transfer from the current user to a given beneficiary including a Verification of Payee (VoP) check first. If the VoP check is responded with an acceptance, and depending on the beneficiary’s trust status, this function will either create the transfer directly (if the beneficiary is trusted) via API or open the UI to complete the SCA process (if the beneficiary is not trusted). This function is only available in client-side (browser) environments as it may require UI interaction for SCA flows.

​
Parameters

createTransferParams
SepaTransferClientParams<NewSepaTransfer | BeneficiaryInformationForVop> An object with the parameters to create the transfer. See SepaTransferClientParams.

​
Returns

AsyncGenerator<VopVerificationResult, undefined | CreateSepaTransferResponse> As the first yielded value, a promise that resolves to the VoP check result. As the final return value, a promise that resolves to an object containing the created SEPA transfer and metadata including the idempotency key.

​
Throws

InvalidParametersError If required parameters are missing or invalid.

​
Throws

InvalidRuntimeError If a transfer for an untrusted beneficiary is attempted in a non-browser environment.

​
Throws

EmbedApiError If the API request fails or returns an error.

​
getSepaTransfer()

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

​
Parameters

getSepaTransferParams
SepaTransferClientParams<GetSepaTransfer> An object containing:
  • sepaTransferSettings: An object with the sepaTransferId property (string).
  • operationSettings: An object with operation-level settings such as proxyRequestFunction or proxyEndpointDescriptor (required).

​
Returns

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

​
Throws

InvalidParametersError If the sepaTransferId parameter is not a string, missing, or if neither proxyRequestFunction nor proxyEndpointDescriptor is provided.

​
Throws

EmbedApiError If the API request fails or returns an error.
getSepaTransferCreationFlowLink: (getSepaTransferCreationFlowLinkParams) => Promise<AuthLinkRequestResult>
Generates an authentication link to start the SEPA transfer creation flow as a hosted page. This flow will allow users to create a SEPA transfer from a Qonto hosted page.

​
Parameters

getSepaTransferCreationFlowLinkParams
SepaTransferClientParams<SepaTransferCreationFlowRequest> An object containing:
  • sepaTransferSettings: An object with the callbackUrl property.
  • operationSettings: An object with operation-level settings such as proxyRequestFunction or proxyEndpointDescriptor (required).

​
Returns

Promise<AuthLinkRequestResult> A promise that resolves to an object representing the Embed Auth Link.

​
Throws

InvalidParametersError If the callbackUrl is invalid or missing, or if neither proxyRequestFunction nor proxyEndpointDescriptor is provided.

​
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?
SepaTransferClientParams<never> An object containing:
  • operationSettings: An object with operation-level settings such as proxyRequestFunction or proxyEndpointDescriptor (required), paginationSettings, and other optional parameters.

​
Returns

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

​
Throws

InvalidParametersError If neither proxyRequestFunction nor proxyEndpointDescriptor is provided.

​
Throws

EmbedApiError If the API request fails or returns an error.