8.4 KiB
Class: PaymentService
Hierarchy
-
TransactionBaseService↳
PaymentService
Constructors
constructor
• new PaymentService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
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
| Name | Type |
|---|---|
CREATED |
string |
PAYMENT_CAPTURED |
string |
PAYMENT_CAPTURE_FAILED |
string |
REFUND_CREATED |
string |
REFUND_FAILED |
string |
UPDATED |
string |
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
| 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
capture
▸ capture(paymentOrId): Promise<Payment>
Captures a payment.
Parameters
| Name | Type | Description |
|---|---|---|
paymentOrId |
string | Payment |
the 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
| Name | Type | Description |
|---|---|---|
paymentInput |
PaymentDataInput |
info 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
| Name | Type | Description |
|---|---|---|
paymentOrId |
string | Payment |
the id or the class instance of the payment |
amount |
number |
the amount to be refunded from the payment |
reason |
string |
the refund reason |
note? |
string |
additional 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
| Name | Type | Description |
|---|---|---|
paymentId |
string |
the id of the payment |
config |
FindConfig<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
| 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(paymentId, data): Promise<Payment>
Updates a payment in order to link it to an order or a swap.
Parameters
| Name | Type | Description |
|---|---|---|
paymentId |
string |
the id of the payment |
data |
Object |
order_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
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14