Jump to

• Request
• Response

Create Account With Role

post

{baseUrl}/v1/{accountWithErc5982UupsContractAddress}/createAccountWithRole

Creates a CBDC account and assigns the specified role.

Request

Path Parameters

• accountWithErc5982UupsContractAddress(required): string
  Path parameter

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account(required): string
  Example: account value
• applicationGroups(required): string
  Example: applicationGroups value
• maxDailyAmount(required): string
  Example: maxDailyAmount value
• maxDailyTransactions(required): string
  Example: maxDailyTransactions value
• orgId(required): string
  Example: orgId value
• role(required): string
  Example: role value
• userAddress(required): string
  Example: userAddress value
• userId(required): string
  Example: userId value
• walletId(required): string
  Postman variable {{walletId}}

  Example:

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string",
            "example":"",
            "description":"Postman variable {{walletId}}"
        },
        "account":{
            "type":"string",
            "example":"account value"
        },
        "applicationGroups":{
            "type":"string",
            "example":"applicationGroups value"
        },
        "maxDailyAmount":{
            "type":"string",
            "example":"maxDailyAmount value"
        },
        "maxDailyTransactions":{
            "type":"string",
            "example":"maxDailyTransactions value"
        },
        "orgId":{
            "type":"string",
            "example":"orgId value"
        },
        "role":{
            "type":"string",
            "example":"role value"
        },
        "userAddress":{
            "type":"string",
            "example":"userAddress value"
        },
        "userId":{
            "type":"string",
            "example":"userId value"
        }
    },
    "required":[
        "walletId",
        "account",
        "applicationGroups",
        "maxDailyAmount",
        "maxDailyTransactions",
        "orgId",
        "role",
        "userAddress",
        "userId"
    ],
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

All combined rpc-proxy steps completed successfully.

Body ()

Root Schema : CombinedApi_SuccessResponse

Type: object

Show Source

• status(required): string
• steps(required): array steps

{
    "type":"object",
    "required":[
        "status",
        "steps"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"success"
        },
        "steps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinedApi_StepResult"
            }
        }
    }
}

Nested Schema : steps

Type: array

Show Source

• Array of: object CombinedApi_StepResult

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

Nested Schema : CombinedApi_StepResult

Type: object

Show Source

• body(required):
  Parsed rpc-proxy response body, or the unparsed response text.
• statusCode(required): integer
• step(required): string
• stepIndex(required): integer

{
    "type":"object",
    "required":[
        "step",
        "stepIndex",
        "statusCode",
        "body"
    ],
    "properties":{
        "step":{
            "type":"string"
        },
        "stepIndex":{
            "type":"integer"
        },
        "statusCode":{
            "type":"integer"
        },
        "body":{
            "description":"Parsed rpc-proxy response body, or the unparsed response text."
        }
    }
}

400 Response

Request validation failed, or a combined step rejected the request.

Body ()

Root Schema : CombinedApi_FailureResponse

Type: object

Show Source

• error(required): string
• failedStep(required): string
• failedStepBody:
  Parsed response body from the failed step when available.
• failedStepIndex(required): integer
• status(required): string
• steps(required): array steps

{
    "type":"object",
    "required":[
        "status",
        "failedStep",
        "failedStepIndex",
        "error",
        "steps"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"failed"
        },
        "failedStep":{
            "type":"string"
        },
        "failedStepIndex":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        },
        "failedStepBody":{
            "description":"Parsed response body from the failed step when available."
        },
        "steps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinedApi_StepResult"
            }
        }
    }
}

Nested Schema : steps

Type: array

Show Source

• Array of: object CombinedApi_StepResult

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

Nested Schema : CombinedApi_StepResult

Type: object

Show Source

• body(required):
  Parsed rpc-proxy response body, or the unparsed response text.
• statusCode(required): integer
• step(required): string
• stepIndex(required): integer

{
    "type":"object",
    "required":[
        "step",
        "stepIndex",
        "statusCode",
        "body"
    ],
    "properties":{
        "step":{
            "type":"string"
        },
        "stepIndex":{
            "type":"integer"
        },
        "statusCode":{
            "type":"integer"
        },
        "body":{
            "description":"Parsed rpc-proxy response body, or the unparsed response text."
        }
    }
}

502 Response

A combined rpc-proxy step could not be invoked or reported a failed receipt.

Body ()

Root Schema : CombinedApi_FailureResponse

Type: object

Show Source

• error(required): string
• failedStep(required): string
• failedStepBody:
  Parsed response body from the failed step when available.
• failedStepIndex(required): integer
• status(required): string
• steps(required): array steps

{
    "type":"object",
    "required":[
        "status",
        "failedStep",
        "failedStepIndex",
        "error",
        "steps"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"failed"
        },
        "failedStep":{
            "type":"string"
        },
        "failedStepIndex":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        },
        "failedStepBody":{
            "description":"Parsed response body from the failed step when available."
        },
        "steps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinedApi_StepResult"
            }
        }
    }
}

Nested Schema : steps

Type: array

Show Source

• Array of: object CombinedApi_StepResult

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

Nested Schema : CombinedApi_StepResult

Type: object

Show Source

• body(required):
  Parsed rpc-proxy response body, or the unparsed response text.
• statusCode(required): integer
• step(required): string
• stepIndex(required): integer

{
    "type":"object",
    "required":[
        "step",
        "stepIndex",
        "statusCode",
        "body"
    ],
    "properties":{
        "step":{
            "type":"string"
        },
        "stepIndex":{
            "type":"integer"
        },
        "statusCode":{
            "type":"integer"
        },
        "body":{
            "description":"Parsed rpc-proxy response body, or the unparsed response text."
        }
    }
}

Back to Top