Class Failed

Hierarchy

PaymentOrderEntity<typeof ENTITY_KEY, FailedResponse>
- Failed

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Failed(client: SwedbankPayClient, id: string): Failed

Overrides PaymentOrderEntity< typeof ENTITY_KEY, responseData.FailedResponse >.constructor
- Defined in src/LiveEntities/PaymentOrder/Failed.ts:11
Parameters
- client: SwedbankPayClient
- id: string
Returns Failed

Properties

Readonly [resDataKey]

[resDataKey]: "failed"

Readonly client

client: SwedbankPayClient

Readonly id

id: string

Readonly lastFetched

lastFetched: undefined | Date = undefined

Methods

getAll

getAll(forceFresh?: boolean): Promise<MaybePopulated<{ problem: FailedProblemResponse }>>

Inherited from PaymentOrderEntity.getAll
- Defined in src/LiveEntities/LazyEntity.ts:54
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<{ problem: FailedProblemResponse }>>

Protected getFresh

getFresh(force?: boolean): Promise<FailedResponse>

Inherited from PaymentOrderEntity.getFresh
- Defined in src/LiveEntities/LazyEntity.ts:25
Parameters
- Optional force: boolean
Returns Promise<FailedResponse>

getPaymentOrderId

getPaymentOrderId(): Promise<null | string>

Inherited from PaymentOrderEntity.getPaymentOrderId
- Defined in src/LiveEntities/PaymentOrder/paymentOrderEntity.ts:26
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.

getProblem

getProblem(forceFresh?: boolean): Promise<null | FailedProblemResponse>

- Defined in src/LiveEntities/PaymentOrder/Failed.ts:19
Get an object describing the problem related to the failure. Fetches from Swedbank Pay backend if necessary.

Parameters
- Optional forceFresh: boolean
  
  Force a refresh from Swedbank Pay before resolving
Returns Promise<null | FailedProblemResponse>

Protected onData

onData(res: FailedResponse): void

Inherited from PaymentOrderEntity.onData
- Defined in src/LiveEntities/PaymentOrder/paymentOrderEntity.ts:16
Parameters
- res: FailedResponse
Returns void

Generated using TypeDoc