Skip to main content
Skip to main content

SystemPaymentProviderService

Constructors​

constructor​

**new SystemPaymentProviderService**(_)

Parameters​

_anyRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
identifierstringRequired

Default: "system"

Accessors​

activeManager_​

Protected get**activeManager_**(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

Methods​

atomicPhase_​

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

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.

TResultobjectRequired
TErrorobjectRequired

Parameters​

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (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>

PromisePromise<TResult>Required
the result of the transactional work

authorizePayment​

**authorizePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

cancelPayment​

**cancelPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

capturePayment​

**capturePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

createPayment​

**createPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

deletePayment​

**deletePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

getPaymentData​

**getPaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

getStatus​

**getStatus**(_): Promise&#60;string&#62;

Parameters​

_anyRequired

Returns​

Promise<string>

PromisePromise<string>Required

refundPayment​

**refundPayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

shouldRetryTransaction_​

Protected **shouldRetryTransaction_**(err): boolean

Parameters​

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

Returns​

boolean

booleanboolean

updatePayment​

**updatePayment**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

updatePaymentData​

**updatePaymentData**(_): Promise&#60;Record&#60;string, unknown&#62;&#62;

Parameters​

_anyRequired

Returns​

Promise<Record<string, unknown>>

PromisePromise<Record<string, unknown>>Required

withTransaction​

**withTransaction**(transactionManager?): [SystemPaymentProviderService](/references/services/classes/SystemPaymentProviderService)

Parameters​

transactionManagerEntityManager

Returns​

SystemPaymentProviderService

SystemProviderServiceSystemPaymentProviderServiceRequired
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.