medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: SystemPaymentProviderService

internal.internal.SystemPaymentProviderService

Hierarchy

• TransactionBaseService

  ↳ SystemPaymentProviderService

Properties

__configModule__

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

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

---

identifier

▪ Static identifier: string

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:3

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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

Name	Type	Description
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/dist/interfaces/transaction-base-service.d.ts:24

---

authorizePayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

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

---

cancelPayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

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

---

capturePayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:12

---

createPayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

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

---

deletePayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:11

---

getPaymentData

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:7

---

getStatus

▸ getStatus(_): Promise<string>

Parameters

Name	Type
_	any

Returns

Promise<string>

Defined in

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

---

refundPayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:13

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

updatePayment

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

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

---

updatePaymentData

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

Parameters

Name	Type
_	any

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/system-payment-provider.d.ts:9

---

withTransaction

▸ withTransaction(transactionManager?): SystemPaymentProviderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SystemPaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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