capturePayment - Payment Module Reference

This documentation provides a reference to the capturePayment method. This belongs to the Payment Module.

This method captures a payment using its associated payment provider.

Learn more about the payment flow in this guide

Example

const payment = await paymentModuleService.capturePayment({
  payment_id: "pay_123",
})

Parameters

dataCreateCaptureDTORequired

The payment capture to be created.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<PaymentDTO>Required

The payment's details.