Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

capturePayment - Payment Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method captures a payment using its associated payment provider.

Learn more about the payment flow in this guide

Example#

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

Parameters#

dataCreateCaptureDTO
The payment capture to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PaymentDTO>
The payment's details.
Was this page helpful?