Sweep

Transfer all assets from a private key

The sweep endpoint facilitates the seamless transfer of all BSV and STAS tokens associated with a specific private key string to a designated address. A notable feature of this endpoint is its compatibility with QR codes incorporating a private key in Wallet Import Format (WIF), offering users a quick and easy method to interact with web pages or participate in live events. Essentially, this functionality can be leveraged to create a "scan and go" system, enhancing the user experience by simplifying transactions and promoting engagement in various digital environments. Moreover, the application of QR codes can foster secure and instantaneous transactions, thereby bringing a dynamic and interactive dimension to the user's journey. Body Request

{
 privateKey : "string"
}

Transfer all assets from PrivateKey to the user

POST https://api.relysia.com/v1/sweep

The sweep endpoints allows users to transfer all coins (BSV and Tokens) from a PrivateKey.

Headers

NameTypeDescription

walletId

String

User wallet Id. Will use default wallet if no value provided.

Request Body

NameTypeDescription

privateKey*

String

Private Key string to transfer all asset from.

{
  "statusCode": 200,
  "data": {
    "status": "success",
    "msg": "operation completed successfully",
    "txIds": [
      "02f60500a9163ad7af8fa619633fd3d1798daff4159fd4079cb9aab8ec88fe6e",
      "b85a0ba09d65952e78aadca40d99e619e82beff05446ed4c901bcdd30e441b20",
      "00f7c5552da20ba707bafb8a9cc9f83e7b06b550e3fbf575b7b822e8afa20a7d"
    ],
    "errors": []
  }
}

Last updated