Payments - Cancel

A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action. Profile-restricted authentication can cancel only payments in that profile. Payments outside the authenticated merchant/profile scope are treated as not found before cancellation side effects.

POST /payments/{payment_id}/cancel

cURL

Cancel the payment with cancellation reason

curl --request POST \
  --url https://sandbox.hyperswitch.io/payments/{payment_id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "cancellation_reason": "requested_by_customer"
}
'

400

{
  "error_type": "invalid_request",
  "message": "Missing required param: {param}",
  "code": "IR_04"
}

Authorizations

api-key · string · header · required

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-Connected-Merchant-Id · string | null

Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.

Path Parameters

payment_id · string · required

The identifier for payment

Body

application/json

cancellation_reason · string | null

The reason for the payment cancel

merchant_connector_details · object | null

Merchant connector details used to make payments.

Show child attributes

all_keys_required · boolean | null

If enabled, provides whole connector response

payment_method_data · Card · object CardWithNoCVC · object CardRedirect · object Wallet · object PayLater · object BankRedirect · object BankDebit · object BankTransfer · object RealTimePayment · object Crypto · object MandatePayment · enum<string> Reward · enum<string> Upi · object Voucher · object GiftCard · object CardToken · object OpenBanking · object MobilePayment · object NetworkToken · object Option 20 · object Option 21 · object Option 22 · object VaultDataCard · object VaultCardTokenData · object

Show child attributes

Response

200

Payment canceled