Payment Method Session - Delete a saved payment method

Delete a saved payment method associated with a Payment Method Session.

DELETE /v2/payment-method-sessions/{id}

cURL example

curl
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/v2/payment-method-sessions/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "payment_method_token": "token_9wcXDRVkfEtLEsSnYKgQ"
}
'

Response example (200)

response.json
{
  "payment_method_token": "token_9wcXDRVkfEtLEsSnYKgQ"
}

Authorizations

Header: api-key (string) — required

Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.

Path parameters

  • id (string, required) The unique identifier for the Payment Method Session

Request body

Content-Type: application/json

  • payment_method_token (string, required) The payment method token associated with the payment method to be deleted Example: "token_9wcXDRVkfEtLEsSnYKgQ"

Response

200 — application/json

The payment method has been deleted successfully.

Response fields:

  • payment_method_token (string, required) — The unique identifier of the payment method Example: "token_9wcXDRVkfEtLEsSnYKgQ"

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

  • Source (edit): https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method