(un)Archive a wallet

How to archive or unarchive a wallet.

There are several payment plans for Wallet API, each tailored to different needs and company sizes. However, we charge per number of active wallets. In order to be more cost-effective, you might want to archive a wallet.

๐Ÿ“˜

A wallet that has been archived for longer than 30 days, it is no longer considered active, thus you will not be billed for it.

Request Endpoint: reference

PATCH /api/wallets/{id}
ParameterParam TypeDescriptionData TypeMandatory
idPathThis ID of the walletStringโœ…
archivedBodyA boolean flag that indicates to archive the wallet or notBooleanโœ…

๐Ÿ“˜

Archived wallets will no longer be returned in any of our endpoints and you will no longer be able to use it in any way.

You are able to unarchive a wallet at any time. You do however need the walletID to perform this operation. Make sure to store it somewhere to be able to unarchive the wallet in a later stage!

Example Request:

PATCH https://api-wallet.venly.io/api/wallets/9e8af613-e8da-4fa6-8bcc-7e589d2c7d74
{ 
    "archived": true 
}

Response Body:

{
    "success": true,
    "result": {
        "id": "9e8af613-e8da-4fa6-8bcc-7e589d2c7d74",
        "address": "0xf51Be4152f8E3ad3557E44Db1F803bA3e4c5DeB5",
        "walletType": "THREEWAY_SHARED",
        "secretType": "ETHEREUM",
        "createdAt": "2022-04-05T08:29:44.026438",
        "archived": true,
        "description": "Likable Hedgehog",
        "primary": false,
        "hasCustomPin": false
    }
}