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 the following 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 Wyre+ Rewards Wallets Guide.

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
{
  "status": null,
  "srn": "wallet:WA_LLU2FA847JQ",
  "pusherChannel": "55ace6d63a47b9fgf679d329f954ff5f",
  "callbackUrl": null,
  "balances": {},
  "notes": null,
  "depositAddresses": {
    "AVAX": "X-fuji1gf4q4zww0wt2vht9j02dzxdd6u84catkn6349c",
    "XLM": "GD7WXI7AOAK2CIPZVBEFYLS2NQZI2J4WN4HFYQQ4A2OMFVWGWAL3IW7K:JPLJEMY9264",
    "BTC": "mjEcj2LA3vj1nDi8ZD3QMCs9kNqVk7Dpee",
    "ETH": "0x084abe6434a0fbe37f666ce5d8fdb803296dd3b2"
  },
  "savingsReferralSRN": null,
  "totalBalances": {},
  "availableBalances": {},
  "name": "updated-name",
  "id": "WA_LLU2A847JQ",
  "type": "DEFAULT"
}