Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Payment

Structure representing a Pi Network Payment.

Hierarchy

  • Payment

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

amount

amount: number

The amount of the payment.

Readonly client

client: Client

createdAt

createdAt: Date

The date when the payment was created.

createdTimestamp

createdTimestamp: number

The timestamp when the payment was created.

id

id: string

The id of the payment.

memo

memo: string

A string provided by the developer, shown to the user.

metadata

metadata: Record<string, unknown>

An object provided by the developer for their own usage.

recipientAdresse

recipientAdresse: string

The recipient address of the blockchain transaction.

status

status: PaymentStatus

The status flags representing the current state of the payment.

Optional transactionInfo

transactionInfo: PaymentTransaction

The blockchain transaction data, this is null if no transaction has been made yet.

userUid

userUid: string

The user's app-specific id.

Accessors

cancelled

  • get cancelled(): boolean

Methods

$patch

  • $patch(data: APIPayment): void

approve

complete

  • complete(): Promise<undefined | Payment>

getTransaction

  • getTransaction(forceUpdate?: boolean): Promise<undefined | Transaction>

  • Get the transaction of the payment if there is one.

    Parameters

    • forceUpdate: boolean = false

      If set to true, it will not check in the cache and directly make a request to retrieve the receiver transaction instead.

    Returns Promise<undefined | Transaction>

    The transaction of the payment if there is one.

Generated using TypeDoc