refundPayment - Payment Module Reference
This documentation provides a reference to the refundPayment
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 refunds a payment using its associated payment provider. An amount can only be refunded if it has been captured first.
Example#
1const payment = await paymentModuleService.refundPayment({2 payment_id: "pay_123",3 amount: 300,4})
Parameters#
The refund to be created.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#
Was this page helpful?