API Docs
Wallets & Payment
Provision Wallet

Provision Wallet

Creates a new user with the required permissions given a username

Example

mutation provisionWallet {
  provisionWallet(input: { coinId: BTC, inputUsername: "your_username" }) {
    wallet {
      address
      currencyProfileName
      isFrozen
      id
      pendingBalance
    }
  }
}

Response

{
  "data": {
    "provisionWallet": {
      "wallet": {
        "address": null,
        "currencyProfileName": "BTC",
        "isFrozen": false,
        "id": "your_wallet_entity_id",
        "pendingBalance": "0"
      }
    }
  }
}

Arguments

  • input (ProvisionNewUserInput!)

The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.

type ProvisionWalletInput {
  clientMutationId: String
  inputUsername: String
  coinId: CurrencyProfileName
}
  • clientMutationId (String) An arbitrary string value with no semantic meaning. Will be included in the payload verbatim. May be used to track mutations by the client.

  • inputUsername (String)

  • coinId (CurrencyProfileName)

    enum CurrencyProfileName {
      ARRR
      BTC
      DASH
      DCR
      KMD
      LBC
      SC
      SCP
      ZEC
      ZEN
      USD
      TBTC
      ETH
      TETH
      USDT
    }

Type

ProvisionNewUserPayload

The output of our provisionNewUser mutation.

type ProvisionWalletPayload {
  clientMutationId: String
  wallet: Wallet
  query: Query
  walletEdge(orderBy: [WalletsOrderBy!] = [PRIMARY_KEY_ASC]): WalletsEdge
}
Fields
  • clientMutationId (String) The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.

  • wallet (Wallet)

  • query (Query)

  • walletEdge (WalletsEdge) An edge for our Wallet. May be used by Relay 1.

type WalletsEdge {
  cursor: Cursor
  node: Wallet!
}
  • orderBy ([WalletsOrderBy!]) The method to use when ordering Wallet.
enum WalletsOrderBy {
  NATURAL
  ID_ASC
  ID_DESC
  CURRENCY_PROFILE_NAME_ASC
  CURRENCY_PROFILE_NAME_DESC
  PRIMARY_KEY_ASC
  PRIMARY_KEY_DESC
}