cancelPayment - Payment Module Reference

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

This method cancels a payment.

Example

const payment =
  await paymentModuleService.cancelPayment("pay_123")

Parameters

paymentIdstringRequired

The payment's ID.

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.