PaymentCollectionService

Hierarchy

• TransactionBaseService

  ↳ PaymentCollectionService

Constructors

constructor

new PaymentCollectionService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/payment-collection.ts:46

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

---

customerService_

Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/payment-collection.ts:42

---

eventBusService_

Protected Readonly eventBusService_: EventBusService

Defined in

medusa/src/services/payment-collection.ts:40

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

paymentCollectionRepository_

Protected Readonly paymentCollectionRepository_: Repository<PaymentCollection> & { getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }

Defined in

medusa/src/services/payment-collection.ts:44

---

paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/payment-collection.ts:41

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

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

---

Events

Static Readonly Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
PAYMENT_AUTHORIZED	string
UPDATED	string

Defined in

medusa/src/services/payment-collection.ts:33

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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

---

authorizePaymentSessions

authorizePaymentSessions(paymentCollectionId, sessionIds, context?): Promise<PaymentCollection>

Authorizes the payment sessions of a payment collection.

Parameters

Name	Description
paymentCollectionId	string
sessionIds	string[]
context	Record<string, unknown>

Returns

Promise<PaymentCollection>

-Promise: the payment collection and its payment session. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:528

---

create

create(data): Promise<PaymentCollection>

Creates a new payment collection.

Parameters

Name	Description
data	CreatePaymentCollectionInput

Returns

Promise<PaymentCollection>

-Promise: the payment collection created. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:103

---

delete

delete(paymentCollectionId): Promise<undefined | PaymentCollection>

Deletes a payment collection.

Parameters

Name	Description
paymentCollectionId	string

Returns

Promise<undefined | PaymentCollection>

-Promise: the payment collection removed. -undefined \| PaymentCollection: (optional)

Defined in

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

---

isValidTotalAmount

Private isValidTotalAmount(total, sessionsInput): boolean

Parameters

Name
total
sessionsInput

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/payment-collection.ts:210

---

markAsAuthorized

markAsAuthorized(paymentCollectionId): Promise<PaymentCollection>

Marks a payment collection as authorized bypassing the payment flow.

Parameters

Name	Description
paymentCollectionId	string

Returns

Promise<PaymentCollection>

-Promise: the payment session authorized. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:499

---

refreshPaymentSession

refreshPaymentSession(paymentCollectionId, sessionId, customerId): Promise<PaymentSession>

Removes and recreate a payment session of a payment collection.

Parameters

Name	Description
paymentCollectionId	string
sessionId	string
customerId	string

Returns

Promise<PaymentSession>

-Promise: the new payment session created. -PaymentSession:

Defined in

medusa/src/services/payment-collection.ts:406

---

retrieve

retrieve(paymentCollectionId, config?): Promise<PaymentCollection>

Retrieves a payment collection by id.

Parameters

Name	Description
paymentCollectionId	string
config	FindConfig<PaymentCollection>

Returns

Promise<PaymentCollection>

-Promise: the payment collection. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:67

---

setPaymentSession

setPaymentSession(paymentCollectionId, sessionInput, customerId): Promise<PaymentCollection>

Manages a single payment sessions of a payment collection.

Parameters

Name	Description
paymentCollectionId	string
sessionInput	PaymentCollectionsSessionsInput
customerId	string

Returns

Promise<PaymentCollection>

-Promise: the payment collection and its payment session. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:360

---

setPaymentSessionsBatch

setPaymentSessionsBatch(paymentCollectionOrId, sessionsInput, customerId): Promise<PaymentCollection>

Manages multiple payment sessions of a payment collection.

Parameters

Name	Description
paymentCollectionOrId	string | PaymentCollection
sessionsInput	PaymentCollectionsSessionsBatchInput[]
customerId	string

Returns

Promise<PaymentCollection>

-Promise: the payment collection and its payment sessions. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:225

---

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

---

update

update(paymentCollectionId, data): Promise<PaymentCollection>

Updates a payment collection.

Parameters

Name	Description
paymentCollectionId	string
data	DeepPartial<PaymentCollection>

Returns

Promise<PaymentCollection>

-Promise: the payment collection updated. -PaymentCollection:

Defined in

medusa/src/services/payment-collection.ts:138

---

withTransaction

withTransaction(transactionManager?): PaymentCollectionService

Parameters

Name
transactionManager?

Returns

PaymentCollectionService

-default:

Inherited from

TransactionBaseService.withTransaction

Defined in

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