Wise Platform APISDK documentation
voxgig-sdk/wise-sdk
API

MultiCurrencyAccount

The multi-currency account: eligibility, and its available and payin currencies.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method Route SDK operation Returns
GET /borderless-accounts-configuration/profiles/{profileId}/available-currencies list List of currencies available for balance accounts
GET /borderless-accounts-configuration/profiles/{profileId}/payin-currencies list List of currencies available for payin with bank account details
GET /multi-currency-account/eligibility load Eligibility result

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

multi_currency_account, err := client.MultiCurrencyAccount(nil).Load(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(multi_currency_account)

Lua

Construct client as shown in the Lua setup, then call the operations:

local multi_currency_account, err = client:MultiCurrencyAccount():load()

PHP

Construct client as shown in the PHP setup, then call the operations:

$multi_currency_account = $client->MultiCurrencyAccount()->load();

Python

Construct client as shown in the Python setup, then call the operations:

multi_currency_account = client.MultiCurrencyAccount().load()

Ruby

Construct client as shown in the Ruby setup, then call the operations:

multi_currency_account = client.MultiCurrencyAccount.load()

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const multi_currency_account = await client.MultiCurrencyAccount().load()

Fields

Field Type Required Description

list

GET /borderless-accounts-configuration/profiles/{profileId}/available-currencies

Operation ID: mcaAvailableCurrenciesGet.

Authentication: bearer token (UserToken).

Parameters

Parameter In Type Required Description
profileId path integer (int64) Yes Profile ID.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: List of currencies available for balance accounts

application/json

The response is array of string.

Example response:

[
  "EUR",
  "GBP",
  "USD"
]
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /borderless-accounts-configuration/profiles/{profileId}/payin-currencies

Operation ID: mcaPayinCurrenciesGet.

Authentication: bearer token (UserToken).

Parameters

Parameter In Type Required Description
profileId path integer (int64) Yes Profile ID.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: List of currencies available for payin with bank account details

application/json

The response is array of string.

Example response:

[
  "EUR",
  "GBP",
  "USD"
]
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /multi-currency-account/eligibility

Operation ID: mcaEligibilityGet.

Authentication: bearer token (UserToken).

Parameters

Parameter In Type Required Description
profileId query integer (int64) No Profile ID to check eligibility for.
country query string No 2-letter ISO 3166 country code to check eligibility for.
state query string No 2-letter state/province code. Required when country is US.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: Eligibility result

application/json

Property Type Required Description
accountType enum: FULL, RECEIVE_ONLY, INELIGIBLE No Account type available.
eligibilityCode enum: eligible, invalid.profile.type, invalid.country, invalid.state No Eligibility status code.
eligible boolean No Whether the profile is eligible for a multi currency account.
ineligibilityReason string,null No Reason the profile is not eligible.
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.