> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qonto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SepaTransfers

[@qonto/embed-sdk](../README) / 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 (proxyEndpointDescriptor)
and is designed for browser environments.

For server-side operations using access tokens, import from '@qonto/embed-sdk/server/sepa-transfers'.

It can be accessed like this:

```ts theme={null}
import { sepaTransfers } from '@qonto/embed-sdk/sepa-transfers';
```

Then, the sepaTransfers object contains the functions to perform SEPA transfer operations:

```ts theme={null}
// Single SEPA transfers
await sepaTransfers.getSepaTransfers({
  operationSettings: { proxyEndpointDescriptor }
});
await sepaTransfers.getSepaTransfer({
  sepaTransferSettings: { sepaTransferId: '...' },
  operationSettings: { proxyEndpointDescriptor }
});

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

## Type declaration

### bulkTransfers

> **bulkTransfers**: `object`

#### bulkTransfers.createBulkTransfer()

> **createBulkTransfer**: (`params`) => `AsyncGenerator`\<[`SingleBulkVopVerificationResult`](../-internal-/interfaces/SingleBulkVopVerificationResult)\[], `undefined` | [`CreateBulkTransferResponse`](../-internal-/interfaces/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.

##### Parameters

###### params

[`CreateBulkTransferClientParams`](../-internal-/interfaces/CreateBulkTransferClientParams)

An object containing bulk transfer settings and operation settings with
proxyEndpointDescriptor (required).

##### Returns

`AsyncGenerator`\<[`SingleBulkVopVerificationResult`](../-internal-/interfaces/SingleBulkVopVerificationResult)\[], `undefined` | [`CreateBulkTransferResponse`](../-internal-/interfaces/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`](../-internal-/interfaces/BulkTransfer)>

Fetches a specific SEPA bulk transfer by its ID.

##### Parameters

###### params

[`BulkTransferClientParams`](../-internal-/interfaces/BulkTransferClientParams)\<[`GetBulkTransfer`](../-internal-/interfaces/GetBulkTransfer)>

An object containing the bulkTransferId and operation settings with
proxyEndpointDescriptor (required).

##### Returns

`Promise`\<[`BulkTransfer`](../-internal-/interfaces/BulkTransfer)>

A promise that resolves to a BulkTransfer object.

#### bulkTransfers.getBulkTransfers()

> **getBulkTransfers**: (`getBulkTransfersParams?`) => `Promise`\<[`GetBulkTransfersResponse`](../-internal-/interfaces/GetBulkTransfersResponse)>

Fetches the list of SEPA bulk transfers for the current user.

##### Parameters

###### getBulkTransfersParams?

[`BulkTransferClientParams`](../-internal-/interfaces/BulkTransferClientParams)\<`never`>

An optional object containing operation settings with
proxyEndpointDescriptor (required).

##### Returns

`Promise`\<[`GetBulkTransfersResponse`](../-internal-/interfaces/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`](../-internal-/interfaces/SepaTransferClientParams)\<[`CancelSepaTransferParams`](../-internal-/interfaces/CancelSepaTransferParams)>

An object containing:

* `sepaTransferSettings`: An object with the `sepaTransferId` property (string).
* `operationSettings`: An object with operation-level settings such as
  `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 proxyEndpointDescriptor is not provided.

#### Throws

`EmbedApiError` If the API request fails or returns an error.

### createSepaTransfer()

> **createSepaTransfer**: (`createTransferParams`) => `AsyncGenerator`\<[`VopVerificationResult`](../-internal-/interfaces/VopVerificationResult), `undefined` | [`CreateSepaTransferResponse`](../-internal-/interfaces/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`](../-internal-/interfaces/SepaTransferClientParams)\<[`NewSepaTransfer`](../-internal-/interfaces/NewSepaTransfer) | [`BeneficiaryInformationForVop`](../-internal-/type-aliases/BeneficiaryInformationForVop)>

An object with the parameters to create the
transfer. See [SepaTransferClientParams](../-internal-/interfaces/SepaTransferClientParams).

#### Returns

`AsyncGenerator`\<[`VopVerificationResult`](../-internal-/interfaces/VopVerificationResult), `undefined` | [`CreateSepaTransferResponse`](../-internal-/interfaces/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`](../interfaces/SepaTransfer)>

Fetches a single SEPA transfer of the current user by ID.

#### Parameters

##### getSepaTransferParams

[`SepaTransferClientParams`](../-internal-/interfaces/SepaTransferClientParams)\<[`GetSepaTransfer`](../-internal-/interfaces/GetSepaTransfer)>

An object containing:

* `sepaTransferSettings`: An object with the `sepaTransferId` property (string).
* `operationSettings`: An object with operation-level settings such as
  `proxyEndpointDescriptor` (required).

#### Returns

`Promise`\<[`SepaTransfer`](../interfaces/SepaTransfer)>

A promise that resolves to a SEPA transfer.

#### Throws

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

#### Throws

`EmbedApiError` If the API request fails or returns an error.

### getSepaTransferCreationFlowLink()

> **getSepaTransferCreationFlowLink**: (`getSepaTransferCreationFlowLinkParams`) => `Promise`\<[`AuthLinkRequestResult`](../interfaces/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`](../-internal-/interfaces/SepaTransferClientParams)\<[`SepaTransferCreationFlowRequest`](../-internal-/type-aliases/SepaTransferCreationFlowRequest)>

An object containing:

* `sepaTransferSettings`: An object with the `callbackUrl` property.
* `operationSettings`: An object with operation-level settings such as
  `proxyEndpointDescriptor` (required).

#### Returns

`Promise`\<[`AuthLinkRequestResult`](../interfaces/AuthLinkRequestResult)>

A promise that resolves to an object representing the Embed Auth Link.

#### Throws

`InvalidParametersError` If the callbackUrl is invalid or missing, or if
proxyEndpointDescriptor is not provided.

#### Throws

`EmbedApiError` If the API request fails or returns an error.

### getSepaTransfers()

> **getSepaTransfers**: (`getSepaTransfersParams?`) => `Promise`\<[`GetSepaTransfersResponse`](../-internal-/interfaces/GetSepaTransfersResponse)>

Fetches the list of SEPA transfers for the current user.

#### Parameters

##### getSepaTransfersParams?

[`SepaTransferClientParams`](../-internal-/interfaces/SepaTransferClientParams)\<`never`>

An object containing:

* `operationSettings`: An object with operation-level settings such as
  `proxyEndpointDescriptor` (required),
  `paginationSettings`, and other optional parameters.

#### Returns

`Promise`\<[`GetSepaTransfersResponse`](../-internal-/interfaces/GetSepaTransfersResponse)>

A promise that resolves to an object containing an array of SEPA
transfers and a `meta` object containing pagination state.

#### Throws

`InvalidParametersError` If proxyEndpointDescriptor is not provided.

#### Throws

`EmbedApiError` If the API request fails or returns an error.