Skip to main content
Skip to main content

IPaymentModuleService

Methods​

createPaymentCollection​

**createPaymentCollection**(data, sharedContext?): Promise<[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)[]>

Parameters​

dataCreatePaymentCollectionDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO[]>Required

**createPaymentCollection**(data, sharedContext?): Promise&#60;[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)&#62;

Parameters​

dataCreatePaymentCollectionDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

retrievePaymentCollection​

Parameters​

paymentCollectionIdstringRequired
configFindConfig<PaymentCollectionDTO>
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

listPaymentCollections​

Parameters​

Returns​

PromisePromise<PaymentCollectionDTO[]>Required

listAndCountPaymentCollections​

Parameters​

Returns​

PromisePromise<[PaymentCollectionDTO[], number]>Required

updatePaymentCollection​

**updatePaymentCollection**(data, sharedContext?): Promise&#60;[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)[]&#62;

Parameters​

dataUpdatePaymentCollectionDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO[]>Required

**updatePaymentCollection**(data, sharedContext?): Promise&#60;[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)&#62;

Parameters​

dataUpdatePaymentCollectionDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

deletePaymentCollections​

**deletePaymentCollections**(paymentCollectionId, sharedContext?): Promise&#60;void&#62;

Parameters​

paymentCollectionIdstring[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

**deletePaymentCollections**(paymentCollectionId, sharedContext?): Promise&#60;void&#62;

Parameters​

paymentCollectionIdstringRequired
sharedContextContext

Returns​

PromisePromise<void>Required

authorizePaymentCollection​

Parameters​

paymentCollectionIdstringRequired
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

completePaymentCollection​

Parameters​

paymentCollectionIdstringRequired
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

createPayment​

**createPayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)&#62;

Parameters​

dataCreatePaymentDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentDTO>Required

**createPayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)[]&#62;

Parameters​

dataCreatePaymentDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentDTO[]>Required

capturePayment​

**capturePayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)&#62;

Parameters​

dataCreateCaptureDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentDTO>Required

**capturePayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)[]&#62;

Parameters​

dataCreateCaptureDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentDTO[]>Required

refundPayment​

**refundPayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)&#62;

Parameters​

dataCreateRefundDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentDTO>Required

**refundPayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)[]&#62;

Parameters​

dataCreateRefundDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentDTO[]>Required

cancelPayment​

**cancelPayment**(paymentId, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)&#62;

Parameters​

paymentIdstringRequired
sharedContextContext

Returns​

PromisePromise<PaymentDTO>Required

**cancelPayment**(paymentId, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)[]&#62;

Parameters​

paymentIdstring[]Required
sharedContextContext

Returns​

PromisePromise<PaymentDTO[]>Required

updatePayment​

**updatePayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)&#62;

Parameters​

dataUpdatePaymentDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentDTO>Required

**updatePayment**(data, sharedContext?): Promise&#60;[PaymentDTO](/references/types/interfaces/types.PaymentDTO)[]&#62;

Parameters​

dataUpdatePaymentDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentDTO[]>Required

createPaymentSession​

**createPaymentSession**(paymentCollectionId, data, sharedContext?): Promise&#60;[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)&#62;

Parameters​

paymentCollectionIdstringRequired
dataCreatePaymentSessionDTORequired
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

**createPaymentSession**(paymentCollectionId, data, sharedContext?): Promise&#60;[PaymentCollectionDTO](/references/types/interfaces/types.PaymentCollectionDTO)&#62;

Parameters​

paymentCollectionIdstringRequired
dataCreatePaymentSessionDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

authorizePaymentSessions​

Parameters​

paymentCollectionIdstringRequired
sessionIdsstring[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

completePaymentSessions​

Parameters​

paymentCollectionIdstringRequired
sessionIdsstring[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required

setPaymentSessions​

Parameters​

paymentCollectionIdstringRequired
dataSetPaymentSessionsDTO[]Required
sharedContextContext

Returns​

PromisePromise<PaymentCollectionDTO>Required
Was this section helpful?
© 2024 Medusa, Inc. All rights reserved.