Mandates - Retrieve Mandate

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

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

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

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

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

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

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

{
  "mandate_id": "<string>",
  "status": "active",
  "payment_method_id": "<string>",
  "payment_method": "<string>",
  "payment_method_type": "<string>",
  "card": {
    "last4_digits": "<string>",
    "card_exp_month": "<string>",
    "card_exp_year": "<string>",
    "card_holder_name": "<string>",
    "card_token": "<string>",
    "scheme": "<string>",
    "issuer_country": "<string>",
    "card_fingerprint": "<string>",
    "card_isin": "<string>",
    "card_issuer": "<string>",
    "card_network": "Visa",
    "card_type": "<string>",
    "nick_name": "<string>"
  },
  "customer_acceptance": {
    "acceptance_type": "online",
    "accepted_at": "2022-09-10T10:11:12Z",
    "online": {
      "ip_address": "123.32.25.123",
      "user_agent": "<string>"
    }
  }
}

GET

mandates

{mandate_id}

Mandates - Retrieve Mandate

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

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

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

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

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

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

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

{
  "mandate_id": "<string>",
  "status": "active",
  "payment_method_id": "<string>",
  "payment_method": "<string>",
  "payment_method_type": "<string>",
  "card": {
    "last4_digits": "<string>",
    "card_exp_month": "<string>",
    "card_exp_year": "<string>",
    "card_holder_name": "<string>",
    "card_token": "<string>",
    "scheme": "<string>",
    "issuer_country": "<string>",
    "card_fingerprint": "<string>",
    "card_isin": "<string>",
    "card_issuer": "<string>",
    "card_network": "Visa",
    "card_type": "<string>",
    "nick_name": "<string>"
  },
  "customer_acceptance": {
    "acceptance_type": "online",
    "accepted_at": "2022-09-10T10:11:12Z",
    "online": {
      "ip_address": "123.32.25.123",
      "user_agent": "<string>"
    }
  }
}

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 mandate

Response

The mandate was retrieved 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

payment_method_id

string

required

The identifier for payment method

payment_method

string

required

The payment method

payment_method_type

string | null

The payment method type

card

object | null

Show child attributes

customer_acceptance

object | null

This "CustomerAcceptance" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.

Show child attributes

Get Started

Essentials

Payments Core APIs

Deprecated APIs

Account management APIs

Other APIs

Mandates - Retrieve Mandate

Authorizations

Path Parameters

Response