FeepayerApi

FeepayerApi

new FeepayerApi()

Version:
  • 1.0

Feepayer service.

Methods

creatFeePayerAccount(opts, callback)

Create fee payer account Create a Klaytn fee payer account. Generate a Klaytn account address and random private/public key pair and get ID of public key and private key returned. Klaytn fee payer account should be updated to AccountKeyRoleBased and can only be used for fee delegation.

Parameters:
Name Type Description
opts Object

Optional parameters

callback FeepayerApi~creatFeePayerAccountCallback

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

deleteFeePayerAccount(callback)

Delete fee payer account Delete a certain Klaytn fee payer account.

Parameters:
Name Type Description
callback FeepayerApi~deleteFeePayerAccountCallback

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

retrieveFeePayerAccount(callback)

Retrieve account Retrieve a certain Klaytn fee payer account.

Parameters:
Name Type Description
callback FeepayerApi~retrieveFeePayerAccountCallback

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

retrieveFeePayerAccounts(opts, callback)

Retrieve a list of fee payer accounts Retrieve a list of all Klaytn fee payer accounts.<p></p> ##### Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default value (`size=100`) when `size=0`<br> * Uses the maximum value (`size=1000`) when given a value higher than the maximum value.<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback FeepayerApi~retrieveFeePayerAccountsCallback

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

Type Definitions

creatFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the creatFeePayerAccount 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.

deleteFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the deleteFeePayerAccount 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.

retrieveFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the retrieveFeePayerAccount 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.

retrieveFeePayerAccountsCallback(error, data, response)

Callback function to receive the result of the retrieveFeePayerAccounts 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.

FeepayerApi

new FeepayerApi(apiClientopt)

Constructs a new FeepayerApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

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

Methods

creatFeePayerAccount(opts, callback)

Create fee payer account Create a Klaytn fee payer account. Generate a Klaytn account address and random private/public key pair and get ID of public key and private key returned. Klaytn fee payer account should be updated to AccountKeyRoleBased and can only be used for fee delegation.

Parameters:
Name Type Description
opts Object

Optional parameters

callback FeepayerApi~creatFeePayerAccountCallback

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

deleteFeePayerAccount(callback)

Delete fee payer account Delete a certain Klaytn fee payer account.

Parameters:
Name Type Description
callback FeepayerApi~deleteFeePayerAccountCallback

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

retrieveFeePayerAccount(callback)

Retrieve account Retrieve a certain Klaytn fee payer account.

Parameters:
Name Type Description
callback FeepayerApi~retrieveFeePayerAccountCallback

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

retrieveFeePayerAccounts(opts, callback)

Retrieve a list of fee payer accounts Retrieve a list of all Klaytn fee payer accounts.<p></p> ##### Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default value (`size=100`) when `size=0`<br> * Uses the maximum value (`size=1000`) when given a value higher than the maximum value.<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback FeepayerApi~retrieveFeePayerAccountsCallback

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

Type Definitions

creatFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the creatFeePayerAccount 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.

deleteFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the deleteFeePayerAccount 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.

retrieveFeePayerAccountCallback(error, data, response)

Callback function to receive the result of the retrieveFeePayerAccount 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.

retrieveFeePayerAccountsCallback(error, data, response)

Callback function to receive the result of the retrieveFeePayerAccounts 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.