Jump to

• Request
• Response

List Wallets

get

/walletservice/v1/wallets

Lists canonical UWaaS wallet records. The returned item format is also used by the wallet-by-address endpoint.

Request

Query Parameters

• instanceId: string
• nextPageToken: string
• orgId: integer(int64)
• pageSize: integer
  Minimum Value: 1

  Maximum Value: 100

  Default Value: 50
• search: string
• status: string
• type: string
• userId: string
• walletServiceId: string

There's no request body for this operation.

Security

• bearerAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Wallets retrieved successfully.

Body ()

Root Schema : ListWalletsResponse

Type: object

Show Source

• items(required): array items
• nextPageToken: string
  Opaque cursor for the next page.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListedWallet"
            }
        },
        "nextPageToken":{
            "type":"string",
            "nullable":true,
            "description":"Opaque cursor for the next page."
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object ListedWallet
  A canonical UWaaS wallet record, returned by wallet list and wallet-by-address lookups.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ListedWallet"
    }
}

Nested Schema : ListedWallet

Type: object

A canonical UWaaS wallet record, returned by wallet list and wallet-by-address lookups.

Show Source

• address(required): string
  Example: 0x599f59e794c88a108e0cc2072b7a52fa3576cea4
• blockchainType: string
  Example: BESU
• createdBy: string
• createdDate: string (date-time)
• instanceId: string
• label: string
• orgId: string
• orgNetworkId: integer (int64)
• ownershipType(required): string
  Allowed Values: [ "USER", "SERVICE" ]
• status: string
  Example: ACTIVE
• type: string
• typeLabel: string
• updatedBy: string
• updatedDate: string (date-time)
• userId: string
• walletId(required): string (uuid)
  UWaaS wallet identifier.

  Example: f3f0716b-2bb3-4be8-ad14-f5d3a7f472aa
• walletTags: array walletTags

{
    "type":"object",
    "description":"A canonical UWaaS wallet record, returned by wallet list and wallet-by-address lookups.",
    "properties":{
        "walletId":{
            "type":"string",
            "format":"uuid",
            "description":"UWaaS wallet identifier.",
            "example":"f3f0716b-2bb3-4be8-ad14-f5d3a7f472aa"
        },
        "orgId":{
            "type":"string"
        },
        "orgNetworkId":{
            "type":"integer",
            "format":"int64"
        },
        "instanceId":{
            "type":"string"
        },
        "blockchainType":{
            "type":"string",
            "example":"BESU"
        },
        "userId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "example":"ACTIVE"
        },
        "label":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "typeLabel":{
            "type":"string"
        },
        "ownershipType":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE"
            ]
        },
        "address":{
            "type":"string",
            "example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string",
            "nullable":true
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "walletId",
        "ownershipType",
        "address"
    ]
}

Nested Schema : walletTags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top