API Docs
Wallets & Payment
Update Wallet Interval

Update Wallet Interval

Mutation to modify the payment interval.

updateWalletInterval only impact the payments if you have them set By Threshold
⚠️

updateWalletInterval query has rate limitation in place.

Initially, the API allows for a burst of up to 20 requests, and afterward, it gradually restores 1 request every 10 seconds until reaching the maximum allowable limit of 20.

This limitation is imposed to manage and control the rate at which requests can be made to the API, preventing potential misuse or excessive use of resources.

Example

mutation MyMutation {
  updateWalletInterval(input: { uname: "api_test", coinId: BTC, paymentInterval: 4 }) {
    wallet {
      rowId
      paymentIntervalHours
      paymentMode
      isFrozen
      currencyProfileName
      address
      paymentThreshold
      pendingBalance
      remainingFreezingTime
      weeklyIntervalPaymentFrequency
    }
  }
}

Response

{
  "data": {
    "updateWalletInterval": {
      "wallet": {
        "rowId": 33024951,
        "paymentIntervalHours": 4,
        "paymentMode": "THRESHOLD",
        "isFrozen": false,
        "currencyProfileName": "BTC",
        "address": null,
        "paymentThreshold": 0.001,
        "pendingBalance": null,
        "remainingFreezingTime": 0,
        "weeklyIntervalPaymentFrequency": "MONDAY"
      }
    }
  }
}

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
}