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

Class: PaymentCollectionService

Hierarchy

• TransactionBaseService

  ↳ PaymentCollectionService

Constructors

constructor

• new PaymentCollectionService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

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

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

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

packages/medusa/src/services/payment-collection.ts:47

---

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

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

---

manager_

• Protected Readonly manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

---

paymentCollectionRepository_

• Protected Readonly paymentCollectionRepository_: typeof PaymentCollectionRepository

Defined in

packages/medusa/src/services/payment-collection.ts:49

---

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
PAYMENT_AUTHORIZED	string
UPDATED	string

Defined in

packages/medusa/src/services/payment-collection.ts:36

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

---

authorizePaymentSessions

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

Authorizes the payment sessions of a payment collection.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection
sessionIds	string[]	array of payment session ids to be authorized
context	Record<string, unknown>	additional data required by payment providers

Returns

Promise<PaymentCollection>

the payment collection and its payment session.

Defined in

packages/medusa/src/services/payment-collection.ts:535

---

create

▸ create(data): Promise<PaymentCollection>

Creates a new payment collection.

Parameters

Name	Type	Description
data	CreatePaymentCollectionInput	info to create the payment collection

Returns

Promise<PaymentCollection>

the payment collection created.

Defined in

packages/medusa/src/services/payment-collection.ts:111

---

delete

▸ delete(paymentCollectionId): Promise<undefined | PaymentCollection>

Deletes a payment collection.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection to be removed

Returns

Promise<undefined | PaymentCollection>

the payment collection removed.

Defined in

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

---

isValidTotalAmount

▸ Private isValidTotalAmount(total, sessionsInput): boolean

Parameters

Name	Type
total	number
sessionsInput	PaymentCollectionsSessionsBatchInput[]

Returns

boolean

Defined in

packages/medusa/src/services/payment-collection.ts:218

---

markAsAuthorized

▸ markAsAuthorized(paymentCollectionId): Promise<PaymentCollection>

Marks a payment collection as authorized bypassing the payment flow.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection

Returns

Promise<PaymentCollection>

the payment session authorized.

Defined in

packages/medusa/src/services/payment-collection.ts:506

---

refreshPaymentSession

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

Removes and recreate a payment session of a payment collection.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection
sessionId	string	the id of the payment session to be replaced
customerId	string	the id of the customer

Returns

Promise<PaymentSession>

the new payment session created.

Defined in

packages/medusa/src/services/payment-collection.ts:414

---

retrieve

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

Retrieves a payment collection by id.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection
config	FindConfig<PaymentCollection>	the config to retrieve the payment collection

Returns

Promise<PaymentCollection>

the payment collection.

Defined in

packages/medusa/src/services/payment-collection.ts:74

---

setPaymentSession

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

Manages a single payment sessions of a payment collection.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection
sessionInput	PaymentCollectionsSessionsInput	object containing payment session info
customerId	string	the id of the customer

Returns

Promise<PaymentCollection>

the payment collection and its payment session.

Defined in

packages/medusa/src/services/payment-collection.ts:368

---

setPaymentSessionsBatch

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

Manages multiple payment sessions of a payment collection.

Parameters

Name	Type	Description
paymentCollectionOrId	string | PaymentCollection	the id of the payment collection
sessionsInput	PaymentCollectionsSessionsBatchInput[]	array containing payment session info
customerId	string	the id of the customer

Returns

Promise<PaymentCollection>

the payment collection and its payment sessions.

Defined in

packages/medusa/src/services/payment-collection.ts:233

---

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

---

update

▸ update(paymentCollectionId, data): Promise<PaymentCollection>

Updates a payment collection.

Parameters

Name	Type	Description
paymentCollectionId	string	the id of the payment collection to update
data	Object	info to be updated
data.amount?	number	-
data.authorized_amount?	null | number	-
data.created_at?	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-
data.created_by?	string	-
data.currency?	{ code?: string | undefined; symbol?: string | undefined; symbol_native?: string | undefined; name?: string | undefined; includes_tax?: boolean | undefined; }	-
data.currency_code?	string	-
data.deleted_at?	null | { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-
data.description?	null | string	-
data.id?	string	-
data.metadata?	{ [x: string]: unknown; }	-
data.payment_sessions?	(undefined | { cart_id?: string | null | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; billing_address?: { customer_id?: string | ... 1 more ... | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 36 more ...; updated...)[]	-
data.payments?	(undefined | { swap_id?: string | undefined; swap?: { fulfillment_status?: SwapFulfillmentStatus | undefined; payment_status?: SwapPaymentStatus | undefined; ... 21 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; })[]	-
data.region?	{ name?: string | undefined; currency_code?: string | undefined; currency?: { code?: string | undefined; symbol?: string | undefined; symbol_native?: string | undefined; name?: string | undefined; includes_tax?: boolean | undefined; } | undefined; ... 15 more ...; updated_at?: { ...; } | undefined; }	-
data.region_id?	string	-
data.status?	PaymentCollectionStatus	-
data.type?	ORDER_EDIT	-
data.updated_at?	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-

Returns

Promise<PaymentCollection>

the payment collection updated.

Defined in

packages/medusa/src/services/payment-collection.ts:146

---

withTransaction

▸ withTransaction(transactionManager?): PaymentCollectionService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

PaymentCollectionService

Inherited from

TransactionBaseService.withTransaction

Defined in

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