Get all Wallets (New)

get

https://api-wallet-sandbox.vertofx.com/{companyId}/wallets

Retrieve all wallets with the migrated wallet service route and use the returned wallet IDs for receive, FX, transfer, and payout flows.

📘
NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangably will result in 403 errors.

Path Params

companyId

string

required

Specifies the unique identifier assigned to a company within the system.
Get the companyId in the response path [response.body.companyId] of the POST /users/login API.

Query Params

limit

int32

required

1 to 100

Specifies the maximum number of records to return.

skip

int32

required

≥ 0

Specifies the number of items to skip before starting to collect the result set.

currency

string

enum

length between 3 and 3

3-character ISO 4217 currency code used to denote a specific currency. It serves as a universal identifier for the type of money involved in a wallet transaction.

currencyId

string

Specifies the unique ID for each currency.

searchTerm

string

Search by wallet label

isDefault

boolean

Filter to check if the wallet is set as the default.

isArchived

boolean

Filter to check if the wallet is archived.

walletIds

string

Comma separated wallet id's.

type

string

enum

wallet type

Allowed:

Responses

200Fetch wallets for a company

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error