Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Paid

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly [resDataKey]

[resDataKey]: "paid"

Readonly client

client: SwedbankPayClient

Readonly id

id: string

Readonly lastFetched

lastFetched: undefined | Date = undefined

Methods

getAll

  • getAll(forceFresh?: boolean): Promise<never & { id: string } & { amount: number; details?: { externalNonPaymentToken?: string; nonPaymentToken?: string }; discountAmount: number; feeAmount: number; id: string; instrument: string; number: number; orderReference?: string; payeeReference: string; submittedAmount: number; tokens?: readonly PaidTokenResponse[]; transactionType: "Authorization" | "Sale" | "Verification" }>

  • Get the full response from the object. Fetches from Swedbank Pay if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<never & { id: string } & { amount: number; details?: { externalNonPaymentToken?: string; nonPaymentToken?: string }; discountAmount: number; feeAmount: number; id: string; instrument: string; number: number; orderReference?: string; payeeReference: string; submittedAmount: number; tokens?: readonly PaidTokenResponse[]; transactionType: "Authorization" | "Sale" | "Verification" }>

getAmount

  • getAmount(forceFresh?: boolean): Promise<null | number>

  • Get the amount, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | number>

getDetails

  • getDetails(forceFresh?: boolean): Promise<{ externalNonPaymentToken?: string; nonPaymentToken?: string }>

  • Get the details, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<{ externalNonPaymentToken?: string; nonPaymentToken?: string }>

getDiscountAmount

  • getDiscountAmount(forceFresh?: boolean): Promise<null | number>

  • Get the discountAmount, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | number>

getFeeAmount

  • getFeeAmount(forceFresh?: boolean): Promise<null | number>

  • Get the feeAmount, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | number>

Protected getFresh

getInstrument

  • getInstrument(forceFresh?: boolean): Promise<null | string>

  • Get the payment instrument, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

getNumber

  • getNumber(forceFresh?: boolean): Promise<null | number>

  • Get the payment number, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | number>

getOrderReference

  • getOrderReference(forceFresh?: boolean): Promise<null | string>

  • Get the orderReference, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

getPayeeReference

  • getPayeeReference(forceFresh?: boolean): Promise<null | string>

  • Get the payeeReference, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

getPaymentOrderId

  • getPaymentOrderId(): Promise<null | string>

  • Get the ID of the parent paymentOrder. This will fetch the data from the backend if necessary. note, paymentOrder is not always available in the response.

    Returns Promise<null | string>

    A promise that resolves to the ID of the parent paymentOrder or null if not available.

getSubmittedAmount

  • getSubmittedAmount(forceFresh?: boolean): Promise<null | number>

  • Get the submittedAmount, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | number>

getTokens

getTransactionType

  • getTransactionType(forceFresh?: boolean): Promise<null | "Authorization" | "Sale" | "Verification">

  • Get the transactionType, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | "Authorization" | "Sale" | "Verification">

Protected onData

Generated using TypeDoc