Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PayeeInfo

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly [resDataKey]

[resDataKey]: "payeeInfo"

Readonly client

client: SwedbankPayClient

Readonly id

id: string

Readonly lastFetched

lastFetched: undefined | Date = undefined

Methods

getAll

  • getAll(forceFresh?: boolean): Promise<MaybePopulated<{ orderReference?: string; payeeId: string; payeeName: string; payeeReference: string; productCategory?: string }>>

  • 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<{ orderReference?: string; payeeId: string; payeeName: string; payeeReference: string; productCategory?: string }>>

Protected getFresh

getOrderReference

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

  • The order reference should reflect the order reference found in the merchant’s systems. Fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

getPayeeId

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

  • This is the unique id that identifies this payee (like merchant) set by Swedbank Pay Fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

getPayeeName

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

  • The payee name (like merchant name) that will be displayed when redirected to Swedbank Pay. 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>

  • A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation. See payeeReference for details. 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.

getProductCategory

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

  • A product category or number sent in from the payee/merchant. It is passed through the payment process and may be used in the settlement process. Fetches from Swedbank Pay backend if necessary.

    Parameters

    • Optional forceFresh: boolean

      Force a refresh from Swedbank Pay before resolving

    Returns Promise<null | string>

Protected onData

Generated using TypeDoc