Customers - Delete - Hyperswitch

Customers - Delete

curl --request DELETE \
  --url https://sandbox.hyperswitch.io/customers/{customer_id} \
  --header 'api-key: <api-key>'

const options = {method: 'DELETE', headers: {'api-key': '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/customers/{customer_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/customers/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox.hyperswitch.io/customers/{customer_id}"

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

	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/customers/{customer_id}")

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

request = Net::HTTP::Delete.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer_deleted": false,
  "address_deleted": false,
  "payment_methods_deleted": false
}

DELETE

/

customers

/

{customer_id}

Customers - Delete

curl --request DELETE \
  --url https://sandbox.hyperswitch.io/customers/{customer_id} \
  --header 'api-key: <api-key>'

const options = {method: 'DELETE', headers: {'api-key': '<api-key>'}};

fetch('https://sandbox.hyperswitch.io/customers/{customer_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/customers/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox.hyperswitch.io/customers/{customer_id}"

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

	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/customers/{customer_id}")

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

request = Net::HTTP::Delete.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "customer_deleted": false,
  "address_deleted": false,
  "payment_methods_deleted": false
}

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.

Path Parameters

customer_id

string

required

The unique identifier for the Customer

Response

Customer was Deleted

customer_id

string

required

The identifier for the customer object

Maximum string length: 255

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

customer_deleted

boolean

required

Whether customer was deleted or not

Example:

false

address_deleted

boolean

required

Whether address was deleted or not

Example:

false

payment_methods_deleted

boolean

required

Whether payment methods deleted or not

Example:

false