aa2bb7a31b
Generated the following references: - `js-client` - `pricing` - `services` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
8.6 KiB
PaymentService
Hierarchy
-
TransactionBaseService↳
PaymentService
Constructors
constructor
new PaymentService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/payment.ts:39
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
eventBusService_
Protected Readonly eventBusService_: EventBusService
Defined in
medusa/src/services/payment.ts:27
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
paymentProviderService_
Protected Readonly paymentProviderService_: PaymentProviderService
Defined in
medusa/src/services/payment.ts:28
paymentRepository_
Protected Readonly paymentRepository_: Repository<Payment>
Defined in
medusa/src/services/payment.ts:29
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 |
PAYMENT_CAPTURED |
string |
PAYMENT_CAPTURE_FAILED |
string |
REFUND_CREATED |
string |
REFUND_FAILED |
string |
UPDATED |
string |
Defined in
medusa/src/services/payment.ts:30
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
capture
capture(paymentOrId): Promise<Payment>
Captures a payment.
Parameters
| Name | Description |
|---|---|
paymentOrId |
string | Payment |
Returns
Promise<Payment>
-Promise: the payment captured.
-Payment:
Defined in
medusa/src/services/payment.ts:153
create
create(paymentInput): Promise<Payment>
Created a new payment.
Parameters
| Name | Description |
|---|---|
paymentInput |
PaymentDataInput |
Returns
Promise<Payment>
-Promise: the payment created.
-Payment:
Defined in
medusa/src/services/payment.ts:92
refund
refund(paymentOrId, amount, reason, note?): Promise<Refund>
refunds a payment.
Parameters
| Name | Description |
|---|---|
paymentOrId |
string | Payment |
amount |
number |
reason |
string |
note? |
string |
Returns
Promise<Refund>
-Promise: the refund created.
-Refund:
Defined in
medusa/src/services/payment.ts:202
retrieve
retrieve(paymentId, config?): Promise<Payment>
Retrieves a payment by id.
Parameters
| Name | Description |
|---|---|
paymentId |
string |
config |
FindConfig<Payment> |
Returns
Promise<Payment>
-Promise: the payment.
-Payment:
Defined in
medusa/src/services/payment.ts:58
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(paymentId, data): Promise<Payment>
Updates a payment in order to link it to an order or a swap.
Parameters
| Name | Description |
|---|---|
paymentId |
string |
data |
object |
data.order_id? |
string |
data.swap_id? |
string |
Returns
Promise<Payment>
-Promise: the payment updated.
-Payment:
Defined in
medusa/src/services/payment.ts:121
withTransaction
withTransaction(transactionManager?): PaymentService
Parameters
| Name |
|---|
transactionManager? |
Returns
-default:
Inherited from
TransactionBaseService.withTransaction