Mandate

Add Mandate

This API is used to update a specific subscription with a new payment method. Only ACTIVE or PAUSED subscriptions can be updated with a new payment method. If a subscription has cancelAtEnd set to true, this API cannot be called, since the subscription will be automatically canceled at the end of the cycle and adding a new mandate will be useless.

For PENDING subscriptions (which have not been activated once), always use the payURL provided in the Get Subscription API.

This API will not work for subscriptions in terminal states.

Note: Update Mandate, by default, only allows adding a new mandate for a running subscription. If the partner wants, it is possible to request a mandate with the last due unpaid invoice amount. This way, the partner will have a new mandate for auto-debit, and an unpaid invoice will be cleared. This feature can be enabled by requesting the administrative team.

POST

subscription

v1.0

updateSubscriptionMandate

Add Mandate

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/updateSubscriptionMandate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "subscriptionId": "<string>",
  "returnUrl": "<string>",
  "pendingUrl": "<string>",
  "successUrl": "<string>",
  "failedUrl": "<string>"
}
'

import requests

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

payload = {
    "subscriptionId": "<string>",
    "returnUrl": "<string>",
    "pendingUrl": "<string>",
    "successUrl": "<string>",
    "failedUrl": "<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({
    subscriptionId: '<string>',
    returnUrl: '<string>',
    pendingUrl: '<string>',
    successUrl: '<string>',
    failedUrl: '<string>'
  })
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/updateSubscriptionMandate', 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/updateSubscriptionMandate",
  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([
    'subscriptionId' => '<string>',
    'returnUrl' => '<string>',
    'pendingUrl' => '<string>',
    'successUrl' => '<string>',
    'failedUrl' => '<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/updateSubscriptionMandate"

	payload := strings.NewReader("{\n  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<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/updateSubscriptionMandate")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\"\n}"

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

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

Authorizations

x-api-key

string

header

required

Merchant API Key

x-signature

string

header

required

Generated request signature

Body

application/json

subscriptionId

string<MongoId>

required

Subscription which requires mandate to be updated.

returnUrl

string

required

This URL is needed to redirect the user after the mandate is completed. If this is not passed, we take subscription returnUrl and redirect the customer to that URL.

pendingUrl

string

If the mandate is still in pending state, the customer will be redirected to this URL. If returnUrl is passed, this parameter is not mandatory.

successUrl

string

If the mandate is in successful state, the customer will be redirected to this URL. If returnUrl is passed, this parameter is not mandatory.

failedUrl

string

If the mandate is in failed state, the customer will be redirected to this URL. If returnUrl is passed, this parameter is not mandatory.

Response

200 - application/json

Specific mandate details

status

string

The response from the API

sub_status

string

Used for internal purposes only

data

object

Contains the mandateId and URL.

Show child attributes

Add Mandate

curl --request POST \
  --url https://sandbox-api.transactbridge.com/subscription/v1.0/updateSubscriptionMandate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-signature: <api-key>' \
  --data '
{
  "subscriptionId": "<string>",
  "returnUrl": "<string>",
  "pendingUrl": "<string>",
  "successUrl": "<string>",
  "failedUrl": "<string>"
}
'

import requests

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

payload = {
    "subscriptionId": "<string>",
    "returnUrl": "<string>",
    "pendingUrl": "<string>",
    "successUrl": "<string>",
    "failedUrl": "<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({
    subscriptionId: '<string>',
    returnUrl: '<string>',
    pendingUrl: '<string>',
    successUrl: '<string>',
    failedUrl: '<string>'
  })
};

fetch('https://sandbox-api.transactbridge.com/subscription/v1.0/updateSubscriptionMandate', 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/updateSubscriptionMandate",
  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([
    'subscriptionId' => '<string>',
    'returnUrl' => '<string>',
    'pendingUrl' => '<string>',
    'successUrl' => '<string>',
    'failedUrl' => '<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/updateSubscriptionMandate"

	payload := strings.NewReader("{\n  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<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/updateSubscriptionMandate")
  .header("x-api-key", "<api-key>")
  .header("x-signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"subscriptionId\": \"<string>\",\n  \"returnUrl\": \"<string>\",\n  \"pendingUrl\": \"<string>\",\n  \"successUrl\": \"<string>\",\n  \"failedUrl\": \"<string>\"\n}"

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

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

API Documentation

Session

Subscription

Mandate

Invoices

Transactions

Settlements

Customers

Products

Distribution

PACB

Others

Add Mandate

Authorizations

Body

Response