Skip to main content

Class: PaymentService

Hierarchy

  • TransactionBaseService

    PaymentService

Constructors

constructor

new PaymentService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/payment.ts:40

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


eventBusService_

Protected Readonly eventBusService_: EventBusService

Defined in

packages/medusa/src/services/payment.ts:28


manager_

Protected Readonly manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/payment.ts:26


paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

packages/medusa/src/services/payment.ts:29


paymentRepository_

Protected Readonly paymentRepository_: typeof PaymentRepository

Defined in

packages/medusa/src/services/payment.ts:30


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/payment.ts:27


Events

Static Readonly Events: Object

Type declaration

NameType
CREATEDstring
PAYMENT_CAPTUREDstring
PAYMENT_CAPTURE_FAILEDstring
REFUND_CREATEDstring
REFUND_FAILEDstring
UPDATEDstring

Defined in

packages/medusa/src/services/payment.ts:31

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

NameTypeDescription
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


capture

capture(paymentOrId): Promise<Payment>

Captures a payment.

Parameters

NameTypeDescription
paymentOrIdstring | Paymentthe id or the class instance of the payment

Returns

Promise<Payment>

the payment captured.

Defined in

packages/medusa/src/services/payment.ts:161


create

create(paymentInput): Promise<Payment>

Created a new payment.

Parameters

NameTypeDescription
paymentInputPaymentDataInputinfo to create the payment

Returns

Promise<Payment>

the payment created.

Defined in

packages/medusa/src/services/payment.ts:96


refund

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

refunds a payment.

Parameters

NameTypeDescription
paymentOrIdstring | Paymentthe id or the class instance of the payment
amountnumberthe amount to be refunded from the payment
reasonstringthe refund reason
note?stringadditional note of the refund

Returns

Promise<Refund>

the refund created.

Defined in

packages/medusa/src/services/payment.ts:210


retrieve

retrieve(paymentId, config?): Promise<Payment>

Retrieves a payment by id.

Parameters

NameTypeDescription
paymentIdstringthe id of the payment
configFindConfig<Payment>the config to retrieve the payment

Returns

Promise<Payment>

the payment.

Defined in

packages/medusa/src/services/payment.ts:61


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(paymentId, data): Promise<Payment>

Updates a payment in order to link it to an order or a swap.

Parameters

NameTypeDescription
paymentIdstringthe id of the payment
dataObjectorder_id or swap_id to link the payment
data.order_id?string-
data.swap_id?string-

Returns

Promise<Payment>

the payment updated.

Defined in

packages/medusa/src/services/payment.ts:127


withTransaction

withTransaction(transactionManager?): PaymentService

Parameters

NameType
transactionManager?EntityManager

Returns

PaymentService

Inherited from

TransactionBaseService.withTransaction

Defined in

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