Mandate

Get Mandate

Mandates allow us to auto-debit the amount from the customer’s bank account. Mandate transactions can be of ₹ 2 value for subscriptions with billAtStart marked as false or the actual amount of subscription value for those with billAtStart marked as true.

In India, a mandate needs a minimum of 24 hours from the bank to get permission to initiate auto-debit. So, if on the 1st of the month, we post a request to the bank to ask permission for an auto-debit amount from the customer’s bank account, the bank will notify the customer about the due amount, and after 24 hours we will give permission to invoke auto-debit on the customer’s bank account and after that we will be able to deduct the amount. So on the 2nd of the month, we will try to deduct the money from the customer’s bank account.

A mandate can be canceled by the end-user using his/her banking app. If a customer has cancelled his mandate we push this event to the mandate web-hook configured by the partner. It is a good practice to check periodically if the mandate linked with the subscription is still in ACTIVE state or not. If not the customer should be prompted to add a new mandate to make sure the subscription remains active. The partner can ask for a new mandate using Update Mandate API. This API is used for getting a specific mandate. The partner can pass the _id as txId or pass the ref_id that was used in the initiation of the payment.

POST

subscription

v1.0

getMandate

Get Mandate

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "mandateId": "<string>"
}
'

import requests

url = "https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate"

payload = { "mandateId": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({mandateId: '<string>'})
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate', 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-api.transactbridge.com/subscription/v1.0/getMandate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mandateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate"

	payload := strings.NewReader("{\n  \"mandateId\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<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.post("https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mandateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mandateId\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {}
}

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

mandateId

string<MongoId>

required

Used for getting mandate by its _id.

Response

200 - application/json

Specific mandate details

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

It will return mandate data

Get Mandate

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "mandateId": "<string>"
}
'

import requests

url = "https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate"

payload = { "mandateId": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "x-signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({mandateId: '<string>'})
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate', 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-api.transactbridge.com/subscription/v1.0/getMandate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mandateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-signature: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate"

	payload := strings.NewReader("{\n  \"mandateId\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-signature", "<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.post("https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mandateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.transactbridge.com/subscription/v1.0/getMandate")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mandateId\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "sub_status": "<string>",
  "data": {}
}

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Get Mandate

Authorizations

Body

Response