medusa-store/docs/content/references/services/classes/PaymentProviderService.md

Class: PaymentProviderService

Helps retrieve payment providers

Hierarchy

• TransactionBaseService

  ↳ PaymentProviderService

Constructors

constructor

• new PaymentProviderService(container)

Parameters

Name	Type
container	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

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

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

---

container_

• Protected Readonly container_: InjectedDependencies

Defined in

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

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

---

paymentProviderRepository_

• Protected Readonly paymentProviderRepository_: typeof PaymentProviderRepository

Defined in

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

---

paymentRepository_

• Protected Readonly paymentRepository_: typeof PaymentRepository

Defined in

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

---

paymentSessionRepository_

• Protected Readonly paymentSessionRepository_: typeof PaymentSessionRepository

Defined in

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

---

refundRepository_

• Protected Readonly refundRepository_: typeof RefundRepository

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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/src/interfaces/transaction-base-service.ts:50

---

authorizePayment

▸ authorizePayment(paymentSession, context): Promise<undefined | PaymentSession>

Parameters

Name	Type
paymentSession	PaymentSession
context	Record<string, unknown>

Returns

Promise<undefined | PaymentSession>

Defined in

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

---

cancelPayment

▸ cancelPayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

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

---

capturePayment

▸ capturePayment(paymentObj): Promise<Payment>

Parameters

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

Returns

Promise<Payment>

Defined in

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

---

createPayment

▸ createPayment(cart): Promise<Payment>

Parameters

Name	Type
cart	Cart & { payment_session: PaymentSession }

Returns

Promise<Payment>

Defined in

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

---

createSession

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

Creates a payment session with the given provider.

Parameters

Name	Type	Description
providerId	string	the id of the provider to create payment with
cart	Cart	a cart object used to calculate the amount, etc. from

Returns

Promise<PaymentSession>

the payment session

Defined in

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

---

deleteSession

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

Parameters

Name	Type
paymentSession	PaymentSession

Returns

Promise<undefined | PaymentSession>

Defined in

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

---

getStatus

▸ getStatus(payment): Promise<PaymentSessionStatus>

Parameters

Name	Type
payment	Payment

Returns

Promise<PaymentSessionStatus>

Defined in

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

---

list

▸ list(): Promise<PaymentProvider[]>

Returns

Promise<PaymentProvider[]>

Defined in

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

---

listPayments

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

Parameters

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

Returns

Promise<Payment[]>

Defined in

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

---

refreshSession

▸ refreshSession(paymentSession, cart): 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	PaymentSession	the payment session object to update
cart	Cart	a cart object used to calculate the amount, etc. from

Returns

Promise<PaymentSession>

the payment session

Defined in

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

---

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/src/services/payment-provider.ts:443

---

registerInstalledProviders

▸ registerInstalledProviders(providerIds): Promise<void>

Parameters

Name	Type
providerIds	string[]

Returns

Promise<void>

Defined in

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

---

retrievePayment

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

Parameters

Name	Type	Default value
id	string	undefined
relations	string[]	[]

Returns

Promise<Payment>

Defined in

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

---

retrieveProvider

▸ retrieveProvider<TProvider>(providerId): TProvider extends AbstractPaymentService<never> ? AbstractPaymentService<never> : 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<never> ? AbstractPaymentService<never> : any

the payment provider

Defined in

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

---

retrieveRefund

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

Parameters

Name	Type
id	string
config	FindConfig<Refund>

Returns

Promise<Refund>

Defined in

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

---

retrieveSession

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

Parameters

Name	Type	Default value
id	string	undefined
relations	string[]	[]

Returns

Promise<PaymentSession>

Defined in

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

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

---

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/src/services/payment-provider.ts:327

---

updateSession

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

Updates an existing payment session.

Parameters

Name	Type	Description
paymentSession	PaymentSession	the payment session object to update
cart	Cart	the cart object to update for

Returns

Promise<PaymentSession>

the updated payment session

Defined in

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

---

updateSessionData

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

Parameters

Name	Type
paymentSession	PaymentSession
data	Record<string, unknown>

Returns

Promise<PaymentSession>

Defined in

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

---

withTransaction

▸ withTransaction(transactionManager?): PaymentProviderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PaymentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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