☰

Navigation:

Bank transfer API (Deprecated)

Information about the deprecated - but still functional - version of our Bank transfer API.

Overview

Our deprecated Bank transfer API allows you to perform a number of actions for the management of linked bank accounts and external bank transfers.

In order to create an outgoing bank transfer to an external IBAN, first you need to link the bank account where funds will be transferred to. The “linked bank account” entity consists of an IBAN (external to Viva), the name of the beneficiary and a friendly name

API calls

Our deprecated Bank transfer API consists of the below calls. To initiate an external bank transfer you need perform steps 1, 2 and 3.

  1. Validate IBAN
  2. Link bank account
  3. Create outgoing bank transfer command
  4. Retrieve bank account details by ID
  5. Retrieve bank accounts
  6. Unlink bank account

1. Validate IBAN

Use this API Call to ensure that an IBAN is valid.

The IBAN should belong to a bank account set up in the same currency as your Viva merchant account

Find out more about the Validate IBAN API call and its parameters

Use this API Call to link a bank account (create a new beneficiary using an external IBAN). It is strongly recommended to first make sure that the IBAN is valid by using the Validate IBAN API call.

Find out more about the Link bank account API call and its parameters

3. Create outgoing bank transfer command

Before you can use this API call you need to “allow transfers between accounts” in the viva banking app:

  1. Sign in to Viva and select the required account.

  2. Go to Settings > API Access.

  3. Select the Allow transfers between accounts checkbox as shown below:

    Allow Transfers
    The new setting is saved automatically.

✔️ You need only do this for the source wallet.

The bank transfer will fail for any of the below indicative reasons:

  • Τhe parameter ‘walletId’ is missing or is not valid
  • The ‘bankAccountId’ parameter is missing or is not valid or is linked with a non-valid IBAN (refer to the Validation IBAN API Call)
  • The currency of the ‘bankAccountId’ and the currency of the ‘walletId’ are different
  • The ‘amount’ parameter is not greater than zero (0)
  • Insufficient funds in ‘walletId’. There should be at least as much money available in ‘walletId’ as the proposed transfer amount

Find out more about the Create outgoing bank transfer API call and its parameters

4. Retrieve linked bank account details by ID

Use this API Call to retrieve a linked bank account (beneficiary using an external IBAN) by its ID.

Find out more about the Retrieve bank account by Id API call and its parameters

5. Retrieve linked bank accounts

Retrieve the linked bank accounts (beneficiaries using external IBANs) set up under your Viva profile.

Find out more about the Retrieve bank accounts API call and its parameters

Use this API Call to unlink a linked bank account (beneficiary using an external IBAN) by ID.

You cannot unlink a bank account which has previous transactions from your Viva account. Instead, please try deleting this beneficiary via the red Delete button within your Viva banking account (self-care)

Find out more about the Unlink bank accounts API call and its parameters

Get Support

If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!