Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestPaymentMessage

Represents a RequestPaymentMessage.

Hierarchy

  • RequestPaymentMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional amount

amount?: IMoney

RequestPaymentMessage amount.

amount1000

amount1000: number | Long

RequestPaymentMessage amount1000.

Optional background

background?: IPaymentBackground

RequestPaymentMessage background.

currencyCodeIso4217

currencyCodeIso4217: string

RequestPaymentMessage currencyCodeIso4217.

expiryTimestamp

expiryTimestamp: number | Long

RequestPaymentMessage expiryTimestamp.

Optional noteMessage

noteMessage?: IMessage

RequestPaymentMessage noteMessage.

requestFrom

requestFrom: string

RequestPaymentMessage requestFrom.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • Decodes a RequestPaymentMessage message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns RequestPaymentMessage

    RequestPaymentMessage

Static decodeDelimited

  • Decodes a RequestPaymentMessage message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns RequestPaymentMessage

    RequestPaymentMessage

Static encode

  • Encodes the specified RequestPaymentMessage message. Does not implicitly verify messages.

    Parameters

    • message: IRequestPaymentMessage

      RequestPaymentMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • Encodes the specified RequestPaymentMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IRequestPaymentMessage

      RequestPaymentMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

  • Creates a RequestPaymentMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns RequestPaymentMessage

    RequestPaymentMessage

Static toObject

  • Creates a plain object from a RequestPaymentMessage message. Also converts values to other types if specified.

    Parameters

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a RequestPaymentMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc