AbstractPaymentService
This will be
Deprecated
in the near future use the AbstractPaymentProcessor instead
constructor
Parameters
containerunknownRequiredconfigRecord<string, unknown>Properties
__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>manager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredidentifierstringRequiredAccessors
activeManager_
Returns
EntityManagerEntityManagerRequiredMethods
atomicPhase_
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
TResultobjectRequiredTErrorobjectRequiredParameters
work(transactionManager: EntityManager) => Promise<TResult>Requiredthe transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>Potential error handler
Returns
PromisePromise<TResult>Requiredthe result of the transactional work
PromisePromise<TResult>RequiredauthorizePayment
Parameters
A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
Returns
PromisePromise<object>Required
PromisePromise<object>RequiredDeprecated
cancelPayment
This will be
Parameters
A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
Returns
Deprecated
in the near future
capturePayment
This will be
Parameters
A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
Returns
Deprecated
in the near future
createPayment
Abstract **createPayment**(context): Promise<[PaymentSessionResponse](/references/medusa/types/medusa.PaymentSessionResponse)>
Parameters
The type of this argument is meant to be temporary and once the previous method signature
will be removed, the type will only be PaymentContext instead of Cart & PaymentContext
Returns
Abstract **createPayment**(cart): Promise<[Data](/references/medusa/types/medusa.Data)>
This will be
Parameters
Returns
Deprecated
in the near future use createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead
deletePayment
This will be
Parameters
A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
Returns
PromisePromise<void>RequiredDeprecated
in the near future
getIdentifier
Returns
stringstringgetPaymentData
Parameters
A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
Returns
Deprecated
getStatus
This will be
Parameters
Returns
Deprecated
in the near future
refundPayment
This will be
Parameters
A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
refundAmountnumberRequiredReturns
Deprecated
in the near future
retrievePayment
Parameters
Returns
Deprecated
retrieveSavedMethods
This will be
Parameters
A customer can make purchases in your store and manage their profile.
Returns
Deprecated
in the near future
shouldRetryTransaction_
Parameters
errRecord<string, unknown> | objectRequiredReturns
booleanbooleanupdatePayment
Abstract **updatePayment**(paymentSessionData, context): Promise<Record<string, unknown> \| [PaymentSessionResponse](/references/medusa/types/medusa.PaymentSessionResponse)>
Parameters
The type of this argument is meant to be temporary and once the previous method signature
will be removed, the type will only be PaymentContext instead of Cart & PaymentContext
Returns
it return either a PaymentSessionResponse or PaymentSessionResponse["session_data"] to maintain backward compatibility
Abstract **updatePayment**(paymentSessionData, cart): Promise<[Data](/references/medusa/types/medusa.Data)>
This will be
Parameters
Returns
Deprecated
in the near future use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead
updatePaymentData
Parameters
Returns
Deprecated
withTransaction
Parameters
transactionManagerEntityManagerReturns
__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>manager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredidentifierstringRequiredactiveManager_objectRequiredatomicPhase_<TResult, TError>(work: (transactionManager: EntityManager) => Promise<TResult>, isolationOrErrorHandler?: IsolationLevel | (error: TError) => Promise<void | TResult>, maybeErrorHandlerOrDontFail?: (error: TError) => Promise<void | TResult>) => Promise<TResult>RequiredauthorizePayment(paymentSession: PaymentSession, context: Data) => Promise<{ data: Data ; status: PaymentSessionStatus }>RequiredcreatePayment(context: Cart & PaymentContext) => Promise<PaymentSessionResponse>(cart: Cart) => Promise<Data>RequiredgetIdentifier() => stringRequiredshouldRetryTransaction_(err: Record<string, unknown> | { code: string }) => booleanRequiredupdatePayment(paymentSessionData: Data, context: Cart & PaymentContext) => Promise<Record<string, unknown> | PaymentSessionResponse>(paymentSessionData: Data, cart: Cart) => Promise<Data>RequiredWas this section helpful?