Using Wallets API

Learn about wallets on Wyre

1. Creating a Wallet

The Create Wallet endpoint has a name parameter which allows you to attach a unique identifier to the wallet, perhaps a user id generated by your app/platform.

The type parameter allows you to choose the type of wallet to create from the following options:

  • DEFAULT
  • ENTERPRISE
  • SAVINGS

Wallets are attached to your Wyre business account at the platform level and allow you to operate them on behalf of your users via the Transfers endpoint.

Building the Create Wallet Request

When building your request to create a new wallet, you'll need to provide these fields:

  • name - Your unique identifier for this user.
  • callbackUrl - Optional callback when the user receives funds (payload)
  • notes - Optional notes about the user
  • type - The type of user you are creating, DEFAULT, ENTERPRISE or SAVINGS. When creating a wallet for SAVINGS, please follow the instructions: Creating Savings Accounts.

Response

When a new wallet is created you will receive the following:

  • name - Your identifier
  • id - Wyre's identifier
  • depositAddresses - Digital currency deposit addresses for the user
  • totalBalances - Total balance for the user
  • availableBalances - Funds available to the user
  • pusherChannel - Pusher update channel
  • srn - Wyre Reference Name identifier
  • balances - Balances for the user
  • callbackUrl - Your callback url
  • notes - Your note for the user
  • verificationData - KYC information for the user

2. Transferring Between Wallets

The Transfers endpoint facilitates movement of cryptocurrency between Wyre wallets and crypto wallets external to Wyre.

📘

Transfers and SRNs

In this example, a user creates a transfer from their Wyre wallet to another Wyre wallet on the same platform. The specific wallet is determined by the selected destination currency i.e. "BTC" will deliver Bitcoin to the destination wallet's Bitcoin address. Notice the wallet: prefix concatenated to the wallet id. These SRN prefixes are necessary.

"source":"wallet:WA_XXXXXXXX1",
"dest":"wallet:WA_XXXXXXXX2",

A user could also create a transfer from their Wyre wallet to another external crypto wallet, like below. Notice the bitcoin: prefix concatenated to the Bitcoin address. These SRN prefixes are necessary.

"source":"wallet:WA_XXXXXXXX2",
"dest":"bitcoin:1DDfMQLTd8RhGzoyWyr1ENVdoeGaoq2MZH",

To see the full list of required parameters for a transfer click here.