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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AbstractPaymentService

internal.internal.AbstractPaymentService

This will be

Deprecated

in the near future use the AbstractPaymentProcessor instead

Hierarchy

• TransactionBaseService

  ↳ AbstractPaymentService

Implements

• PaymentService

Properties

__configModule__

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

Implementation of

PaymentService.configModule

Inherited from

TransactionBaseService.configModule

Defined in

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

---

__container__

• Protected Readonly __container__: any

Implementation of

PaymentService.container

Inherited from

TransactionBaseService.container

Defined in

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

---

__moduleDeclaration__

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

Implementation of

PaymentService.moduleDeclaration

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

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

---

manager_

• Protected manager_: EntityManager

Implementation of

PaymentService.manager_

Inherited from

TransactionBaseService.manager_

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Implementation of

PaymentService.transactionManager_

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/interfaces/payment-service.d.ts:112

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Implementation of

PaymentService.activeManager_

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

Implementation of

PaymentService.atomicPhase_

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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

---

authorizePayment

▸ Abstract authorizePayment(paymentSession, context): Promise<{ data: Data ; status: PaymentSessionStatus }>

Parameters

Name	Type
paymentSession	PaymentSession
context	Data

Returns

Promise<{ data: Data ; status: PaymentSessionStatus }>

Deprecated

Implementation of

PaymentService.authorizePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:152

---

cancelPayment

▸ Abstract cancelPayment(payment): Promise<Data>

This will be

Parameters

Name	Type
payment	Payment

Returns

Promise<Data>

Deprecated

in the near future

Implementation of

PaymentService.cancelPayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:167

---

capturePayment

▸ Abstract capturePayment(payment): Promise<Data>

This will be

Parameters

Name	Type
payment	Payment

Returns

Promise<Data>

Deprecated

in the near future

Implementation of

PaymentService.capturePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:159

---

createPayment

▸ Abstract createPayment(context): Promise<PaymentSessionResponse>

Parameters

Name	Type	Description
context	Cart & PaymentContext	The type of this argument is meant to be temporary and once the previous method signature will be removed, the type will only be PaymentContext instead of Cart & PaymentContext

Returns

Promise<PaymentSessionResponse>

Implementation of

PaymentService.createPayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:126

▸ Abstract createPayment(cart): Promise<Data>

This will be

Parameters

Name	Type
cart	Cart

Returns

Promise<Data>

Deprecated

in the near future use createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead

Implementation of

PaymentService.createPayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:131

---

deletePayment

▸ Abstract deletePayment(paymentSession): Promise<void>

This will be

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<void>

Deprecated

in the near future

Implementation of

PaymentService.deletePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:171

---

getIdentifier

▸ getIdentifier(): string

Returns

string

Implementation of

PaymentService.getIdentifier

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:113

---

getPaymentData

▸ Abstract getPaymentData(paymentSession): Promise<Data>

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<Data>

Deprecated

Implementation of

PaymentService.getPaymentData

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:117

---

getStatus

▸ Abstract getStatus(data): Promise<PaymentSessionStatus>

This will be

Parameters

Name	Type
data	Data

Returns

Promise<PaymentSessionStatus>

Deprecated

in the near future

Implementation of

PaymentService.getStatus

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:179

---

refundPayment

▸ Abstract refundPayment(payment, refundAmount): Promise<Data>

This will be

Parameters

Name	Type
payment	Payment
refundAmount	number

Returns

Promise<Data>

Deprecated

in the near future

Implementation of

PaymentService.refundPayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:163

---

retrievePayment

▸ Abstract retrievePayment(paymentData): Promise<Data>

Parameters

Name	Type
paymentData	Data

Returns

Promise<Data>

Deprecated

Implementation of

PaymentService.retrievePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:135

---

retrieveSavedMethods

▸ retrieveSavedMethods(customer): Promise<Data[]>

This will be

Parameters

Name	Type
customer	Customer

Returns

Promise<Data[]>

Deprecated

in the near future

Implementation of

PaymentService.retrieveSavedMethods

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:175

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Implementation of

PaymentService.shouldRetryTransaction_

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

updatePayment

▸ Abstract updatePayment(paymentSessionData, context): Promise<Record<string, unknown> | PaymentSessionResponse>

Parameters

Name	Type	Description
paymentSessionData	Data
context	Cart & PaymentContext	The type of this argument is meant to be temporary and once the previous method signature will be removed, the type will only be PaymentContext instead of Cart & PaymentContext

Returns

Promise<Record<string, unknown> | PaymentSessionResponse>

it return either a PaymentSessionResponse or PaymentSessionResponse["session_data"] to maintain backward compatibility

Implementation of

PaymentService.updatePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:142

▸ Abstract updatePayment(paymentSessionData, cart): Promise<Data>

This will be

Parameters

Name	Type
paymentSessionData	Data
cart	Cart

Returns

Promise<Data>

Deprecated

in the near future use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead

Implementation of

PaymentService.updatePayment

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:148

---

updatePaymentData

▸ Abstract updatePaymentData(paymentSessionData, data): Promise<Data>

Parameters

Name	Type
paymentSessionData	Data
data	Data

Returns

Promise<Data>

Deprecated

Implementation of

PaymentService.updatePaymentData

Defined in

packages/medusa/dist/interfaces/payment-service.d.ts:121

---

withTransaction

▸ withTransaction(transactionManager?): AbstractPaymentService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

AbstractPaymentService

Implementation of

PaymentService.withTransaction

Inherited from

TransactionBaseService.withTransaction

Defined in

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