Skip to main content
POST
Revenue Recovery - Cancel

Authorizations

Authorization
string
header
required

Format: api-key=<api_key>

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id
string
required

Unique identifier of the business profile under which the invoice is processed.

Path Parameters

merchant_reference_id
string
required

Merchant reference id of the invoice whose revenue recovery workflow should be cancelled

Response

Revenue Recovery workflow cancelled successfully

id
string
required

Unique identifier of the invoice in Hyperswitch against which the transaction has been recorded.

Required string length: 30
Example:

"pay_mbabizu24mvu3mela5njyhpit4"

intent_status
enum<string>
default:requires_confirmation
required

Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).

Available options:
succeeded,
failed,
cancelled,
cancelled_post_capture,
processing,
requires_customer_action,
requires_merchant_action,
requires_payment_method,
requires_confirmation,
requires_capture,
partially_captured,
partially_captured_and_capturable,
partially_authorized_and_requires_capture,
partially_captured_and_processing,
conflicted,
expired,
review
merchant_reference_id
string | null

Unique identifier of the invoice in the merchant's billing system against which the transaction is being recorded.

Required string length: 30
Example:

"invoice_mbabizu24mvu3mela5njyh"