Jump to

• Request
• Response

Get Wallets

get

{baseUrl}/v1/uwaas/wallets

Retrieves wallets that match the specified organization, user, and instance criteria.

Request

Query Parameters

• instanceId: string
• orgId: string
  Default Value: acmeCorp
• pageSize: integer(int64)
  Default Value: 5
• userId: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Wallets retrieved successfully.

Body ()

Root Schema : UWAAS_ListWalletsEnvelope

Type: object

Show Source

• payload(required): object UWAAS_ListWalletsResponse
• status(required): string

{
    "type":"object",
    "required":[
        "status",
        "payload"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"success"
        },
        "payload":{
            "$ref":"#/components/schemas/UWAAS_ListWalletsResponse"
        }
    }
}

Nested Schema : UWAAS_ListWalletsResponse

Type: object

Show Source

• items(required): array items
• nextPageToken: [ "string", "null" ]

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UWAAS_ListedWallet"
            }
        },
        "nextPageToken":{
            "type":[
                "string",
                "null"
            ]
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object UWAAS_ListedWallet

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

Nested Schema : UWAAS_ListedWallet

Type: object

Show Source

• address(required): string
• blockchainType(required): string
• createdBy(required): string
• createdDate(required): string (date-time)
• instanceId(required): string
• label(required): string
• orgId(required): string
• orgNetworkId(required): integer (int64)
• ownershipType: string
  Default Value: USER

  Allowed Values: [ "USER", "SERVICE" ]
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "CLOSED" ]

  Example: ACTIVE
• type(required): string
  Allowed Values: [ "1" ]

  Example: 1
• typeLabel(required): string
• updatedBy: [ "string", "null" ]
• updatedDate: [ "string", "null" ] (date-time)
• userId(required): string
• walletId(required): string
• walletTags(required): array walletTags

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string"
        },
        "orgId":{
            "type":"string"
        },
        "orgNetworkId":{
            "type":"integer",
            "format":"int64"
        },
        "instanceId":{
            "type":"string"
        },
        "blockchainType":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "status":{
            "$ref":"#/components/schemas/UWAAS_WalletStatus"
        },
        "label":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/UWAAS_WalletType"
        },
        "typeLabel":{
            "type":"string"
        },
        "ownershipType":{
            "$ref":"#/components/schemas/UWAAS_OwnershipType"
        },
        "address":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "updatedDate":{
            "type":[
                "string",
                "null"
            ],
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":[
                "string",
                "null"
            ]
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "walletId",
        "orgId",
        "orgNetworkId",
        "instanceId",
        "blockchainType",
        "userId",
        "status",
        "label",
        "type",
        "typeLabel",
        "address",
        "createdDate",
        "createdBy",
        "walletTags"
    ]
}

Nested Schema : walletTags

Type: array

Show Source

• Array of: string

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

400 Response

Bad request.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Back to Top