Class: PaymentCollectionService
Hierarchy
TransactionBaseService↳
PaymentCollectionService
Constructors
constructor
• new PaymentCollectionService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | InjectedDependencies |
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: (paymentId: string, config: FindManyOptions<PaymentCollection>) => Promise<PaymentCollection> ; getPaymentCollectionIdBySessionId: (sessionId: string, config: FindManyOptions<PaymentCollection>) => Promise<PaymentCollection> }
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
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.
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
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 | 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
medusa/src/services/payment-collection.ts:528
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
medusa/src/services/payment-collection.ts:103
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
medusa/src/services/payment-collection.ts:172
isValidTotalAmount
▸ Private isValidTotalAmount(total, sessionsInput): boolean
Parameters
| Name | Type |
|---|---|
total | number |
sessionsInput | PaymentCollectionsSessionsBatchInput[] |
Returns
boolean
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 | Type | Description |
|---|---|---|
paymentCollectionId | string | the id of the payment collection |
Returns
Promise<PaymentCollection>
the payment session authorized.
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 | 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
medusa/src/services/payment-collection.ts:406
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
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 | 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
medusa/src/services/payment-collection.ts:360
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
medusa/src/services/payment-collection.ts:225
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err | Record<string, unknown> | { code: string } |
Returns
boolean
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 | Type | Description |
|---|---|---|
paymentCollectionId | string | the id of the payment collection to update |
data | DeepPartial<PaymentCollection> | info to be updated |
Returns
Promise<PaymentCollection>
the payment collection updated.
Defined in
medusa/src/services/payment-collection.ts:138
withTransaction
▸ withTransaction(transactionManager?): PaymentCollectionService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction