Mandates - Revoke Mandate - Hyperswitch

Mandates - Revoke Mandate

curl --request POST \
  --url https://sandbox.hyperswitch.io/mandates/revoke/{mandate_id} \
  --header 'api-key: <api-key>'

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

fetch('https://sandbox.hyperswitch.io/mandates/revoke/{mandate_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/mandates/revoke/{mandate_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/mandates/revoke/{mandate_id}"

	req, _ := http.NewRequest("POST", 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/mandates/revoke/{mandate_id}")

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

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

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

{
  "mandate_id": "<string>",
  "status": "active",
  "error_code": "E0001",
  "error_message": "Failed while verifying the card"
}

POST

/

mandates

/

revoke

/

{mandate_id}

Mandates - Revoke Mandate

curl --request POST \
  --url https://sandbox.hyperswitch.io/mandates/revoke/{mandate_id} \
  --header 'api-key: <api-key>'

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

fetch('https://sandbox.hyperswitch.io/mandates/revoke/{mandate_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/mandates/revoke/{mandate_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/mandates/revoke/{mandate_id}"

	req, _ := http.NewRequest("POST", 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/mandates/revoke/{mandate_id}")

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

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

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

{
  "mandate_id": "<string>",
  "status": "active",
  "error_code": "E0001",
  "error_message": "Failed while verifying the card"
}

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

mandate_id

string

required

The identifier for a mandate

Response

The mandate was revoked successfully

mandate_id

string

required

The identifier for mandate

status

enum<string>

required

The status of the mandate, which indicates whether it can be used to initiate a payment.

Available options:

active,

inactive,

pending,

revoked

error_code

string | null

If there was an error while calling the connectors the code is received here

Example:

"E0001"

error_message

string | null

If there was an error while calling the connector the error message is received here

Example:

"Failed while verifying the card"