Class TransactionPayment

Fields for a payment transaction. Definition: data/transactions/payment.go : PaymentTxnFields

Implements

Encodable

Index

Constructors

constructor

new TransactionPayment(__namedParameters): TransactionPayment
Creates a new TransactionPayment object.
Parameters
- __namedParameters: {
      amount: number | bigint;
      closeAmount?: number | bigint;
      closeRemainderTo?: string;
      receiver: string;
  }
  - amount: number | bigint
  - Optional closeAmount?: number | bigint
  - Optional closeRemainderTo?: string
  - receiver: string
Returns TransactionPayment
- Defined in client/v2/indexer/models/types.ts:8373

Properties

amount

amount: bigint

(amt) number of MicroAlgos intended to be transferred.

`Optional` closeAmount

closeAmount?: bigint

Number of MicroAlgos that were sent to the close-remainder-to address when closing the sender account.

`Optional` closeRemainderTo

closeRemainderTo?: string

(close) when set, indicates that the sending account should be closed and all remaining funds be transferred to this address.

receiver

receiver: string

(rcv) receiver's address.

`Static` `Private` encodingSchemaValue

encodingSchemaValue: undefined | Schema

Accessors

`Static` encodingSchema

get encodingSchema(): Schema
Returns Schema
- Defined in client/v2/indexer/models/types.ts:8321

Methods

getEncodingSchema

getEncodingSchema(): Schema
Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.

Returns Schema
Implementation of Encodable.getEncodingSchema
- Defined in client/v2/indexer/models/types.ts:8394

toEncodingData

toEncodingData(): Map<string, unknown>
Extract the encoding data for this object. This data, after being prepared by the encoding Schema, can be encoded to msgpack or JSON.

Returns Map<string, unknown>
Implementation of Encodable.toEncodingData
- Defined in client/v2/indexer/models/types.ts:8398

`Static` fromEncodingData

fromEncodingData(data): TransactionPayment
Parameters
- data: unknown
Returns TransactionPayment
- Defined in client/v2/indexer/models/types.ts:8407

Class TransactionPayment

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: {
    amount: number | bigint;
    closeAmount?: number | bigint;
    closeRemainderTo?: string;
    receiver: string;
}

amount: number | bigint

`Optional` closeAmount?: number | bigint

`Optional` closeRemainderTo?: string

receiver: string

Returns TransactionPayment

Properties

amount

`Optional` closeAmount

`Optional` closeRemainderTo

receiver

`Static` `Private` encodingSchemaValue

Accessors

`Static` encodingSchema

Returns Schema

Methods

getEncodingSchema

Returns Schema

toEncodingData

Returns Map<string, unknown>

`Static` fromEncodingData

Parameters

data: unknown

Returns TransactionPayment

Settings

Member Visibility

Theme

On This Page

Class TransactionPayment

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { amount: number | bigint; closeAmount?: number | bigint; closeRemainderTo?: string; receiver: string; }

amount: number | bigint

Optional closeAmount?: number | bigint

Optional closeRemainderTo?: string

receiver: string

Returns TransactionPayment

Properties

amount

Optional closeAmount

Optional closeRemainderTo

receiver

Static Private encodingSchemaValue

Accessors

Static encodingSchema

Returns Schema

Methods

getEncodingSchema

Returns Schema

toEncodingData

Returns Map<string, unknown>

Static fromEncodingData

Parameters

data: unknown

Returns TransactionPayment

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
amount: number | bigint;
closeAmount?: number | bigint;
closeRemainderTo?: string;
receiver: string;
}

`Optional` closeAmount?: number | bigint

`Optional` closeRemainderTo?: string

`Optional` closeAmount

`Optional` closeRemainderTo

`Static` `Private` encodingSchemaValue

`Static` encodingSchema

`Static` fromEncodingData