Class: PaymentProviderService

Helps retrieve payment providers

Hierarchy

• TransactionBaseServiceCopy to Clipboard

  ↳ PaymentProviderServiceCopy to Clipboard

Constructors

constructor

• new PaymentProviderService(containerCopy to Clipboard)

Parameters

Name	Type
containerCopy to Clipboard	InjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/payment-provider.ts:64

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

---

container_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard container_: InjectedDependenciesCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:53

---

customerService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customerService_: CustomerServiceCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:59

---

featureFlagRouter_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard featureFlagRouter_: FlagRouterCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:62

---

logger_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard logger_: LoggerCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:60

---

manager_

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/payment-provider.ts:51

---

paymentProviderRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentProviderRepository_: typeof PaymentProviderRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:56

---

paymentRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentRepository_: typeof PaymentRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:57

---

paymentSessionRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard paymentSessionRepository_: typeof PaymentSessionRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:54

---

refundRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard refundRepository_: typeof RefundRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:58

---

transactionManager_

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

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/payment-provider.ts:52

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

Name	Type	Description
workCopy to Clipboard	(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>	the transactional work to be done
isolationOrErrorHandler?Copy to Clipboard	IsolationLevelCopy 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(paymentSessionCopy to Clipboard, contextCopy to Clipboard): PromiseCopy to Clipboard<undefinedCopy to Clipboard | PaymentSessionCopy to Clipboard>

Parameters

Name	Type
paymentSessionCopy to Clipboard	PaymentSessionCopy to Clipboard
contextCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Returns

PromiseCopy to Clipboard<undefinedCopy to Clipboard | PaymentSessionCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:395

---

buildPaymentProcessorContext

▸ ProtectedCopy to Clipboard buildPaymentProcessorContext(cartOrDataCopy to Clipboard): CartCopy to Clipboard & PaymentContextCopy to Clipboard

Build the create session context for both legacy and new API

Parameters

Name	Type
cartOrDataCopy to Clipboard	CartCopy to Clipboard | PaymentSessionInputCopy to Clipboard

Returns

CartCopy to Clipboard & PaymentContextCopy to Clipboard

Defined in

packages/medusa/src/services/payment-provider.ts:641

---

cancelPayment

▸ cancelPayment(paymentObjCopy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Parameters

Name	Type
paymentObjCopy to Clipboard	PartialCopy to Clipboard<PaymentCopy to Clipboard> & { idCopy to Clipboard: stringCopy to Clipboard }

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:448

---

capturePayment

▸ capturePayment(paymentObjCopy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Parameters

Name	Type
paymentObjCopy to Clipboard	PartialCopy to Clipboard<PaymentCopy to Clipboard> & { idCopy to Clipboard: stringCopy to Clipboard }

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:473

---

createPayment

▸ createPayment(dataCopy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Parameters

Name	Type
dataCopy to Clipboard	CreatePaymentInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:357

---

createSession

▸ createSession<TInputCopy to Clipboard>(providerIdOrSessionInputCopy to Clipboard, ...cartCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Creates a payment session with the given provider.

Type parameters

Name	Type
TInputCopy to Clipboard	extends stringCopy to Clipboard | PaymentSessionInputCopy to Clipboard = stringCopy to Clipboard | PaymentSessionInputCopy to Clipboard

Parameters

Name	Type	Description
providerIdOrSessionInputCopy to Clipboard	TInputCopy to Clipboard	the id of the provider to create payment with or the input data
...cartCopy to Clipboard	TInputCopy to Clipboard extends stringCopy to Clipboard ? [CartCopy to Clipboard] : [undefined?]	a cart object used to calculate the amount, etc. from

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

the payment session

Defined in

packages/medusa/src/services/payment-provider.ts:180

---

deleteSession

▸ deleteSession(paymentSessionCopy to Clipboard): PromiseCopy to Clipboard<undefinedCopy to Clipboard | PaymentSessionCopy to Clipboard>

Parameters

Name	Type
paymentSessionCopy to Clipboard	PaymentSessionCopy to Clipboard

Returns

PromiseCopy to Clipboard<undefinedCopy to Clipboard | PaymentSessionCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:303

---

getStatus

▸ getStatus(paymentCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionStatusCopy to Clipboard>

Parameters

Name	Type
paymentCopy to Clipboard	PaymentCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentSessionStatusCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:468

---

list

▸ list(): PromiseCopy to Clipboard<PaymentProviderCopy to Clipboard[]>

Returns

PromiseCopy to Clipboard<PaymentProviderCopy to Clipboard[]>

Defined in

packages/medusa/src/services/payment-provider.ts:97

---

listPayments

▸ listPayments(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard[]>

Parameters

Name	Type
selectorCopy to Clipboard	SelectorCopy to Clipboard<PaymentCopy to Clipboard>
configCopy to Clipboard	FindConfigCopy to Clipboard<PaymentCopy to Clipboard>

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard[]>

Defined in

packages/medusa/src/services/payment-provider.ts:132

---

processUpdateRequestsData

▸ ProtectedCopy to Clipboard processUpdateRequestsData(data?Copy to Clipboard, paymentResponseCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Process the collected data. Can be used every time we need to process some collected data returned by the provider

Parameters

Name	Type
dataCopy to Clipboard	ObjectCopy to Clipboard
data.customer?Copy to Clipboard	ObjectCopy to Clipboard
data.customer.id?Copy to Clipboard	stringCopy to Clipboard
paymentResponseCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | PaymentSessionResponseCopy to Clipboard

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:731

---

refreshSession

▸ refreshSession(paymentSessionCopy to Clipboard, sessionInputCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Refreshes a payment session with the given provider. This means, that we delete the current one and create a new.

Parameters

Name	Type	Description
paymentSessionCopy to Clipboard	ObjectCopy to Clipboard	the payment session object to update
paymentSession.dataCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>	-
paymentSession.idCopy to Clipboard	stringCopy to Clipboard	-
paymentSession.provider_idCopy to Clipboard	stringCopy to Clipboard	-
sessionInputCopy to Clipboard	PaymentSessionInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

the payment session

Defined in

packages/medusa/src/services/payment-provider.ts:238

---

refundFromPayment

▸ refundFromPayment(paymentCopy to Clipboard, amountCopy to Clipboard, reasonCopy to Clipboard, note?Copy to Clipboard): PromiseCopy to Clipboard<RefundCopy to Clipboard>

Parameters

Name	Type
paymentCopy to Clipboard	PaymentCopy to Clipboard
amountCopy to Clipboard	numberCopy to Clipboard
reasonCopy to Clipboard	stringCopy to Clipboard
note?Copy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<RefundCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:578

---

refundPayment

▸ refundPayment(payObjsCopy to Clipboard, amountCopy to Clipboard, reasonCopy to Clipboard, note?Copy to Clipboard): PromiseCopy to Clipboard<RefundCopy to Clipboard>

Parameters

Name	Type
payObjsCopy to Clipboard	PaymentCopy to Clipboard[]
amountCopy to Clipboard	numberCopy to Clipboard
reasonCopy to Clipboard	stringCopy to Clipboard
note?Copy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<RefundCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:493

---

registerInstalledProviders

▸ registerInstalledProviders(providerIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters

Name	Type
providerIdsCopy to Clipboard	stringCopy to Clipboard[]

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:78

---

retrievePayment

▸ retrievePayment(idCopy to Clipboard, relations?Copy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Parameters

Name	Type	Default value
idCopy to Clipboard	stringCopy to Clipboard	undefinedCopy to Clipboard
relationsCopy to Clipboard	stringCopy to Clipboard[]	[]Copy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:104

---

retrieveProvider

▸ retrieveProvider<TProviderCopy to Clipboard>(providerIdCopy to Clipboard): TProviderCopy to Clipboard extends AbstractPaymentServiceCopy to Clipboard ? AbstractPaymentServiceCopy to Clipboard : anyCopy to Clipboard

Finds a provider given an id

Type parameters

Name	Type
TProviderCopy to Clipboard	extends unknownCopy to Clipboard

Parameters

Name	Type	Description
providerIdCopy to Clipboard	stringCopy to Clipboard	the id of the provider to get

Returns

TProviderCopy to Clipboard extends AbstractPaymentServiceCopy to Clipboard ? AbstractPaymentServiceCopy to Clipboard : anyCopy to Clipboard

the payment provider

Defined in

packages/medusa/src/services/payment-provider.ts:333

---

retrieveRefund

▸ retrieveRefund(idCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<RefundCopy to Clipboard>

Parameters

Name	Type
idCopy to Clipboard	stringCopy to Clipboard
configCopy to Clipboard	FindConfigCopy to Clipboard<RefundCopy to Clipboard>

Returns

PromiseCopy to Clipboard<RefundCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:618

---

retrieveSession

▸ retrieveSession(idCopy to Clipboard, relations?Copy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Parameters

Name	Type	Default value
idCopy to Clipboard	stringCopy to Clipboard	undefinedCopy to Clipboard
relationsCopy to Clipboard	stringCopy to Clipboard[]	[]Copy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:145

---

saveSession

▸ ProtectedCopy to Clipboard saveSession(providerIdCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Create or update a Payment session data.

Parameters

Name	Type
providerIdCopy to Clipboard	stringCopy to Clipboard
dataCopy to Clipboard	ObjectCopy to Clipboard
data.amount?Copy to Clipboard	numberCopy to Clipboard
data.cartId?Copy to Clipboard	stringCopy to Clipboard
data.isInitiated?Copy to Clipboard	booleanCopy to Clipboard
data.isSelected?Copy to Clipboard	booleanCopy to Clipboard
data.payment_session_id?Copy to Clipboard	stringCopy to Clipboard
data.sessionDataCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
data.status?Copy to Clipboard	PaymentSessionStatusCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:681

---

shouldRetryTransaction_

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

Parameters

Name	Type
errCopy to Clipboard	RecordCopy 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(paymentIdCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Parameters

Name	Type
paymentIdCopy to Clipboard	stringCopy to Clipboard
dataCopy to Clipboard	ObjectCopy to Clipboard
data.order_id?Copy to Clipboard	stringCopy to Clipboard
data.swap_id?Copy to Clipboard	stringCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:383

---

updateSession

▸ updateSession(paymentSessionCopy to Clipboard, sessionInputCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Update a payment session with the given provider.

Parameters

Name	Type	Description
paymentSessionCopy to Clipboard	ObjectCopy to Clipboard	The paymentSession to update
paymentSession.dataCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>	-
paymentSession.idCopy to Clipboard	stringCopy to Clipboard	-
paymentSession.provider_idCopy to Clipboard	stringCopy to Clipboard	-
sessionInputCopy to Clipboard	CartCopy to Clipboard | PaymentSessionInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

the payment session

Defined in

packages/medusa/src/services/payment-provider.ts:268

---

updateSessionData

▸ updateSessionData(paymentSessionCopy to Clipboard, dataCopy to Clipboard): PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Parameters

Name	Type
paymentSessionCopy to Clipboard	PaymentSessionCopy to Clipboard
dataCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Returns

PromiseCopy to Clipboard<PaymentSessionCopy to Clipboard>

Defined in

packages/medusa/src/services/payment-provider.ts:427

---

withTransaction

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

Parameters

Name	Type
transactionManager?Copy to Clipboard	EntityManagerCopy to Clipboard

Returns

PaymentProviderServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

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