PaymentProviderService

Helps retrieve payment providers

Hierarchy

• TransactionBaseService

  ↳ PaymentProviderService

Constructors

constructor

new PaymentProviderService(container)

Parameters

Name
container

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/payment-provider.ts:70

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

container_

Protected Readonly container_: InjectedDependencies

Defined in

medusa/src/services/payment-provider.ts:55

---

customerService_

Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/payment-provider.ts:65

---

featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/payment-provider.ts:68

---

logger_

Protected Readonly logger_: Logger

Defined in

medusa/src/services/payment-provider.ts:66

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

paymentProviderRepository_

Protected Readonly paymentProviderRepository_: Repository<PaymentProvider>

Defined in

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

---

paymentRepository_

Protected Readonly paymentRepository_: Repository<Payment>

Defined in

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

---

paymentSessionRepository_

Protected Readonly paymentSessionRepository_: Repository<PaymentSession>

Defined in

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

---

refundRepository_

Protected Readonly refundRepository_: Repository<Refund>

Defined in

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

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

---

paymentService_

Protected get paymentService_(): PaymentService

Returns

PaymentService

-default:

Defined in

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

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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

authorizePayment

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

Parameters

Name
paymentSession
context

Returns

Promise<undefined | PaymentSession>

-Promise: -undefined \| PaymentSession: (optional)

Defined in

medusa/src/services/payment-provider.ts:523

---

buildPaymentProcessorContext

Protected buildPaymentProcessorContext(cartOrData): Cart & PaymentContext

Build the create session context for both legacy and new API

Parameters

Name
cartOrData

Returns

Cart & PaymentContext

-Cart` & `PaymentContext: (optional)

Defined in

medusa/src/services/payment-provider.ts:845

---

cancelPayment

cancelPayment(paymentObj): Promise<Payment>

Parameters

Name
paymentObj

Returns

Promise<Payment>

-Promise: -Payment:

Defined in

medusa/src/services/payment-provider.ts:602

---

capturePayment

capturePayment(paymentObj): Promise<Payment>

Parameters

Name
paymentObj

Returns

Promise<Payment>

-Promise: -Payment:

Defined in

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

---

createPayment

createPayment(data): Promise<Payment>

Parameters

Name
data

Returns

Promise<Payment>

-Promise: -Payment:

Defined in

medusa/src/services/payment-provider.ts:471

---

createSession

createSession(providerId, cart): Promise<PaymentSession>

Parameters

Name
providerId
cart

Returns

Promise<PaymentSession>

-Promise: -PaymentSession:

Deprecated

Defined in

medusa/src/services/payment-provider.ts:205

createSession(sessionInput): Promise<PaymentSession>

Creates a payment session with the given provider.

Parameters

Name
sessionInput

Returns

Promise<PaymentSession>

-Promise: -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:211

---

deleteSession

deleteSession(paymentSession): Promise<undefined | PaymentSession>

Parameters

Name
paymentSession

Returns

Promise<undefined | PaymentSession>

-Promise: -undefined \| PaymentSession: (optional)

Defined in

medusa/src/services/payment-provider.ts:402

---

getStatus

getStatus(payment): Promise<PaymentSessionStatus>

Parameters

Name
payment

Returns

Promise<PaymentSessionStatus>

-Promise:

Defined in

medusa/src/services/payment-provider.ts:630

---

list

list(): Promise<PaymentProvider[]>

Returns

Promise<PaymentProvider[]>

-Promise: -PaymentProvider[]: -PaymentProvider:

Defined in

medusa/src/services/payment-provider.ts:102

---

listPayments

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

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

Parameters

Name
selector
config

Returns

Promise<Payment[]>

-Promise: -Payment[]: -Payment:

Defined in

medusa/src/services/payment-provider.ts:154

---

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
data
data.customer?
data.customer.id?
paymentResponse

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/payment-provider.ts:935

---

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	Description
paymentSession	object
paymentSession.data	Record<string, unknown>
paymentSession.id	string
paymentSession.provider_id	string
sessionInput	PaymentSessionInput

Returns

Promise<PaymentSession>

-Promise: the payment session -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:301

---

refundFromPayment

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

Parameters

Name
payment
amount
reason
note?

Returns

Promise<Refund>

-Promise: -Refund:

Defined in

medusa/src/services/payment-provider.ts:771

---

refundPayment

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

Parameters

Name
payObjs
amount
reason
note?

Returns

Promise<Refund>

-Promise: -Refund:

Defined in

medusa/src/services/payment-provider.ts:672

---

registerInstalledProviders

registerInstalledProviders(providerIds): Promise<void>

Parameters

Name
providerIds

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/payment-provider.ts:83

---

retrievePayment

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

Retrieve a payment entity with the given id.

Parameters

Name	Default value
paymentId	string
relations	string[]

Returns

Promise<Payment>

-Promise: -Payment:

Defined in

medusa/src/services/payment-provider.ts:114

---

retrieveProvider

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

Finds a provider given an id

Name	Type
TProvider	unknown

Parameters

Name	Description
providerId	string

Returns

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

-TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `TProvider` extends `AbstractPaymentProcessor` ? `AbstractPaymentProcessor` : `any: (optional) the payment provider

Defined in

medusa/src/services/payment-provider.ts:442

---

retrieveRefund

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

Parameters

Name
id
config

Returns

Promise<Refund>

-Promise: -Refund:

Defined in

medusa/src/services/payment-provider.ts:822

---

retrieveSession

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

Return the payment session for the given id.

Parameters

Name	Default value
paymentSessionId	string
relations	string[]

Returns

Promise<PaymentSession>

-Promise: -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:172

---

saveSession

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

Create or update a Payment session data.

Parameters

Name
providerId
data
data.amount?
data.cartId?
data.isInitiated?
data.isSelected?
data.payment_session_id?
data.sessionData
data.status?

Returns

Promise<PaymentSession>

-Promise: -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:887

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

throwFromPaymentProcessorError

Private throwFromPaymentProcessorError(errObj): void

Parameters

Name
errObj

Returns

void

-void: (optional)

Defined in

medusa/src/services/payment-provider.ts:954

---

updatePayment

updatePayment(paymentId, data): Promise<Payment>

Parameters

Name
paymentId
data
data.order_id?
data.swap_id?

Returns

Promise<Payment>

-Promise: -Payment:

Defined in

medusa/src/services/payment-provider.ts:512

---

updateSession

updateSession(paymentSession, sessionInput): Promise<PaymentSession>

Update a payment session with the given provider.

Parameters

Name	Description
paymentSession	object
paymentSession.data	Record<string, unknown>
paymentSession.id	string
paymentSession.provider_id	string
sessionInput	Cart | PaymentSessionInput

Returns

Promise<PaymentSession>

-Promise: the payment session -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:342

---

updateSessionData

updateSessionData(paymentSession, data): Promise<PaymentSession>

Parameters

Name
paymentSession
data

Returns

Promise<PaymentSession>

-Promise: -PaymentSession:

Defined in

medusa/src/services/payment-provider.ts:569

---

withTransaction

withTransaction(transactionManager?): PaymentProviderService

Parameters

Name
transactionManager?

Returns

PaymentProviderService

-default:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20