AccountApi

AccountApi

new AccountApi()

Version:
  • 1.0

Account service.

Methods

activateAccount(xChainId, address, callback)

ActivateAccount Reactivate a deactivated Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~activateAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountSummary

createAccount(xChainId, callback)

CreateAccount Creates a Klaytn account. Creates random Klaytn account addresses and private/public key pairs, and returns public key and private key IDs.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
callback AccountApi~createAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: Account

deactivateAccount(xChainId, address, callback)

DeactivateAccount Deactivate a Klaytn account. If the account is deactivated, the account cannot be searched.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~deactivateAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountSummary

deleteAccount(xChainId, address, callback)

DeleteAccount Deletes Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~deleteAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountStatus

multisigAccountUpdate(xChainId, address, opts, callback)

MultisigAccountUpdate Update a Klaytn account to a multisig account. Sufficient balance is required for a transaction fee payment when executing the update transaction.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
opts Object

Optional parameters

Properties
Name Type Description
body MultisigAccountUpdateRequest
callback AccountApi~multisigAccountUpdateCallback

The callback function, accepting three arguments: error, data, response data is of type: MultisigAccount

retrieveAccount(xChainId, address, callback)

RetrieveAccount Search for a Klaytn account

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~retrieveAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: Account

retrieveAccounts(xChainId, opts, callback)

RetrieveAccounts Search for a list of existing Klaytn accounts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
opts Object

Optional parameters

Properties
Name Type Description
size Number

Maximum size of account to search (default to 100)
cursor String

Information on last searched cursor
toTimestamp Number

Timestamp of the end time to be searched (in seconds)
fromTimestamp Number

Timestamp of the start time to be searched (in seconds)
status String

(default to enabled)
callback AccountApi~retrieveAccountsCallback

The callback function, accepting three arguments: error, data, response data is of type: Accounts

retrieveAccountsByPubkey(xChainId, publicKey, callback)

RetrieveAccountsByPubkey Search for a list of Klaytn accounts with a public key.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
publicKey String

Klaytn public key
callback AccountApi~retrieveAccountsByPubkeyCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountsByPubkey

signTransactionIDResponse(xChainId, address, transactionId, callback)

SignTransactionIDResponse Sign transactions with a transaction ID using the corresponding Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
transactionId String

ID of transaction to be signed
callback AccountApi~signTransactionIDResponseCallback

The callback function, accepting three arguments: error, data, response data is of type: Signature

Type Definitions

activateAccountCallback(error, data, response)

Callback function to receive the result of the activateAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountSummary

The data returned by the service call.
response String

The complete HTTP response.

createAccountCallback(error, data, response)

Callback function to receive the result of the createAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Account

The data returned by the service call.
response String

The complete HTTP response.

deactivateAccountCallback(error, data, response)

Callback function to receive the result of the deactivateAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountSummary

The data returned by the service call.
response String

The complete HTTP response.

deleteAccountCallback(error, data, response)

Callback function to receive the result of the deleteAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountStatus

The data returned by the service call.
response String

The complete HTTP response.

multisigAccountUpdateCallback(error, data, response)

Callback function to receive the result of the multisigAccountUpdate operation.

Parameters:
Name Type Description
error String

Error message, if any.
data MultisigAccount

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountCallback(error, data, response)

Callback function to receive the result of the retrieveAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Account

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountsCallback(error, data, response)

Callback function to receive the result of the retrieveAccounts operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Accounts

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountsByPubkeyCallback(error, data, response)

Callback function to receive the result of the retrieveAccountsByPubkey operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountsByPubkey

The data returned by the service call.
response String

The complete HTTP response.

signTransactionIDResponseCallback(error, data, response)

Callback function to receive the result of the signTransactionIDResponse operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Signature

The data returned by the service call.
response String

The complete HTTP response.

AccountApi

new AccountApi(apiClientopt)

Constructs a new AccountApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

Optional API client implementation to use, default to ApiClient#instance if unspecified.

Methods

activateAccount(xChainId, address, callback)

ActivateAccount Reactivate a deactivated Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~activateAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountSummary

createAccount(xChainId, callback)

CreateAccount Creates a Klaytn account. Creates random Klaytn account addresses and private/public key pairs, and returns public key and private key IDs.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
callback AccountApi~createAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: Account

deactivateAccount(xChainId, address, callback)

DeactivateAccount Deactivate a Klaytn account. If the account is deactivated, the account cannot be searched.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~deactivateAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountSummary

deleteAccount(xChainId, address, callback)

DeleteAccount Deletes Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~deleteAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountStatus

multisigAccountUpdate(xChainId, address, opts, callback)

MultisigAccountUpdate Update a Klaytn account to a multisig account. Sufficient balance is required for a transaction fee payment when executing the update transaction.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
opts Object

Optional parameters

Properties
Name Type Description
body MultisigAccountUpdateRequest
callback AccountApi~multisigAccountUpdateCallback

The callback function, accepting three arguments: error, data, response data is of type: MultisigAccount

retrieveAccount(xChainId, address, callback)

RetrieveAccount Search for a Klaytn account

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
callback AccountApi~retrieveAccountCallback

The callback function, accepting three arguments: error, data, response data is of type: Account

retrieveAccounts(xChainId, opts, callback)

RetrieveAccounts Search for a list of existing Klaytn accounts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
opts Object

Optional parameters

Properties
Name Type Description
size Number

Maximum size of account to search (default to 100)
cursor String

Information on last searched cursor
toTimestamp Number

Timestamp of the end time to be searched (in seconds)
fromTimestamp Number

Timestamp of the start time to be searched (in seconds)
status String

(default to enabled)
callback AccountApi~retrieveAccountsCallback

The callback function, accepting three arguments: error, data, response data is of type: Accounts

retrieveAccountsByPubkey(xChainId, publicKey, callback)

RetrieveAccountsByPubkey Search for a list of Klaytn accounts with a public key.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
publicKey String

Klaytn public key
callback AccountApi~retrieveAccountsByPubkeyCallback

The callback function, accepting three arguments: error, data, response data is of type: AccountsByPubkey

signTransactionIDResponse(xChainId, address, transactionId, callback)

SignTransactionIDResponse Sign transactions with a transaction ID using the corresponding Klaytn account.

Parameters:
Name Type Description
xChainId String

Klaytn chain network ID (1001 or 8217)
address String

Klaytn account address
transactionId String

ID of transaction to be signed
callback AccountApi~signTransactionIDResponseCallback

The callback function, accepting three arguments: error, data, response data is of type: Signature

Type Definitions

activateAccountCallback(error, data, response)

Callback function to receive the result of the activateAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountSummary

The data returned by the service call.
response String

The complete HTTP response.

createAccountCallback(error, data, response)

Callback function to receive the result of the createAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Account

The data returned by the service call.
response String

The complete HTTP response.

deactivateAccountCallback(error, data, response)

Callback function to receive the result of the deactivateAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountSummary

The data returned by the service call.
response String

The complete HTTP response.

deleteAccountCallback(error, data, response)

Callback function to receive the result of the deleteAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountStatus

The data returned by the service call.
response String

The complete HTTP response.

multisigAccountUpdateCallback(error, data, response)

Callback function to receive the result of the multisigAccountUpdate operation.

Parameters:
Name Type Description
error String

Error message, if any.
data MultisigAccount

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountCallback(error, data, response)

Callback function to receive the result of the retrieveAccount operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Account

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountsCallback(error, data, response)

Callback function to receive the result of the retrieveAccounts operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Accounts

The data returned by the service call.
response String

The complete HTTP response.

retrieveAccountsByPubkeyCallback(error, data, response)

Callback function to receive the result of the retrieveAccountsByPubkey operation.

Parameters:
Name Type Description
error String

Error message, if any.
data AccountsByPubkey

The data returned by the service call.
response String

The complete HTTP response.

signTransactionIDResponseCallback(error, data, response)

Callback function to receive the result of the signTransactionIDResponse operation.

Parameters:
Name Type Description
error String

Error message, if any.
data Signature

The data returned by the service call.
response String

The complete HTTP response.