Wallets

Wallet (object)

Field	Type	Description
id	string	Wallet ID.
ref	string	Wallet ID in the provider's system.
balance	number	Wallet balance.
currencyCode	string	Currency code.
isReady	bool	Wallet ready to use flag. For example, allocating iban when creating a fiat wallet may take a short time.
requisites	WalletRequisites	Requisites.
type	WalletType	Wallet type.

Wallet type (enum)

Value	Description
0	Fiat.
4	Centralized.

Wallet requisites (object)

Field	Type	Description
address	string	Blockchain address. Only for centralized wallet.
iban	string	Only for fiat wallet.
swiftCode	string	Only for fiat wallet.
accountNumber	string	Only for GBP wallet.
sortCode	string	Only for GBP wallet.

Get wallets (method)

GET /provider/v1/wallets?offset=0&take=100

Query params

Param	Type	Description
offset	number (optional, default 0)	The number to skip.
take	number (optional, default 100)	The number to take. The maximum value is 100.
accountId	string (optional)	Account ID.

Result format

Param	Type	Description
items	Wallet[]
hasMore	bool	Are there more.
totalCount	number	The total number.

Get wallet (method)

GET /provider/v1/wallets/{walletId} GET /provider/v1/wallets/ref_{walletRef}

Route params

Param	Type	Description
walletId	string	Wallet ID.

Returns Wallet.

Create centralized wallet (method)

Successful account verification is required.

POST /provider/v1/wallets/centralized

Request format

Param	Type	Description
accountId	string	Account ID.
currencyCode	string	Currency code.
name	string	Wallet name.
ref	string	Wallet ID in the provider's system. The maximum length is 100 characters. We recommend using a GUID. Must be unique. If a wallet with the same ID already exists, it will be returned.

Returns Wallet.

Create fiat wallet (method)

Successful account verification is required.

POST /provider/v1/wallets/fiat

Request format

Param	Type	Description
accountId	string	Account ID.
currencyCode	string	Currency code.
name	string	Wallet name.
ref	string	Wallet ID in the provider's system. The maximum length is 100 characters. We recommend using a GUID. Must be unique. If a wallet with the same ID already exists, it will be returned.

Returns Wallet.