Jump to

• Request
• Response

Create Wallet

post

{baseUrl}/v1/uwaas/wallets/provision

Provisions a wallet for a user in an organization and service instance.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• instanceId: string
  Example: {{instanceId}}
• org: object org
• wallet: object wallet

{
    "type":"object",
    "properties":{
        "org":{
            "type":"object",
            "properties":{
                "orgId":{
                    "type":"string",
                    "example":"{{orgId}}"
                },
                "organizationName":{
                    "type":"string",
                    "example":"Acme Corp"
                },
                "status":{
                    "type":"string",
                    "example":"ACTIVE"
                },
                "description":{
                    "type":"string",
                    "example":"wrapper-test-description"
                }
            },
            "example":{
                "orgId":"{{orgId}}",
                "organizationName":"Acme Corp",
                "status":"ACTIVE",
                "description":"wrapper-test-description"
            }
        },
        "instanceId":{
            "type":"string",
            "example":"{{instanceId}}"
        },
        "wallet":{
            "type":"object",
            "properties":{
                "user":{
                    "type":"object",
                    "properties":{
                        "userId":{
                            "type":"string",
                            "example":"{{userId}}"
                        },
                        "displayName":{
                            "type":"string",
                            "example":"Example User"
                        },
                        "email":{
                            "type":"string",
                            "example":"[e-mail]"
                        },
                        "roleId":{
                            "type":"integer",
                            "example":1
                        },
                        "status":{
                            "type":"string",
                            "example":"ACTIVE"
                        }
                    },
                    "example":{
                        "userId":"{{userId}}",
                        "displayName":"Example User",
                        "email":"[e-mail]",
                        "roleId":1,
                        "status":"ACTIVE"
                    }
                },
                "walletLabel":{
                    "type":"string",
                    "example":"UWaaS-auxiliary"
                },
                "walletType":{
                    "type":"string",
                    "example":"1"
                },
                "status":{
                    "type":"string",
                    "example":"ACTIVE"
                },
                "walletTags":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "example":"e:dev"
                    },
                    "example":[
                        "e:dev",
                        "a:erc20"
                    ]
                }
            },
            "example":{
                "user":{
                    "userId":"{{userId}}",
                    "displayName":"Example User",
                    "email":"[e-mail]",
                    "roleId":1,
                    "status":"ACTIVE"
                },
                "walletLabel":"UWaaS-auxiliary",
                "walletType":"1",
                "status":"ACTIVE",
                "walletTags":[
                    "e:dev",
                    "a:erc20"
                ]
            }
        }
    },
    "example":{
        "org":{
            "orgId":"{{orgId}}",
            "organizationName":"Acme Corp",
            "status":"ACTIVE",
            "description":"wrapper-test-description"
        },
        "instanceId":"{{instanceId}}",
        "wallet":{
            "user":{
                "userId":"{{userId}}",
                "displayName":"Example User",
                "email":"[e-mail]",
                "roleId":1,
                "status":"ACTIVE"
            },
            "walletLabel":"UWaaS-auxiliary",
            "walletType":"1",
            "status":"ACTIVE",
            "walletTags":[
                "e:dev",
                "a:erc20"
            ]
        }
    }
}

Example:

{
    "org":{
        "orgId":"{{orgId}}",
        "organizationName":"Acme Corp",
        "status":"ACTIVE",
        "description":"wrapper-test-description"
    },
    "instanceId":"{{instanceId}}",
    "wallet":{
        "user":{
            "userId":"{{userId}}",
            "displayName":"Example User",
            "email":"[e-mail]",
            "roleId":1,
            "status":"ACTIVE"
        },
        "walletLabel":"UWaaS-auxiliary",
        "walletType":"1",
        "status":"ACTIVE",
        "walletTags":[
            "e:dev",
            "a:erc20"
        ]
    }
}

Nested Schema : org

Type: object

Show Source

• description: string
  Example: wrapper-test-description
• organizationName: string
  Example: Acme Corp
• orgId: string
  Example: {{orgId}}
• status: string
  Example: ACTIVE

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "example":"{{orgId}}"
        },
        "organizationName":{
            "type":"string",
            "example":"Acme Corp"
        },
        "status":{
            "type":"string",
            "example":"ACTIVE"
        },
        "description":{
            "type":"string",
            "example":"wrapper-test-description"
        }
    },
    "example":{
        "orgId":"{{orgId}}",
        "organizationName":"Acme Corp",
        "status":"ACTIVE",
        "description":"wrapper-test-description"
    }
}

Example:

{
    "orgId":"{{orgId}}",
    "organizationName":"Acme Corp",
    "status":"ACTIVE",
    "description":"wrapper-test-description"
}

Nested Schema : wallet

Type: object

Show Source

• status: string
  Example: ACTIVE
• user: object user
• walletLabel: string
  Example: UWaaS-auxiliary
• walletTags: array walletTags
• walletType: string
  Example: 1

{
    "type":"object",
    "properties":{
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "example":"{{userId}}"
                },
                "displayName":{
                    "type":"string",
                    "example":"Example User"
                },
                "email":{
                    "type":"string",
                    "example":"[e-mail]"
                },
                "roleId":{
                    "type":"integer",
                    "example":1
                },
                "status":{
                    "type":"string",
                    "example":"ACTIVE"
                }
            },
            "example":{
                "userId":"{{userId}}",
                "displayName":"Example User",
                "email":"[e-mail]",
                "roleId":1,
                "status":"ACTIVE"
            }
        },
        "walletLabel":{
            "type":"string",
            "example":"UWaaS-auxiliary"
        },
        "walletType":{
            "type":"string",
            "example":"1"
        },
        "status":{
            "type":"string",
            "example":"ACTIVE"
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"e:dev"
            },
            "example":[
                "e:dev",
                "a:erc20"
            ]
        }
    },
    "example":{
        "user":{
            "userId":"{{userId}}",
            "displayName":"Example User",
            "email":"[e-mail]",
            "roleId":1,
            "status":"ACTIVE"
        },
        "walletLabel":"UWaaS-auxiliary",
        "walletType":"1",
        "status":"ACTIVE",
        "walletTags":[
            "e:dev",
            "a:erc20"
        ]
    }
}

Example:

{
    "user":{
        "userId":"{{userId}}",
        "displayName":"Example User",
        "email":"[e-mail]",
        "roleId":1,
        "status":"ACTIVE"
    },
    "walletLabel":"UWaaS-auxiliary",
    "walletType":"1",
    "status":"ACTIVE",
    "walletTags":[
        "e:dev",
        "a:erc20"
    ]
}

Nested Schema : user

Type: object

Show Source

• displayName: string
  Example: Example User
• email: string
  Example: [e-mail]
• roleId: integer
  Example: 1
• status: string
  Example: ACTIVE
• userId: string
  Example: {{userId}}

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "example":"{{userId}}"
        },
        "displayName":{
            "type":"string",
            "example":"Example User"
        },
        "email":{
            "type":"string",
            "example":"[e-mail]"
        },
        "roleId":{
            "type":"integer",
            "example":1
        },
        "status":{
            "type":"string",
            "example":"ACTIVE"
        }
    },
    "example":{
        "userId":"{{userId}}",
        "displayName":"Example User",
        "email":"[e-mail]",
        "roleId":1,
        "status":"ACTIVE"
    }
}

Example:

{
    "userId":"{{userId}}",
    "displayName":"Example User",
    "email":"[e-mail]",
    "roleId":1,
    "status":"ACTIVE"
}

Nested Schema : walletTags

Type: array

Show Source

• Array of: string
  Example: e:dev

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"e:dev"
    },
    "example":[
        "e:dev",
        "a:erc20"
    ]
}

Example:

[
    "e:dev",
    "a:erc20"
]

Security

• OAuth2Password: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json

201 Response

Dependencies were created or reused and the wallet was created successfully.

Body ()

Root Schema : UWAAS_ProvisionWalletResponse

Type: object

Show Source

• network(required): object network
  Additional Properties Allowed: true
• org(required): object org
  Additional Properties Allowed: true
• user(required): object user
  Additional Properties Allowed: true
• wallet(required): object wallet
  Additional Properties Allowed: true

{
    "type":"object",
    "required":[
        "org",
        "network",
        "user",
        "wallet"
    ],
    "properties":{
        "org":{
            "type":"object",
            "additionalProperties":true
        },
        "network":{
            "type":"object",
            "additionalProperties":true
        },
        "user":{
            "type":"object",
            "additionalProperties":true
        },
        "wallet":{
            "type":"object",
            "additionalProperties":true
        }
    }
}

Nested Schema : network

Type: object

Additional Properties Allowed: true

Nested Schema : org

Type: object

Additional Properties Allowed: true

Nested Schema : user

Type: object

Additional Properties Allowed: true

Nested Schema : wallet

Type: object

Additional Properties Allowed: true

400 Response

The wrapper rejected the request before it could complete a downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

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

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

405 Response

The HTTP method is not supported for this resource.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

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

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

415 Response

Content-Type must be application/json.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

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

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

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",
    "required":[
        "status",
        "error"
    ],
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    }
}

Back to Top