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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: PaymentProviderService

internal.internal.PaymentProviderService

Helps retrieve payment providers

Hierarchy

• TransactionBaseService

  ↳ PaymentProviderService

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

---

container_

• Protected Readonly container_: InjectedDependencies

Defined in

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

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

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

---

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

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

---

logger_

• Protected Readonly logger_: Logger

Defined in

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

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

paymentProviderRepository_

• Protected Readonly paymentProviderRepository_: Repository<PaymentProvider>

Defined in

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

---

paymentRepository_

• Protected Readonly paymentRepository_: Repository<Payment>

Defined in

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

---

paymentSessionRepository_

• Protected Readonly paymentSessionRepository_: Repository<PaymentSession>

Defined in

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

---

refundRepository_

• Protected Readonly refundRepository_: Repository<Refund>

Defined in

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

---

throwFromPaymentProcessorError

• Private throwFromPaymentProcessorError: any

Defined in

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

---

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

---

paymentService_

• Protected get paymentService_(): PaymentService

Returns

PaymentService

Defined in

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

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<undefined | PaymentSession>

Parameters

Name	Type
paymentSession	PaymentSession
context	Record<string, unknown>

Returns

Promise<undefined | PaymentSession>

Defined in

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

---

buildPaymentProcessorContext

▸ Protected buildPaymentProcessorContext(cartOrData): Cart & PaymentContext

Build the create session context for both legacy and new API

Parameters

Name	Type
cartOrData	Cart | PaymentSessionInput

Returns

Cart & PaymentContext

Defined in

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

---

cancelPayment

▸ cancelPayment(paymentObj): Promise<Payment>

Parameters

Name	Type
paymentObj	Partial<Payment> & { id: string }

Returns

Promise<Payment>

Defined in

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

---

capturePayment

▸ capturePayment(paymentObj): Promise<Payment>

Parameters

Name	Type
paymentObj	Partial<Payment> & { id: string }

Returns

Promise<Payment>

Defined in

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

---

createPayment

▸ createPayment(data): Promise<Payment>

Parameters

Name	Type
data	CreatePaymentInput

Returns

Promise<Payment>

Defined in

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

---

createSession

▸ createSession(providerId, cart): Promise<PaymentSession>

Parameters

Name	Type
providerId	string
cart	Cart

Returns

Promise<PaymentSession>

Deprecated

Defined in

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

▸ createSession(sessionInput): Promise<PaymentSession>

Creates a payment session with the given provider.

Parameters

Name	Type
sessionInput	PaymentSessionInput

Returns

Promise<PaymentSession>

Defined in

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

---

deleteSession

▸ deleteSession(paymentSession): Promise<undefined | PaymentSession>

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<undefined | PaymentSession>

Defined in

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

---

getStatus

▸ getStatus(payment): Promise<PaymentSessionStatus>

Parameters

Name	Type
payment	Payment

Returns

Promise<PaymentSessionStatus>

Defined in

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

---

list

▸ list(): Promise<PaymentProvider[]>

Returns

Promise<PaymentProvider[]>

Defined in

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

---

listPayments

▸ listPayments(selector, config?): Promise<Payment[]>

List all the payments according to the given selector and config.

Parameters

Name	Type
selector	Selector<Payment>
config?	FindConfig<Payment>

Returns

Promise<Payment[]>

Defined in

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

---

processUpdateRequestsData

▸ Protected processUpdateRequestsData(data, paymentResponse): Promise<void>

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

Parameters

Name	Type
data	undefined | { customer?: { id?: string } }
paymentResponse	Record<string, unknown> | PaymentSessionResponse

Returns

Promise<void>

Defined in

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

---

refreshSession

▸ refreshSession(paymentSession, sessionInput): Promise<PaymentSession>

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

Parameters

Name	Type	Description
paymentSession	Object	the payment session object to update
paymentSession.data	Record<string, unknown>	-
paymentSession.id	string	-
paymentSession.provider_id	string	-
sessionInput	PaymentSessionInput

Returns

Promise<PaymentSession>

the payment session

Defined in

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

---

refundFromPayment

▸ refundFromPayment(payment, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
payment	Payment
amount	number
reason	string
note?	string

Returns

Promise<Refund>

Defined in

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

---

refundPayment

▸ refundPayment(payObjs, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
payObjs	Payment[]
amount	number
reason	string
note?	string

Returns

Promise<Refund>

Defined in

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

---

registerInstalledProviders

▸ registerInstalledProviders(providerIds): Promise<void>

Parameters

Name	Type
providerIds	string[]

Returns

Promise<void>

Defined in

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

---

retrievePayment

▸ retrievePayment(paymentId, relations?): Promise<Payment>

Retrieve a payment entity with the given id.

Parameters

Name	Type
paymentId	string
relations?	string[]

Returns

Promise<Payment>

Defined in

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

---

retrieveProvider

▸ retrieveProvider<TProvider>(providerId): TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any

Finds a provider given an id

Type parameters

Name	Type
TProvider	extends unknown

Parameters

Name	Type	Description
providerId	string	the id of the provider to get

Returns

TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any

the payment provider

Defined in

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

---

retrieveRefund

▸ retrieveRefund(id, config?): Promise<Refund>

Parameters

Name	Type
id	string
config?	FindConfig<Refund>

Returns

Promise<Refund>

Defined in

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

---

retrieveSession

▸ retrieveSession(paymentSessionId, relations?): Promise<PaymentSession>

Return the payment session for the given id.

Parameters

Name	Type
paymentSessionId	string
relations?	string[]

Returns

Promise<PaymentSession>

Defined in

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

---

saveSession

▸ Protected saveSession(providerId, data): Promise<PaymentSession>

Create or update a Payment session data.

Parameters

Name	Type
providerId	string
data	Object
data.amount?	number
data.cartId?	string
data.isInitiated?	boolean
data.isSelected?	boolean
data.payment_session_id?	string
data.sessionData	Record<string, unknown>
data.status?	PaymentSessionStatus

Returns

Promise<PaymentSession>

Defined in

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

---

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(paymentId, data): Promise<Payment>

Parameters

Name	Type
paymentId	string
data	Object
data.order_id?	string
data.swap_id?	string

Returns

Promise<Payment>

Defined in

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

---

updateSession

▸ updateSession(paymentSession, sessionInput): Promise<PaymentSession>

Update a payment session with the given provider.

Parameters

Name	Type	Description
paymentSession	Object	The paymentSession to update
paymentSession.data	Record<string, unknown>	-
paymentSession.id	string	-
paymentSession.provider_id	string	-
sessionInput	Cart | PaymentSessionInput

Returns

Promise<PaymentSession>

the payment session

Defined in

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

---

updateSessionData

▸ updateSessionData(paymentSession, data): Promise<PaymentSession>

Parameters

Name	Type
paymentSession	PaymentSession
data	Record<string, unknown>

Returns

Promise<PaymentSession>

Defined in

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

---

withTransaction

▸ withTransaction(transactionManager?): PaymentProviderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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