Skip to main content

Class: SystemPaymentProviderService

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ SystemPaymentProviderServiceCopy to Clipboard

Constructors​

constructor​

• new SystemPaymentProviderService(_Copy to Clipboard)

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

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

Properties​

__configModule__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

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

__container__​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from​

TransactionBaseService.__container__

Defined in​

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

__moduleDeclaration__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

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

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.manager_

Defined in​

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

transactionManager_​

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.transactionManager_

Defined in​

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

identifier​

▪ StaticCopy to Clipboard identifier: stringCopy to Clipboard = "system"Copy to Clipboard

Defined in​

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

Methods​

atomicPhase_​

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters​

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns​

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from​

TransactionBaseService.atomicPhase_

Defined in​

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

authorizePayment​

▸ authorizePayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

cancelPayment​

▸ cancelPayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

capturePayment​

▸ capturePayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

createPayment​

▸ createPayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

deletePayment​

▸ deletePayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

getPaymentData​

▸ getPaymentData(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

getStatus​

▸ getStatus(_Copy to Clipboard): PromiseCopy to Clipboard<stringCopy to Clipboard>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<stringCopy to Clipboard>

Defined in​

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

refundPayment​

▸ refundPayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

shouldRetryTransaction_​

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters​

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns​

booleanCopy to Clipboard

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

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

updatePayment​

▸ updatePayment(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

updatePaymentData​

▸ updatePaymentData(_Copy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
_Copy to ClipboardanyCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

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

withTransaction​

▸ withTransaction(transactionManager?Copy to Clipboard): SystemPaymentProviderServiceCopy to Clipboard

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

SystemPaymentProviderServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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