Retrieve wallet

Retrieve a single wallet using its unique id.

You can retrieve wallets in multiple ways:

  1. By wallet ID - This will retrieve a specific wallet.

  2. Retrieve all wallets - This will retrieve all wallets.

  3. By the identifier - This will retrieve wallets by the identifier

  4. By the userId - This will retrieve all wallets of a specific user.

1. Get a wallet by id

Request Endpoint: reference

HTTP

GET /api/wallets/{id}
Parameter
Param Type
Description
Data Type
Mandatory

{id}

path

The wallet id

String

✅

Response Body

JSON

{
    "success": true,
    "result": {
        "id": "96d7f016-a062-4d29-9e37-94b9765bc08a",
        "address": "0x40b8aDCbe02dfDEb032F55bEc278892c6397D4ca",
        "walletType": "API_WALLET",
        "secretType": "MATIC",
        "createdAt": "2024-01-08T10:16:47.553371",
        "archived": false,
        "description": "Waste Wallet",
        "primary": false,
        "hasCustomPin": false,
        "userId": "a69e4d35-b931-466b-a943-d1d0934bcf71",
        "custodial": false,
        "balance": {
            "available": true,
            "secretType": "MATIC",
            "balance": 0,
            "gasBalance": 0,
            "symbol": "MATIC",
            "gasSymbol": "MATIC",
            "rawBalance": "0",
            "rawGasBalance": "0",
            "decimals": 18
        }
    }
}

2. Get all wallets

Request Endpoint: reference

HTTP

Response Body

JSON

3. Get wallets by identifier

Request Endpoint: reference

HTTP

Parameter
Param Type
Description
Data Type
Mandatory

identifier

Query

Identifier to fetch a single or group of wallets

String

✅

Response Body

JSON

4. Get wallets by userId

Request Endpoint: reference

HTTP

Parameter
Param Type
Description
Data Type
Mandatory

userId

Query

Filter wallets by user ID

String

✅

Response Body

JSON

PreviousCreate a walletNextArchive a wallet

Last updated