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:57

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

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

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

---

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

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

---

manager_

• Protected Readonly manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

---

paymentCollectionRepository_

• Protected Readonly paymentCollectionRepository_: typeof PaymentCollectionRepository

Defined in

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

---

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
PAYMENT_AUTHORIZED	string
PAYMENT_CAPTURED	string
PAYMENT_CAPTURE_FAILED	string
REFUND_CREATED	string
REFUND_FAILED	string
UPDATED	string

Defined in

packages/medusa/src/services/payment-collection.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

---

authorize

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

Parameters

Name	Type
paymentCollectionId	string
context	Record<string, unknown>

Returns

Promise<PaymentCollection>

Defined in

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

---

capture

▸ capture(paymentId): Promise<Payment>

Parameters

Name	Type
paymentId	string

Returns

Promise<Payment>

Defined in

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

---

captureAll

▸ captureAll(paymentCollectionId): Promise<Payment[]>

Parameters

Name	Type
paymentCollectionId	string

Returns

Promise<Payment[]>

Defined in

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

---

capturePayment

▸ Private capturePayment(payCol, payment): Promise<Payment>

Parameters

Name	Type
payCol	PaymentCollection
payment	Payment

Returns

Promise<Payment>

Defined in

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

---

create

▸ create(data): Promise<PaymentCollection>

Parameters

Name	Type
data	CreatePaymentCollectionInput

Returns

Promise<PaymentCollection>

Defined in

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

---

delete

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

Parameters

Name	Type
paymentCollectionId	string

Returns

Promise<undefined | PaymentCollection>

Defined in

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

---

isValidTotalAmount

▸ Private isValidTotalAmount(total, sessionsInput): boolean

Parameters

Name	Type
total	number
sessionsInput	PaymentCollectionSessionInput[]

Returns

boolean

Defined in

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

---

refreshPaymentSession

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

Parameters

Name	Type
paymentCollectionId	string
sessionId	string
sessionInput	PaymentCollectionSessionInput

Returns

Promise<PaymentSession>

Defined in

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

---

refund

▸ refund(paymentId, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
paymentId	string
amount	number
reason	string
note?	string

Returns

Promise<Refund>

Defined in

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

---

refundAll

▸ refundAll(paymentCollectionId, reason, note?): Promise<Refund[]>

Parameters

Name	Type
paymentCollectionId	string
reason	string
note?	string

Returns

Promise<Refund[]>

Defined in

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

---

refundPayment

▸ Private refundPayment(payCol, payment, amount, reason, note?): Promise<Refund>

Parameters

Name	Type
payCol	PaymentCollection
payment	Payment
amount	number
reason	string
note?	string

Returns

Promise<Refund>

Defined in

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

---

retrieve

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

Parameters

Name	Type
paymentCollectionId	string
config	FindConfig<PaymentCollection>

Returns

Promise<PaymentCollection>

Defined in

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

---

setPaymentSessions

▸ setPaymentSessions(paymentCollectionId, sessions): Promise<PaymentCollection>

Parameters

Name	Type
paymentCollectionId	string
sessions	PaymentCollectionSessionInput | PaymentCollectionSessionInput[]

Returns

Promise<PaymentCollection>

Defined in

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

---

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>

Parameters

Name	Type
paymentCollectionId	string
data	Object
data.amount?	number
data.authorized_amount?	number
data.captured_amount?	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?	string
data.id?	string
data.metadata?	{ [x: string]: unknown; }
data.payment_sessions?	(undefined | { cart_id?: string | 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_at?: {...)[]
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.refunded_amount?	number
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>

Defined in

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

---

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:13