PaymentService

This will be

Deprecated

in the near future use the new PaymentProcessor interface instead

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

manager_EntityManagerRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Inherited from

TransactionBaseService.activeManager_

Methods

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.

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required

the 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>Required

the result of the transactional work

---

authorizePayment

This will be

Parameters

paymentSessionPaymentSessionRequired

contextDataRequired

Returns

PromisePromise<{ data: Data ; status: PaymentSessionStatus }>Required

Deprecated

in the near future use PaymentProcessor.authorizePayment instead

---

cancelPayment

This will be

Parameters

paymentPaymentRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.cancelPayment instead

---

capturePayment

This will be

Parameters

paymentPaymentRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.capturePayment instead

---

createPayment

**createPayment**(context): Promise<[PaymentSessionResponse](/references/js-client/internal/types/internal.internal.PaymentSessionResponse)>

This will be

Parameters

contextCart & PaymentContextRequired

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

PromisePromise<PaymentSessionResponse>Required

Deprecated

in the near future use PaymentProcessor.initiatePayment instead

**createPayment**(cart): Promise<[Data](/references/js-client/internal/types/internal.internal.Data)>

This will be

Parameters

cartCartRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead

---

deletePayment

This will be

Parameters

paymentSessionPaymentSessionRequired

Returns

PromisePromise<void>Required

Deprecated

in the near future use PaymentProcessor.cancelPayment instead

---

getIdentifier

Returns

stringstring

---

getPaymentData

This will be

Parameters

paymentSessionPaymentSessionRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.retrievePayment instead

---

getStatus

This will be

Parameters

dataDataRequired

Returns

PromisePromise<PaymentSessionStatus>Required

Deprecated

in the near future use PaymentProcessor.getPaymentStatus instead

---

refundPayment

This will be

Parameters

paymentPaymentRequired

refundAmountnumberRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.refundPayment instead

---

retrievePayment

This will be

Parameters

paymentDataDataRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.retrievePayment instead

---

retrieveSavedMethods

This will be

Parameters

customerCustomerRequired

Returns

PromisePromise<Data[]>Required

Deprecated

in the near future use PaymentProcessor.getSavedMethods instead

---

shouldRetryTransaction_

Parameters

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

Returns

booleanboolean

---

updatePayment

**updatePayment**(paymentSessionData, context): Promise<[Data](/references/js-client/internal/types/internal.internal.Data) \| [PaymentSessionResponse](/references/js-client/internal/types/internal.internal.PaymentSessionResponse)>

Parameters

paymentSessionDataDataRequired

contextCart & PaymentContextRequired

Returns

PromisePromise<Data | PaymentSessionResponse>Required

**updatePayment**(paymentSessionData, cart): Promise<[Data](/references/js-client/internal/types/internal.internal.Data)>

This will be

Parameters

paymentSessionDataDataRequired

cartCartRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.updatePayment instead

---

updatePaymentData

This will be

Parameters

paymentSessionDataDataRequired

dataDataRequired

Returns

PromisePromise<Data>Required

Deprecated

in the near future use PaymentProcessor.updatePayment instead

---

withTransaction

Parameters

transactionManagerEntityManager

Returns

PaymentServicePaymentServiceRequired