Skip to main content

Class: SystemPaymentProviderService

Hierarchy​

  • TransactionBaseService

    ↳ SystemPaymentProviderService

Constructors​

constructor​

• new SystemPaymentProviderService(_)

Parameters​

NameType
_any

Overrides​

TransactionBaseService.constructor

Defined in​

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

Properties​

__configModule__​

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

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


__container__​

• Protected Readonly __container__: any

Inherited from​

TransactionBaseService.__container__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:13


__moduleDeclaration__​

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:15


manager_​

• Protected manager_: EntityManager

Inherited from​

TransactionBaseService.manager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:5


transactionManager_​

• Protected transactionManager_: undefined | EntityManager

Inherited from​

TransactionBaseService.transactionManager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:6


identifier​

▪ Static identifier: string = "system"

Defined in​

medusa/src/services/system-payment-provider.ts:4

Accessors​

activeManager_​

• Protected get activeManager_(): EntityManager

Returns​

EntityManager

Inherited from​

TransactionBaseService.activeManager_

Defined in​

medusa/src/interfaces/transaction-base-service.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​

medusa/src/interfaces/transaction-base-service.ts:56


authorizePayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


cancelPayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


capturePayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


createPayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


deletePayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


getPaymentData​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


getStatus​

▸ getStatus(_): Promise<string>

Parameters​

NameType
_any

Returns​

Promise<string>

Defined in​

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


refundPayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


shouldRetryTransaction_​

▸ Protected shouldRetryTransaction_(err): boolean

Parameters​

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

Returns​

boolean

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:37


updatePayment​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


updatePaymentData​

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

Parameters​

NameType
_any

Returns​

Promise<Record<string, unknown>>

Defined in​

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


withTransaction​

▸ withTransaction(transactionManager?): SystemPaymentProviderService

Parameters​

NameType
transactionManager?EntityManager

Returns​

SystemPaymentProviderService

Inherited from​

TransactionBaseService.withTransaction

Defined in​

medusa/src/interfaces/transaction-base-service.ts:20

Was this section helpful?