Skip to main content
DELETE
/
v1
/
payment-method-sessions
/
{id}
Payment Method Session - Delete a saved payment method
curl --request DELETE \
  --url https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Profile-Id: <x-profile-id>' \
  --data '
{
  "payment_method_token": "token_9wcXDRVkfEtLEsSnYKgQ"
}
'
import requests

url = "https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}"

payload = { "payment_method_token": "token_9wcXDRVkfEtLEsSnYKgQ" }
headers = {
    "X-Profile-Id": "<x-profile-id>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'DELETE',
  headers: {
    'X-Profile-Id': '<x-profile-id>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({payment_method_token: 'token_9wcXDRVkfEtLEsSnYKgQ'})
};

fetch('https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_method_token' => 'token_9wcXDRVkfEtLEsSnYKgQ'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "X-Profile-Id: <x-profile-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}"

	payload := strings.NewReader("{\n  \"payment_method_token\": \"token_9wcXDRVkfEtLEsSnYKgQ\"\n}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("X-Profile-Id", "<x-profile-id>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}")
  .header("X-Profile-Id", "<x-profile-id>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_method_token\": \"token_9wcXDRVkfEtLEsSnYKgQ\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_method_token\": \"token_9wcXDRVkfEtLEsSnYKgQ\"\n}"

response = http.request(request)
puts response.read_body
{
  "payment_method_token": "token_9wcXDRVkfEtLEsSnYKgQ"
}

Authorizations

Authorization
string
header
required

Format: publishable-key=<publishable-key>,client-secret=<client-secret>

Publishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.

Headers

X-Profile-Id
string
required

Profile ID associated to the payment method session

Path Parameters

id
string
required

The unique identifier for the Payment Method Session

Body

application/json
payment_method_token
string
required

The payment method token associated with the payment method to be deleted

Example:

"token_9wcXDRVkfEtLEsSnYKgQ"

Response

The payment method has been deleted successfully

payment_method_token
string
required

The unique identifier of the Payment method

Example:

"token_9wcXDRVkfEtLEsSnYKgQ"