@qonto/embed-sdk / <internal> / NewBulkTransfer

Interface: NewBulkTransfer

Represents the parameters required to create a new SEPA bulk transfer. This interface is used to define the structure of the data needed to initiate a SEPA bulk transfer.

Properties

amount

amount: number
The amount to be transferred, represented as a number.

attachmentsIds?

optional attachmentsIds: string[]
An optional array of attachment IDs related to the transfer. Attachments are required for transfers over €30,000.

beneficiary?

optional beneficiary: Beneficiary
The beneficiary details, which include information about the beneficiary such as their name, account number, and bank details. Required if beneficiaryId is not provided.

beneficiaryId?

optional beneficiaryId: string
The ID of the beneficiary to whom the transfer will be made. Required if beneficiary is not provided.

clientTransferId

clientTransferId: string
A unique identifier for the transfer provided by the client. This ID is used to track and distinguish individual transfers within the bulk transfer creation process.

note?

optional note: string
An optional note that can be included with the transfer for additional information or context.

reference

reference: string
A reference string for the transfer, which can be used for tracking or identification purposes.

scheduledDate?

optional scheduledDate: Date
An optional date when the transfer is scheduled to be processed. If not provided, the transfer will be processed immediately.