Skip to main content

Class: SystemPaymentProviderService

Hierarchy

  • TransactionBaseService

    SystemPaymentProviderService

Constructors

constructor

new SystemPaymentProviderService(_)

Parameters

NameType
_any

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/system-payment-provider.ts:10

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/system-payment-provider.ts:5


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/system-payment-provider.ts:6


identifier

Static identifier: string = "system"

Defined in

packages/medusa/src/services/system-payment-provider.ts:8

Methods

atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

NameTypeDescription
work(transactionManager: EntityManager) => Promise<TResult>the transactional work to be done
isolationOrErrorHandler?IsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?(error: TError) => Promise<void | TResult>Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50


authorizePayment

authorizePayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:26


cancelPayment

cancelPayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:50


capturePayment

capturePayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:42


createPayment

createPayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:14


deletePayment

deletePayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:38


getPaymentData

getPaymentData(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:22


getStatus

getStatus(_): Promise<string>

Parameters

NameType
_any

Returns

Promise<string>

Defined in

packages/medusa/src/services/system-payment-provider.ts:18


refundPayment

refundPayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:46


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31


updatePayment

updatePayment(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:34


updatePaymentData

updatePaymentData(_): Promise<Record<string, unknown>>

Parameters

NameType
_any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/src/services/system-payment-provider.ts:30


withTransaction

withTransaction(transactionManager?): SystemPaymentProviderService

Parameters

NameType
transactionManager?EntityManager

Returns

SystemPaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14