Qodex.ai

Multi Currency Account

Number of APIs: 9

The Wise multi-currency account (MCA) enables users to hold, convert, and fund transfers (single or batches) with balances in up to 56 currencies.

The MCA is composed of:

Balance: Where your money in each currency is held.
Account Details: The local or international bank details can be used to receive money to a balance.

With sufficient funds in the balance, transfers can then be funded over the API. This documentation explains how to use the MCA APIs to create a balance and account details.

Creating balance and account details flow

To create an account in one of the available currencies, some steps needs to be follwed:

  • Check if user is verified
  • Open balance
  • Order account details
  • Get account details
  • Get balance (after making a deposit to the account)
image
Verification

The user needs to be verified before using account details. To check the current status, there's an API for verification (#0). A first check using this API is recommended, and in case the user is still in status not_verified the integration should wait for a webhook notification of type profiles#verification-state-change. Every time a verification changes internally this event is emitted, and even though it contains a current status in it's payload, this is valid for other types of verification, not MCA. So use this trigger to call the API again and check the latest status for the user.

After the status (verified) is reached, the flow can continue.

Get account details

Ordering account details is an async process, which internally will be put on hold (available status instead of active) if verification is pending. But as we advised to check for verification in the first step, nothing should block the retrieve of the account details, which to be used need to be in status active

  1. Simulation APIs - Verify user POST {{host}}/v1/simulation/verify-profile

  2. Simulation APIs - Balance topup POST {{host}}/v1/simulation/balance/topup

  3. 0. Verification POST {{host}}/v3/profiles/{{profile-id}}/verification-status/multi-currency-account?currencies=GBP,USD

  4. 2.1 Get balance by id (V3) GET {{host}}/v3/profiles/{{profile-id}}/balances/{{balance-id}}

  5. 2. Get balances (V3) GET {{host}}/v3/profiles/{{profile-id}}/balances?types=STANDARD

  6. 3. Create account details order POST {{host}}/v1/profiles/{{profile-id}}/account-details-orders

  7. 3.1 Get account details orders GET {{host}}/v1/profiles/{{profile-id}}/account-details-orders

  8. 4. Get account details GET {{host}}/v1/profiles/{{profile-id}}/account-details

  9. 1. Open Balance (V3) POST {{host}}/v3/profiles/{{profile-id}}/balances