medusa-store/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Interface: PaymentService

internal.internal.PaymentService

This will be

Deprecated

in the near future use the new PaymentProcessor interface instead

Hierarchy

• TransactionBaseService

  ↳ PaymentService

Implemented by

• AbstractPaymentService

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

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(paymentSession, context): Promise<{ data: Data ; status: PaymentSessionStatus }>

This will be

Parameters

Name	Type
paymentSession	PaymentSession
context	Data

Returns

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

Deprecated

in the near future use PaymentProcessor.authorizePayment instead

Defined in

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

---

cancelPayment

▸ cancelPayment(payment): Promise<Data>

This will be

Parameters

Name	Type
payment	Payment

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.cancelPayment instead

Defined in

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

---

capturePayment

▸ capturePayment(payment): Promise<Data>

This will be

Parameters

Name	Type
payment	Payment

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.capturePayment instead

Defined in

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

---

createPayment

▸ createPayment(context): Promise<PaymentSessionResponse>

This will be

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>

Deprecated

in the near future use PaymentProcessor.initiatePayment instead

Defined in

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

▸ 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

Defined in

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

---

deletePayment

▸ deletePayment(paymentSession): Promise<void>

This will be

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<void>

Deprecated

in the near future use PaymentProcessor.cancelPayment instead

Defined in

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

---

getIdentifier

▸ getIdentifier(): string

Returns

string

Defined in

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

---

getPaymentData

▸ getPaymentData(paymentSession): Promise<Data>

This will be

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.retrievePayment instead

Defined in

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

---

getStatus

▸ getStatus(data): Promise<PaymentSessionStatus>

This will be

Parameters

Name	Type
data	Data

Returns

Promise<PaymentSessionStatus>

Deprecated

in the near future use PaymentProcessor.getPaymentStatus instead

Defined in

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

---

refundPayment

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

This will be

Parameters

Name	Type
payment	Payment
refundAmount	number

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.refundPayment instead

Defined in

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

---

retrievePayment

▸ retrievePayment(paymentData): Promise<Data>

This will be

Parameters

Name	Type
paymentData	Data

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.retrievePayment instead

Defined in

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

---

retrieveSavedMethods

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

This will be

Parameters

Name	Type
customer	Customer

Returns

Promise<Data[]>

Deprecated

in the near future use PaymentProcessor.getSavedMethods instead

Defined in

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

---

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(paymentSessionData, context): Promise<Data | PaymentSessionResponse>

Parameters

Name	Type
paymentSessionData	Data
context	Cart & PaymentContext

Returns

Promise<Data | PaymentSessionResponse>

Defined in

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

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

This will be

Parameters

Name	Type
paymentSessionData	Data
cart	Cart

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.updatePayment instead

Defined in

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

---

updatePaymentData

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

This will be

Parameters

Name	Type
paymentSessionData	Data
data	Data

Returns

Promise<Data>

Deprecated

in the near future use PaymentProcessor.updatePayment instead

Defined in

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

---

withTransaction

▸ withTransaction(transactionManager?): PaymentService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PaymentService

Inherited from

TransactionBaseService.withTransaction

Defined in

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