Skip to main content

Class: PaymentCollectionService

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Constructors

constructor

new PaymentCollectionService(

Copy to Clipboard
)

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

__configModule__

Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
__configModule__:
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Inherited from

TransactionBaseService.__configModule__

Defined in

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


__container__

Copy to Clipboard
Copy to Clipboard
__container__:
Copy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

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


customerService_

Copy to Clipboard
Copy to Clipboard
customerService_:
Copy to Clipboard

Defined in

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


eventBusService_

Copy to Clipboard
Copy to Clipboard
eventBusService_:
Copy to Clipboard

Defined in

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


manager_

Copy to Clipboard
Copy to Clipboard
manager_:
Copy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

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


paymentCollectionRepository_

Copy to Clipboard
Copy to Clipboard
paymentCollectionRepository_: typeof
Copy to Clipboard

Defined in

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


paymentProviderService_

Copy to Clipboard
Copy to Clipboard
paymentProviderService_:
Copy to Clipboard

Defined in

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


transactionManager_

Copy to Clipboard
transactionManager_:
Copy to Clipboard
|
Copy to Clipboard

Overrides

TransactionBaseService.transactionManager_

Defined in

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


Events

Copy to Clipboard
Copy to Clipboard
Events:
Copy to Clipboard

Type declaration

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Defined in

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

Methods

atomicPhase_

Copy to Clipboard
atomicPhase_<
Copy to Clipboard
,
Copy to Clipboard
>(
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

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
Copy to Clipboard
Copy to Clipboard

Parameters

NameTypeDescription
Copy to Clipboard
(
Copy to Clipboard
:
Copy to Clipboard
) =>
Copy to Clipboard
<
Copy to Clipboard
>
the transactional work to be done
Copy to Clipboard
Copy to Clipboard
| (
Copy to Clipboard
:
Copy to Clipboard
) =>
Copy to Clipboard
<
Copy to Clipboard
|
Copy to Clipboard
>
the isolation level to be used for the work.
Copy to Clipboard
(
Copy to Clipboard
:
Copy to Clipboard
) =>
Copy to Clipboard
<
Copy to Clipboard
|
Copy to Clipboard
>
Potential error handler

Returns

Copy to Clipboard
<
Copy to Clipboard
>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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


authorize

authorize(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
>

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


capture

capture(

Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


captureAll

captureAll(

Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
[]>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
[]>

Defined in

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


capturePayment

Copy to Clipboard
capturePayment(
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


create

create(

Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


delete

delete(

Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
|
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
|
Copy to Clipboard
>

Defined in

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


isValidTotalAmount

Copy to Clipboard
isValidTotalAmount(
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
[]

Returns

Copy to Clipboard

Defined in

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


refreshPaymentSession

refreshPaymentSession(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


refund

refund(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


refundAll

refundAll(

Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
[]>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
[]>

Defined in

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


refundPayment

Copy to Clipboard
refundPayment(
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


retrieve

retrieve(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
>

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


setPaymentSessions

setPaymentSessions(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
|
Copy to Clipboard
[]

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


shouldRetryTransaction_

Copy to Clipboard
shouldRetryTransaction_(
Copy to Clipboard
):
Copy to Clipboard

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
<
Copy to Clipboard
,
Copy to Clipboard
> | {
Copy to Clipboard
:
Copy to Clipboard
}

Returns

Copy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(

Copy to Clipboard
,
Copy to Clipboard
):
Copy to Clipboard
<
Copy to Clipboard
>

Parameters

NameType
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
{ code?: string | undefined; symbol?: string | undefined; symbol_native?: string | undefined; name?: string | undefined; includes_tax?: boolean | undefined; }
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
| { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
{ [x: string]: unknown; }
Copy to Clipboard
(
Copy to Clipboard
| { 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?: {...)[]
Copy to Clipboard
(
Copy to Clipboard
| { swap_id?: string | undefined; swap?: { fulfillment_status?: SwapFulfillmentStatus | undefined; payment_status?: SwapPaymentStatus | undefined; ... 21 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; })[]
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
{ 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; }
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
Copy to Clipboard
{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }

Returns

Copy to Clipboard
<
Copy to Clipboard
>

Defined in

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


withTransaction

withTransaction(

Copy to Clipboard
):
Copy to Clipboard

Parameters

NameType
Copy to Clipboard
Copy to Clipboard

Returns

Inherited from

TransactionBaseService.withTransaction

Defined in

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