IBAN Top-Up

To top up an IBAN account, you can use one of the following methods:

1. SEPA Transfer (Incoming)

  • Description:
    This method allows you to top up your IBAN account by receiving funds via SEPA transfer. It’s ideal for transferring funds in EUR from a local bank account within the SEPA zone.

  • Use Case:
    Use this method when you want to transfer EUR into your IBAN account from an external account via SEPA.

2. Crypto-to-Fiat Exchange

  • Description:
    This method allows you to convert cryptocurrency into fiat currency (EUR) and transfer the funds into your IBAN account.

  • Use Case:
    Use this method when you want to exchange cryptocurrency for EUR and top up your IBAN account.


Account Types

  • BANK_ACCOUNT_VIRTUAL
    • Description:
      This account type supports IBAN operations, allowing seamless international transactions. It enables receiving and sending payments via IBAN (via SEPA) and can also handle crypto-to-fiat exchanges when needed.

📘

Important: Ensure the account type is BANK_ACCOUNT_VIRTUAL to perform the top-up operation. If it is a different account type, the operation may not be available.


Funding the BANK_ACCOUNT_VIRTUAL Account

To fund the BANK_ACCOUNT_VIRTUAL account, you can use:

  • SEPA Transfer:
    Receive EUR from another bank account within the SEPA zone into your IBAN account.
  • Crypto-to-Fiat Exchange:
    Convert cryptocurrency into EUR and then transfer it to your IBAN account.

Create a Currency Exchange

The Create a Currency Exchange API allows you to exchange one currency for another on the user's account. You can use the dryRun parameter to simulate the operation, check the resulting exchange rate and fees, and confirm details before executing the transaction.

Body Parameters:

FieldTypeRequiredDescription
idstringYesUnique identifier for the direct exchange.
fromAccountstringYesThe account initiating the exchange.
toAccountstringYesThe destination account for the exchange.
fromCurrencystringYesThe currency being exchanged from.
toCurrencystringYesThe currency being exchanged to.
fromAmountstringYesThe amount in the source currency.
toAmountstringYesThe amount in the target currency.
signedRateobjectYesThe exchange rate at which the conversion is executed.

Optional Parameter:

  • dryRun (boolean):
    When set to true, this parameter simulates the exchange without executing it. It returns the estimated exchange rate and fee amount, allowing users to check the transaction details before committing.

Example of Use

  1. Create the exchange request:

    • Define the parameters: fromAccount, toAccount, fromCurrency, toCurrency, fromAmount, toAmount, and signedRate.
    • Optionally, use the dryRun parameter to simulate the exchange.
  2. Execute the exchange:

    • Once confirmed, execute the exchange to transfer funds between the two accounts at the specified rate.

Note: The id field serves as a unique identifier for each exchange operation and is required to track and manage the exchange.


Create a Transfer

The Create a Transfer API allows you to transfer funds between accounts without currency conversion. If both the source and target accounts are in the same currency, this method is ideal.

Body Parameters:

FieldTypeRequiredDescription
fromAccountstringYesThe account ID from which the transfer is made.
toAccountstringYesThe account ID to which the funds are transferred.
currencystringYesThe currency in which the transfer is made.
amountstringYesThe amount of money to transfer.
notestringNoA note or reference for the transfer.

Once the transfer is created, it must be confirmedbefore being finalized.

Path Parameters:

FieldTypeRequiredDescription
uuidstringYesUUID of the transfer to be confirmed.

Example of Use for Transfer:

  1. Create the transfer request:

    • Provide the fromAccount, toAccount, currency, and amount fields to initiate the transfer.
  2. Confirm the transfer:

    • Use the uuid of the created transfer to confirm the transaction and complete the process.

Final Notes:

  • Ensure Correct Currency:
    Before performing either a Transfer or Currency Exchange, verify that the source and destination accounts are in the correct currency, especially when using the Exchange method.
  • Check Fees:
    Always check for any applicable fees or rates that might be associated with the Currency Exchange or Transfer operations. Use the dryRun feature when possible to verify rates and fees before confirming the transaction.