Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cancelled

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly [resDataKey]

[resDataKey]: "cancelled"

Readonly client

client: SwedbankPayClient

Readonly id

id: string

Readonly lastFetched

lastFetched: undefined | Date = undefined

Methods

getAll

  • getAll(forceFresh?: boolean): Promise<MaybePopulated<{ amount: number; cancelReason: string; details?: { externalNonPaymentToken?: string; nonPaymentToken?: string }; instrument: string; number: number; orderReference?: string; payeeReference: string; tokens?: readonly CancelledTokenResponse[] }>>

  • 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<MaybePopulated<{ amount: number; cancelReason: string; details?: { externalNonPaymentToken?: string; nonPaymentToken?: string }; instrument: string; number: number; orderReference?: string; payeeReference: string; tokens?: readonly CancelledTokenResponse[] }>>

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>

getCancelReason

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

  • Get the reason for cancellation, fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

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 }>

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.

getTokens

Protected onData

Generated using TypeDoc