Guides

Edit Mandate - Ace SDK

1. Introduction

Any Mandate Created can be edited in case there is a change in any attributes of the mandate previously set. Alternately a Mandate which has been set can also be deleted if desired by the customer. Both these actions require a consent from the customer. BillDesk's Ace – SDK lets merchant offer both these options conveniently to customers.

2. Integration Steps

Depending on the workflows mentioned above, the steps to Integrate vary and have been outlined below:

Step 1: Create a Mandate token

An mandate token needs to be created for every mandate to be edited using the BillDesk Ace – SDK.

To edit a mandate, use the Modify Mandate Token API. This API has an attribute of action which can take values of modify or delete depending on the action to be taken for the mandate. The response of this API provides the mandate_tokenid & authorization values required to launch the BillDesk Ace – SDK (explained in Step 2).

Attribute

Description

mercid

Unique identifier provided by BillDesk for each merchant.

mandate_tokenid

Value generated by BillDesk and provided in the Modify Mandate Token API response.

This value is unique for every Mandate token which is created.

authorization

An authorization token created by BillDesk and provided in the Modify Mandate Token API response.

This value is unique for every Mandate token which is created.

{
	"objectid": "mandate_token",
	"mandate_tokenid": "NA0D080090483",
	"mandateid": "MA0ED20005573",
	"mercid": "BDMERCID",
	"customer_refid": "cus890987067792335",
	"subscription_refid": "12345678901234535",
	"subscription_desc": "Hola",
	"start_date": "2023-06-09",
	"end_date": "2026-12-23",
	"amount": "200.10",
	"amount_type": "maximum",
	"currency": "356",
	"frequency": "adho",
	"createdon": "2023-08-20T13:07:02+05:30",
	"ru": "http://localhost:3000/api/pgresponse/modal/redirect",
	"additional_info": {
		"additional_info1": "Details1",
		"additional_info2": "Details2"
	},
	"customer": {
		"customer_refid": "cus890987067792335"
	},
	"device": {
		"fingerprintid": "61b12c18b5d0cf901be34a23ca64bb19",
		"init_channel": "internet",
		"ip": "192.168.1.1",
		"user_agent": "Mozilla/Firefox",
		"accept_header": "text/html"
	},
	"status": "initiated",
	"action": "modify",
	"payment_method_type": "card",
	"mandate_edit": {
		"amount": "1000.00"
	},
	"next_step": "redirect",
	"links": [
		{
			"href": "https://pguat.billdesk.io/pgsi/v1_2/mandates/token/ini tiate",
			"rel": "self",
			"method": "POST",
			"parameters": null,
			"valid_date": null,
			"headers": null
		},
		{
			"href": " https://www.sampleurl.com/sdk/",
			"rel": "redirect",
			"method": "POST",
			"parameters": {
				"mercid": "BDMERCID",
				"mandate_tokenid": "NA0D0800060183",
				"rdata": "89fd934cf8ca5f15eddff452885653e3f08425d35868fc0b05dd1af21d6eec07364e13b9a3b8f4fd56bdc6983fa732a7ab5267c2708da2b41de3edbb05919787dd5f7c52d17b8e9522e0965164100632eda8575a59483f667255b1c4b0f63bb4ef61d.70675f706172616d5f656e6333"
			},
			"valid_date": "2023-08-20T13:37:02+05:30",
			"headers": {
				"authorization": "OToken 18183EEED380A39203B26A9230F41F0B20943A2F3045318060C2ED64 9E63BCA26F29BB9EF86987E7A5BBD4241ADF 9F83A19E90E37E296BD92EC0588565D1C15FE599E4178E94C097BBF2 5FA2B85B3ED89BB5CD0966FCEF320A8DB82B80BCF5241A5C50382A79 FFBD6338C5D46C4836853E0A26.4145535F55415431"
			}
		}
	]
}
💬

Preparing a request payload

Every API Request needs to encrypted. Similarly the Response of each API is also returned in an encrypted format by BillDesk.

A step by step guide to prepare the request payload, transmit it and capture the response is available here.

💬

Validity of a mandate token

Every mandate token created with the Create Mandate Tokens API is valid for a period of 30 minutes. This would mean that the customer needs to complete the Mandate Setup within this timeframe using a payment method of choice (UPI, Cards or e-NACH).

Step 2: Incorporate the BillDesk JavaScript link

Please refer below for the BillDesk JavaScript link for both UAT and production environments which needs to be incorporated on merchant checkout page where the Ace – SDK would launch.

<script type="module" src="https://uat1.billdesk.com/websdk/shared/billdesksdk.esm.js"></script>
<script type="module" src="https://pay.billdesk.com/websdk/shared/billdesksdk.esm.js"></script>

Step 3: Prepare the configuration objects

The mandate_flow_config and config are 2 objects which need to be prepared to launch the BillDesk Ace – SDK.

Mandate_Flow_Config- The object which defines how certain aspects of the the SDK will render. It contains:

  1. Values received from the Modify Mandate Token API (Step 1).
  2. Customizations which merchant would like to make on the Web SDK.
var mandate_flow_config = {
  merchantId: "BDMERCID",
  mandateTokenId: "TSFFDHWE",
  authToken: "OToken FDD5C104249A4CDAE734623",
  childWindow: true,
  returnUrl: "http://localhost/api/pgresponse/modal/redirect",
  retryCount:3
}
var config = {
  responseHandler: responseHandler,
  flowConfig: mandate_flow_config,
  flowType: "modify_mandate"
}

Elements in the flow_config object

Attribute

Description

Classification

merchantId

Unique identifier provided by BillDesk for each merchant.

mandatory

mandateTokenId

Value generated by BillDesk and provided in the [Modify Mandate Token API response. This value is unique for every Mandate token which is created.

mandatory

authToken

An authorization token created by BillDesk and provided in the Modify Mandate Token APIresponse This value is unique for every order which is created.

mandatory

childWindow

Can take a value of either true or false.
true - In this case, any redirections to an external page ( eg. Card OTP) will open up in a separate window of the browser.

false - In this case, any redirections to an external page( eg. Card OTP) will open up in the same page on which the SDK is launched.

optional

returnUrl

The URL where the customer is to be redirected post completion of the payment on the BillDesk Web SDK. BillDesk will also POST the transaction response to this URL.

  • *Note:** Please ensure that the value of the returnURL is the same as the one passed in the "ru" parameter of the Create Order API. This ensures that the transaction responses for all payment methods are posted on a single URL.

mandatory

retryCount

Number of retry attempts merchant want the customer to be able to get. In case, the earlier attempt to complete the transaction failed, the customer will get an option to retry the payment.

optional

Elements in the config object

AttributeDescriptionClassification
flowTypeFixed value of "modify_mandate".mandatory

Step 4: Include the function to launch the SDK

The scripts and configuration objects created in the steps above need to be passed to a function to launch the Ace – SDK.

document.addEventListener('DOMContentLoaded', function () {
             window.loadBillDeskSdk(config);

Step 5: Review the Integration

Based on the steps proposed above, please find below a summary on how merchant integration should look.

<script type="module" src=""https://uat1.billdesk.com/merchant-uat/websdk/shared/billdesksdk.esm.js"></script>

var mandate_flow_config = {
	merchantId: "BDMERCID",
	bdOrderId: "TSFFDHWE",
	authToken: "OToken FDD5C104249A4CDAE734623",
	childWindow: true,
	returnUrl: "http://www.demo.com/api/pgresponse",
	retryCount: 3
}

var config = {
	mandate_flow_config: mandate_flow_config,
	flowType: "modify_mandate"
}

document.addEventListener('DOMContentLoaded', function () {
             window.loadBillDeskSdk(config);

Step 6: Capture the mandate response

Once the mandate setup has been completed by the customer using a payment method of choice, the customer is returned to the "ru" attribute provided in the Update Mandate Token API. BillDesk will also POST a response to this URL containing details of the mandate.

Capture and parse the mandate response
The transaction response provided depends on the payment method used by the customer. (Samples provided below) :
The value after the mandate_response parameter till the next "&" character is the encrypted mandate response which provides more details about the mandate which has been set up. A step-by-step guide on how to decrypt the mandate_response parameter is available here.

6.1 Mandate response for action "modify" when child window is "true"

terminal_state=Y&mandate_tokenid=NN054919682783&mandate_response=eyJhbGciOiJIUzI1NiIsImNsaWVudGlkIjoiYmRobWFjdGVzdCIsImtpZCI6IkhNQUMifQ.eyJtYW5kYXRlaWQiOiJNTjExNkExNTcwNDU2OTIiLCJ2ZXJpZmljYXRpb25fZXJyb3JfY29kZSI6Ik1OUzAwMDAiLCJ2ZXJpZmljYXRpb25fZXJyb3JftHlwZSI6InN1Y2Olc3MiLCJjcmVhdGVkb24iOiIyMDI0LTAyLTI2VDE3OjA4OjI2KzA1OjMwIiwidmVyaWZpY2F0aW9uX2Vycm9yX2Rlc2MiOiJNYW5kYXRlIFN1Y2Nlc3NmdWwiLCJzdGF0dXMiOiJERUxFVEVEIn0.Ffm1e-HwKW2-wkG3NIlsvC06lY2M5CCBjMhvGZ1lTv4&keyid=HMAC&objectid=mandate
terminal_state=Y&mandate_tokenid=NN1E2420863244&mandate_response=eyJ4NXQjUzI1NiI6IlpqNjdrb3JRMXdjTVAzQlZMWTRZM2N6UzNWVlVaS1c1dzgyTXZpNWNvODQiLCJraWQiOiJiZHRlc3QiLCJhbGciOiJQUzI1NiJ9.ZXlKNE5YUWpVekkxTmlJNkltWmxObGxzYkhVdFFYQjJRMWQwT1hRd1EyVlBkemc1ZGtKMVZGazVhRzFhU1ZaWVdFSnJhRlpCWWtraUxDSnJhV1FpT2lKaVpIUmxjM1FpTENKbGJtTWlPaUpCTVRJNFIwTk5JaXdpWVd4bklqb2lVbE5CTFU5QlJWQXRNalUySW4wLlFJa2pyLVNMV180MTNCQkI0TXZ1dThTV1dHTHFKZ190Uy0yUFJiVkljUDVQXzR5VmEyVUNsazBxNi05cHBKbGVHamJOaEZxV3h6SEwwTGFqdW1JT2pQeDFHSV9yQi10WHRNNy1tVVlYdmhweXJUR3QxRWw5ay1fNkFDTjhZUTJwQ0hCM1ozMU56dENNT29scXhSZzJxazYxQ2Y3S19FWjNVUU1YdEZhSXo0OVlYZGtvbmZZTVNqdDBHZnJjOWtMR1VZQ0pTNEFBVHZtZ0xRZ1JUYjFMa3JfTHVRRHl2eGl5QU1lM3RMUm9qeVJpaWFYM05CODNMbnBPWVZzRUVUeTlRMl9FQV9QSERKejlHcG1QTmc0VTNROGlNeW16elNSRU0zOXdZaC04NnZOa0ptWmZvZmk2Y3c1QXVNVWVHM2pSM1YwaHFWOTdzRlpDVWxkWkFOdkgzQS5YZTVYM210SHFOVVBIaTZqLklGZ2RaYlJGZmFIanJ6Z3VmY1NfVm85RDR4WG9idjkyc2NTanQ5eDY2R25MbXJoQ2ZHZ2VXb2xvdVpXaU1xRGxFbm9UcVo1TTBQTXNXdzU4eFBPTWMweS03OVBhUk1tMl9lTFpCR1ZRVlFFRTdLQkdfM25xUHdYUG9SUXpiNG9PYXNKb0JuQ0RXU01VaXFza2IybUF6b1VCUXB5LVN3S2x0RWlVM2pzaVJuSnZNWTNuZVFXZmNxY0pLR3kyaWZOa2xiY3hFZlRKS1gzZ2RuWnZ2NWpXdFRVMVJlWFMxM3hJd0dpT3hqWnF2cFRENnlGUEozQXJNZFB1NDE0UWFJc1lHOF9LVmdTV3VoVjFaeklxeG1mZzQzcXR4N2MuTUlnUFROckRmcE5JMWthVC0tbnhZZw.MEnyAvV8XMCiD79_NmM2-7FxIIsec1vaHsKnw0xykk47Pl46ak_uae9_RR91MAr32Ef3Y108fr5PdALzYijyOrBD2EUzOSLQD5YXjTaLZcwGEFsIImCaoPa2dIywWEpB8GxrbR7zCwr-N2lTwMa_iSZEkcsfg3bLX0x7NGQzAv4R8XDw5EgRCjZCUzOPTggik0l0IxVzxzU6xPM0pBsXPkCs9KUjjEEB-Qg7McuLuQ_k2MOmhqtnBwbRPJFqKPwDhfkzpA6BwDiFl8ICmWF8kf7ZadQiJxGyMxs_Usl6GjiYFjB956A_NXEVq5Jl0j15MjseTRfZNSSyrwEQFbCcfg&keyid=HMAC&objectid=mandate
{
"objectid":"mandate",
"mandateid":"MN10A1157059143",
"mercid":"BDMERCID",
"customer_refid":"custfefbffrt",
"subscription_refid":"Suhfbfbfffrt",
"subscription_desc":"AVSdhvfibfffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"active",
"createdon":"2024-02-26T18:06:04+05:30",
"payment_method_type":"upi",
"ru":"https://www.merchanturl.com/response.jsp",
"upi":{
"paymentaccountid":"PA0F85154641897",
"vpa":"john.doe@okaxis",
"psp":"okaxis"
},
"customer":{

},
"verification_error_code":"MNS0000",
"verification_error_type":"success",
"verification_error_desc":"Mandate Successful",
"recurrence_rule":"after",
"debit_day":"1",
"bank_umrn":"d70703bc54ec42fb9eb80d75d69ac21d@okaxis"
}

{
"objectid":"mandate",
"mandateid":"MN2592157051326",
"mercid":"BDMERCID",
"customer_refid":"custfefbfrt",
"subscription_refid":"Suhfbfbffrt",
"subscription_desc":"AVSdhvfibffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"active",
"createdon":"2024-02-26T17:16:37+05:30",
"payment_method_type":"card",
"ru":"https://www.merchanturl.com/response.jsp",
"card":{
"paymentaccountid":"PA0385154645099",
"masked_value":"xxxxxxxxxxxx2426",
"holder_name":"John",
"type":"CREDIT",
"card_end":"2426",
"network":"MASTER",
"issuer":"Yes Bank",
"cardaccountid":"CA052BE0000058210609"
},
"customer":{
},
"verification_error_code":"TRS0000",
"verification_error_type":"success",
"verification_error_desc":"Transaction Successful",
"issuer_ref_no":"X5nfLK69PY",
"recurrence_rule":"after",
"debit_day":"1",
"is_amex_flow":"N",
"bank_umrn":"X5nfLK69PY"
}

6.2 Mandate response for action "modify" when child window is "false"

terminal_state=Y&mandate_tokenid=NN054919682783&mandate_response=eyJhbGciOiJIUzI1NiIsImNsaWVudGlkIjoiYmRobWFjdGVzdCIsImtpZCI6IkhNQUMifQ.eyJtYW5kYXRlaWQiOiJNTjExNkExNTcwNDU2OTIiLCJ2ZXJpZmljYXRpb25fZXJyb3JfY29kZSI6Ik1OUzAwMDAiLCJ2ZXJpZmljYXRpb25fZXJyb3JftHlwZSI6InN1Y2Olc3MiLCJjcmVhdGVkb24iOiIyMDI0LTAyLTI2VDE3OjA4OjI2KzA1OjMwIiwidmVyaWZpY2F0aW9uX2Vycm9yX2Rlc2MiOiJNYW5kYXRlIFN1Y2Nlc3NmdWwiLCJzdGF0dXMiOiJERUxFVEVEIn0.Ffm1e-HwKW2-wkG3NIlsvC06lY2M5CCBjMhvGZ1lTv4&keyid=HMAC&objectid=mandate
mandate_response=eyJhbGciOiJIUzI1NiIsImNsaWVudGlkIjoiYmRobWFjdGVzdCIsImtpZCI6IkhNQUMifQ.eyJtZXJjaWQiOiJWMkJETU9OMSIsImVuZF9kYXRlIjoiMjAyNi0wOC0yMCIsInBheW1lbnRfbWV0aG9kX3R5cGUiOiJjYXJkIiwiYW1vdW50IjoiMTAuMDAiLCJydSI6Imh0dHBzOi8vd3d3Lm1lcmNoYW50dXJsLmNvbS9yZXNwb25zZS5qc3AiOCJzdWJzY3JpcHRpb25fZGVzYyI6IkFWU2RodmZpYmZmeXVlcmZ0aW5laXUiLCJ2ZXJpZmljYXRpb25fZXJyb3JfdHlwZSI6InN1Y2Nlc3MiLCJjcmVhdGVkb24iOiIyMDI0LTAyLTI2VDE3OjIyOjI1KzA1OjMwIiwiYmFua191bXJuIjoiWDVuZkxLNjlQWSIsInRyYW5zYWN0aW9uaWQiOiJNVDBCRUUxMjM3ODUzMTYiLCJmcmVxdWVuY3kiOiJ3ZWVrIiwiY3VzdG9tZXJfcmVmaWQiOiJjdXN0ZmVmYmZydCIsImFtb3VudF90eXBlIjoiZml4ZWQiLCJtYW5kYXRlaWQiOiJNTjI1OTIxNTcwNTEzMjYiLCJ2ZXJpZmljYXRpb25fZXJyb3JfY29kZSI6IlRSUzAwMDAiLCJzdWJzY3JpcHRpb25fcmVmaWQiOiJTdWhmYmZiZmZydCIsImN1cnJlbmN5IjoiMzU2Iiwib2JqZWN0arQiOiJtYW5kYXRlIiwiY2FyZCI6eyJjYXJkYWNjb3VudGlkIjoiQ0EwNTJCRjAwMDAwMzgyMTA2NTkiLCJjYXJkX2VuZCI6IjI0MjYiLCJwYXltZW50YWNjb3VudGlkIjoiUEEwMzg1MTU0NjM1MDk5IiwidHlwZSI6IkNSRURJVCIsImlzc3VlciI6IlllcyBCYW5rIiwibWFza2VkX3ZhbHVlIjoieHh4eHh4eHh4eHh4MjQyNiIsImhvbGRlcl9uYW1lIjoiQXJqdW4iLCJuZXR3b3JrIjoiTUFTVEVSIn0sInZlcmlmaWNhdGlvbl9lcnJvcl9kZXNjIjoiVHJhbnNhY3Rpb24gU3VjY2Vzc2Z1bCIsInN0YXJ0X2RhdGUiOiIyMDI0LTAyLTI2Iiwic3RhdHVzIjoiYWN0aXZlIiwiY3VzdG9tZXIiOnt9fQ.0fykNu0ejqWZLav2ZwK870RU8TWLZIPV4-U9r-kSOpk&mandate_tokenid=NN019619689991
{
"objectid":"mandate",
"mandateid":"MN10A1157059143",
"mercid":"BDMERCID",
"customer_refid":"custfefbffrt",
"subscription_refid":"Suhfbfbfffrt",
"subscription_desc":"AVSdhvfibfffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"active",
"createdon":"2024-02-26T18:06:04+05:30",
"payment_method_type":"upi",
"ru":"https://www.merchanturl.com/response.jsp",
"upi":{
"paymentaccountid":"PA0F85154641897",
"vpa":"john.doe@okaxis",
"psp":"okaxis"
},
"customer":{

},
"verification_error_code":"MNS0000",
"verification_error_type":"success",
"verification_error_desc":"Mandate Successful",
"recurrence_rule":"after",
"debit_day":"1",
"bank_umrn":"d70703bc54ec42fb9eb80d75d69ac21d@okaxis"
}

{
"objectid":"mandate",
"mandateid":"MN2592157051326",
"mercid":"BDMERCID",
"customer_refid":"custfefbfrt",
"subscription_refid":"Suhfbfbffrt",
"subscription_desc":"AVSdhvfibffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"active",
"createdon":"2024-02-26T17:16:37+05:30",
"payment_method_type":"card",
"ru":"https://www.merchanturl.com/response.jsp",
"card":{
"paymentaccountid":"PA0385154645099",
"masked_value":"xxxxxxxxxxxx2426",
"holder_name":"John",
"type":"CREDIT",
"card_end":"2426",
"network":"MASTER",
"issuer":"Yes Bank",
"cardaccountid":"CA052BE0000058210609"
},
"customer":{
},
"verification_error_code":"TRS0000",
"verification_error_type":"success",
"verification_error_desc":"Transaction Successful",
"issuer_ref_no":"X5nfLK69PY",
"recurrence_rule":"after",
"debit_day":"1",
"is_amex_flow":"N",
"bank_umrn":"X5nfLK69PY"
}

6.3 Mandate response for action "delete" when child window is "true"


terminal_state=Y&mandate_tokenid=NN054919682783&mandate_response=eyJhbGciOiJIUzI1NiIsImNsaWVudGlkIjoiYmRobWFjdGVzdCIsImtpZCI6IkhNQUMifQ.eyJtYW5kYXRlaWQiOiJNTjExNkExNTcwNDU2OTIiLCJ2ZXJpZmljYXRpb25fZXJyb3JfY29kZSI6Ik1OUzAwMDAiLCJ2ZXJpZmljYXRpb25fZXJyb3JftHlwZSI6InN1Y2Olc3MiLCJjcmVhdGVkb24iOiIyMDI0LTAyLTI2VDE3OjA4OjI2KzA1OjMwIiwidmVyaWZpY2F0aW9uX2Vycm9yX2Rlc2MiOiJNYW5kYXRlIFN1Y2Nlc3NmdWwiLCJzdGF0dXMiOiJERUxFVEVEIn0.Ffm1e-HwKW2-wkG3NIlsvC06lY2M5CCBjMhvGZ1lTv4&keyid=HMAC&objectid=mandate
ru=https%3A%2F%2Fwww.merchant.com&mandateid=MN1123467872146&mandate_tokenid=NN156C20863691&mandate_response=eyJ4NXQjUzI1NiI6IlpqNjdrb3JRMXdjTVAzQlZMWTRZM2N6UzNWVlVaS1c1dzgyTXZpNWNvODQiLCJraWQiOiJiZHRlc3QiLCJhbGciOiJQUzI1NiJ9.ZXlKNE5YUWpVekkxTmlJNkltWmxObGxzYkhVdFFYQjJRMWQwT1hRd1EyVlBkemc1ZGtKMVZGazVhRzFhU1ZaWVdFSnJhRlpCWWtraUxDSnJhV1FpT2lKaVpIUmxjM1FpTENKbGJtTWlPaUpCTVRJNFIwTk5JaXdpWVd4bklqb2lVbE5CTFU5QlJWQXRNalUySW4wLlh5cXN3MmNFZHo2RzIteVJjRGF0UDVQMmRXRWVEVFlGcTM4OGxSR21vNzBiSTJzcUdjTnRQNjhzOVJEc2ZJZzFwMmdUdUFGcWJobm1lazU5LTROeVNWV3FoOHNQM0Ixa0FHaTZXNS1VN3VPajJpOS15V3FMZVF3UHItRDVpN3ljQUxzRHdfV01SRXBMZmN3ZDhJMUx4NVU2QVl4TE5zdV9Da1JiREJoWXJzekJjMXRFdzNiUnFYdWpELWFSbjR1RksxdW9jV0V6SWw1c0RLSDNKSDc3QjBseVNCOFVGQjVSd2dzdmJpYlJVdl9YaUMwRU5fQ0FqRVcxQ2cwNmljd2ZnUkRtRi1JaUZmWmhtSkZvY1lxOVlaVXBzN01YcFNPdzFqY0lwRzZfVXQ2ZUVjTTZlZXduR1ZfS1hBbUpaV3JxX1ZBYzg0RmZoVE5WeGJoSjRCaWZyUS5OYjJHNFdJa0tHMTVFcW5iLllrVno4QnYyM3dtMmVsY0NVQXdYbEdraEJlaXFsdlJleWhSMUgyb0pvUXQ0Qk5tbXk4MjRJN0ZQbTNkV1VkSHVmVHBJbTh3N3Zka2xna25RX29oNG5wMWszNXh2STdFZXczZ0IzamNVOEoxN21RNmRCcjRQbXJMUTZMWlh3RHBCdHI1WjlaeWtqdlliUk9jRU05c1VNLXY3TG5EVGpDN283ZkVLUkhUaVBHVmoxdE8tMHF4SWJHLVA5ZGxuQmJ1cjRFY2pHSjJhdk9KSndnTmlGNFZ6UGgzQ19xa0ZCTWtTX0FEZVZXV1pqeWYyNGxnQ3V3aXktWXpLQUhCTjBGd0dMODJTd2FTb2xveUVjZkZjcWhNT2QyZi1BRk5zSl9mWWlESDhzQkJPOUFremZiRmZ1SEpVLVFVM0F5aVRUNVZ4X04zOUpnOUdIdGFMcmE2MHNSLWJ6QW91czJQbFFCby1Oay1ZSjVwVWI2Vl9nQ29SVGxKN1B5dS1jSWh6TG5xVFpPV3V5b0thSk02NGlWZ0JoWkdIOEJ5dy1qTUw2SUxKYXI1ZGhLUHdsbmo5WGw0SkQzYk05WHg4WTNkb0xGbGdhVDlJR1RNT2lzd3U1eER5RDJZVVk0UXJWbEU4RG9JeHVDNjhfcHpxc1ZjdUthRmllXzMtMlVodjZsVmlaWEJJQkxrcEhOaENnaGxCZUxhdWxuLVFlcDlqcUlndXI1T1E3N1p0cDlBSFNwRURwQ3Uyd1pPZHhfSWFnMzAxR05CSWVLdzFBUGJWWHUzUjFpd0ZZTTY1Mlp0bmNzS0N6VU4tQmdrdDNOVWluRjYtMDNBMGVKODBGTU1rM0RqUmcyUkxvYmEzaWdmbXhyUEhXTzUwblYyTzRNR3dJbmNRRTg5dE1tZks5UVpDTDdULS1zaVhHaFhNc3pWQ2JGbk1iYnFmaTZCSlVGVEl1bmw3RGluekVZeHFaUVU5SmRkczloQmJTbjlyd3VjWXNLdGFseGdBNDhEQllPVFhDM2tXU1RJa2lCQ2NRR1g5LTNyM3ZLd0lfYjJ3LVUxakVjdlRCbmJzdmEyUHZZN0hXM05NZTV1ZEVfWDFXbzZjbHVYSTBDYWt5cXZZSS1jbi1zSHZ6N2VQZHhWUUNldGtSZnl3aHhwMnhzRkhfYWRRTF9VVXpfaUN0ODM5UTZCaG5UNGkwWTI5dUtTeWJGUmdDNkkzS0cxU0pSQllnUVNVMUtHYWpib1lPTkQ2WDU0NTlyQ3R0SEFETF9lR2tnN0YyTWduV2FKZnFVMkRZMXlVQ2dGbTNVU04wYUpzN21ldHRXcmRBMENmaVVIT1l4UEhycFFUbG55aXcxQ1NINm9pWklLNXJIcTR1WmFmN2pRWjJURGxyUGtfbXJDLXc1bFg5bGhzWkZnMVdNVzNoU2xMckMzbXdnd3RRVWw3clFseWhhWnh2V1B1YVVaMDRTeEdZSXZ3NVlhaGdoR0hncmxleUgxX3RFbGxtdy5Vb2xhQ3JsamhPeDlad3JCa1Z5VHhn.SwDXvh4EjPdPPCq3iOzOB5oXbecR_qtIZUUFDBlFbssXU1HGJzCjbNa5BpzH5FTxRHR6twixaUpsoYXVvtZ6VxPFvvE_3KkQenQvO2RQLrGlthVHiHzg4d4AZWboENjcfBQDNMxMjKgcAFU5UoW7gwdda2nZua4mF4RktSalvnfq1eUuV804nZ14KR8OCNaFBA0VUoa5M6M9gohERutuiJ89_lvPWvMmM7aZvphwRtPcp6vwXeAprWrZDyOiC6KEaIP1qZ7AdMUBJ8YLZigmGUY8QWM4y_EWwn8Z07NNl3Ypmbg7jmsMHy153H0O4ritc4_6wVqD9h8xe8l2ppJJyA&return_url=https%3A%2F%2Fwww.merchant.com&keyid=HMAC&objectid=mandate&transactionid=MT0450142024535
{
"objectid":"mandate",
"mandateid":"MN10A1157059143",
"mercid":"BDMERCID",
"customer_refid":"custfefbffrt",
"subscription_refid":"Suhfbfbfffrt",
"subscription_desc":"AVSdhvfibfffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"deleted",
"createdon":"2024-02-26T18:06:04+05:30",
"deletedon":"2024-02-26T18:27:00+05:30",
"payment_method_type":"upi",
"ru":"https://www.merchanturl.com/response.jsp",
"upi":{
"paymentaccountid":"PA0F95154692897",
"vpa":"john.doe@okaxis",
"psp":"okaxis"
},
"customer":{

},
"verification_error_code":"MNS0000",
"verification_error_type":"success",
"verification_error_desc":"Mandate Successful",
"recurrence_rule":"after",
"debit_day":"1",
"bank_umrn":"d70703b954ec42fb9eb80d75d69ac21d@okaxis"
}

{
"objectid":"mandate",
"mandateid":"MN2592157051326",
"mercid":"BDMERCID",
"customer_refid":"custfefbfrt",
"subscription_refid":"Suhfbfbffrt",
"subscription_desc":"AVSdhvfibffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"deleted",
"createdon":"2024-02-26T17:16:37+05:30",
"deletedon":"2024-02-26T17:54:18+05:30",
"payment_method_type":"card",
"ru":"https://www.merchanturl.com/response.jsp",
"card":{
"paymentaccountid":"PA0385154635099",
"masked_value":"xxxxxxxxxxxx2426",
"holder_name":"John",
"type":"CREDIT",
"card_end":"2426",
"network":"MASTER",
"issuer":"Yes Bank",
"cardaccountid":"CA033BF0000048210659"
},
"customer":{

},
"verification_error_code":"TRS0000",
"verification_error_type":"success",
"verification_error_desc":"Transaction Successful",
"issuer_ref_no":"X5nfLK69PY",
"recurrence_rule":"after",
"debit_day":"1",
"is_amex_flow":"N",
"bank_umrn":"X5nfLK69PY"
}

6.4 Mandate response for action "delete" when child window is "false"


terminal_state=Y&mandate_tokenid=NN054919682783&mandate_response=eyJhbGciOiJIUzI1NiIsImNsaWVudGlkIjoiYmRobWFjdGVzdCIsImtpZCI6IkhNQUMifQ.eyJtYW5kYXRlaWQiOiJNTjExNkExNTcwNDU2OTIiLCJ2ZXJpZmljYXRpb25fZXJyb3JfY29kZSI6Ik1OUzAwMDAiLCJ2ZXJpZmljYXRpb25fZXJyb3JftHlwZSI6InN1Y2Olc3MiLCJjcmVhdGVkb24iOiIyMDI0LTAyLTI2VDE3OjA4OjI2KzA1OjMwIiwidmVyaWZpY2F0aW9uX2Vycm9yX2Rlc2MiOiJNYW5kYXRlIFN1Y2Nlc3NmdWwiLCJzdGF0dXMiOiJERUxFVEVEIn0.Ffm1e-HwKW2-wkG3NIlsvC06lY2M5CCBjMhvGZ1lTv4&keyid=HMAC&objectid=mandate
ru=https%3A%2F%2Fwww.merchant.com&mandateid=MN1123467872146&mandate_tokenid=NN156C20863691&mandate_response=eyJ4NXQjUzI1NiI6IlpqNjdrb3JRMXdjTVAzQlZMWTRZM2N6UzNWVlVaS1c1dzgyTXZpNWNvODQiLCJraWQiOiJiZHRlc3QiLCJhbGciOiJQUzI1NiJ9.ZXlKNE5YUWpVekkxTmlJNkltWmxObGxzYkhVdFFYQjJRMWQwT1hRd1EyVlBkemc1ZGtKMVZGazVhRzFhU1ZaWVdFSnJhRlpCWWtraUxDSnJhV1FpT2lKaVpIUmxjM1FpTENKbGJtTWlPaUpCTVRJNFIwTk5JaXdpWVd4bklqb2lVbE5CTFU5QlJWQXRNalUySW4wLlh5cXN3MmNFZHo2RzIteVJjRGF0UDVQMmRXRWVEVFlGcTM4OGxSR21vNzBiSTJzcUdjTnRQNjhzOVJEc2ZJZzFwMmdUdUFGcWJobm1lazU5LTROeVNWV3FoOHNQM0Ixa0FHaTZXNS1VN3VPajJpOS15V3FMZVF3UHItRDVpN3ljQUxzRHdfV01SRXBMZmN3ZDhJMUx4NVU2QVl4TE5zdV9Da1JiREJoWXJzekJjMXRFdzNiUnFYdWpELWFSbjR1RksxdW9jV0V6SWw1c0RLSDNKSDc3QjBseVNCOFVGQjVSd2dzdmJpYlJVdl9YaUMwRU5fQ0FqRVcxQ2cwNmljd2ZnUkRtRi1JaUZmWmhtSkZvY1lxOVlaVXBzN01YcFNPdzFqY0lwRzZfVXQ2ZUVjTTZlZXduR1ZfS1hBbUpaV3JxX1ZBYzg0RmZoVE5WeGJoSjRCaWZyUS5OYjJHNFdJa0tHMTVFcW5iLllrVno4QnYyM3dtMmVsY0NVQXdYbEdraEJlaXFsdlJleWhSMUgyb0pvUXQ0Qk5tbXk4MjRJN0ZQbTNkV1VkSHVmVHBJbTh3N3Zka2xna25RX29oNG5wMWszNXh2STdFZXczZ0IzamNVOEoxN21RNmRCcjRQbXJMUTZMWlh3RHBCdHI1WjlaeWtqdlliUk9jRU05c1VNLXY3TG5EVGpDN283ZkVLUkhUaVBHVmoxdE8tMHF4SWJHLVA5ZGxuQmJ1cjRFY2pHSjJhdk9KSndnTmlGNFZ6UGgzQ19xa0ZCTWtTX0FEZVZXV1pqeWYyNGxnQ3V3aXktWXpLQUhCTjBGd0dMODJTd2FTb2xveUVjZkZjcWhNT2QyZi1BRk5zSl9mWWlESDhzQkJPOUFremZiRmZ1SEpVLVFVM0F5aVRUNVZ4X04zOUpnOUdIdGFMcmE2MHNSLWJ6QW91czJQbFFCby1Oay1ZSjVwVWI2Vl9nQ29SVGxKN1B5dS1jSWh6TG5xVFpPV3V5b0thSk02NGlWZ0JoWkdIOEJ5dy1qTUw2SUxKYXI1ZGhLUHdsbmo5WGw0SkQzYk05WHg4WTNkb0xGbGdhVDlJR1RNT2lzd3U1eER5RDJZVVk0UXJWbEU4RG9JeHVDNjhfcHpxc1ZjdUthRmllXzMtMlVodjZsVmlaWEJJQkxrcEhOaENnaGxCZUxhdWxuLVFlcDlqcUlndXI1T1E3N1p0cDlBSFNwRURwQ3Uyd1pPZHhfSWFnMzAxR05CSWVLdzFBUGJWWHUzUjFpd0ZZTTY1Mlp0bmNzS0N6VU4tQmdrdDNOVWluRjYtMDNBMGVKODBGTU1rM0RqUmcyUkxvYmEzaWdmbXhyUEhXTzUwblYyTzRNR3dJbmNRRTg5dE1tZks5UVpDTDdULS1zaVhHaFhNc3pWQ2JGbk1iYnFmaTZCSlVGVEl1bmw3RGluekVZeHFaUVU5SmRkczloQmJTbjlyd3VjWXNLdGFseGdBNDhEQllPVFhDM2tXU1RJa2lCQ2NRR1g5LTNyM3ZLd0lfYjJ3LVUxakVjdlRCbmJzdmEyUHZZN0hXM05NZTV1ZEVfWDFXbzZjbHVYSTBDYWt5cXZZSS1jbi1zSHZ6N2VQZHhWUUNldGtSZnl3aHhwMnhzRkhfYWRRTF9VVXpfaUN0ODM5UTZCaG5UNGkwWTI5dUtTeWJGUmdDNkkzS0cxU0pSQllnUVNVMUtHYWpib1lPTkQ2WDU0NTlyQ3R0SEFETF9lR2tnN0YyTWduV2FKZnFVMkRZMXlVQ2dGbTNVU04wYUpzN21ldHRXcmRBMENmaVVIT1l4UEhycFFUbG55aXcxQ1NINm9pWklLNXJIcTR1WmFmN2pRWjJURGxyUGtfbXJDLXc1bFg5bGhzWkZnMVdNVzNoU2xMckMzbXdnd3RRVWw3clFseWhhWnh2V1B1YVVaMDRTeEdZSXZ3NVlhaGdoR0hncmxleUgxX3RFbGxtdy5Vb2xhQ3JsamhPeDlad3JCa1Z5VHhn.SwDXvh4EjPdPPCq3iOzOB5oXbecR_qtIZUUFDBlFbssXU1HGJzCjbNa5BpzH5FTxRHR6twixaUpsoYXVvtZ6VxPFvvE_3KkQenQvO2RQLrGlthVHiHzg4d4AZWboENjcfBQDNMxMjKgcAFU5UoW7gwdda2nZua4mF4RktSalvnfq1eUuV804nZ14KR8OCNaFBA0VUoa5M6M9gohERutuiJ89_lvPWvMmM7aZvphwRtPcp6vwXeAprWrZDyOiC6KEaIP1qZ7AdMUBJ8YLZigmGUY8QWM4y_EWwn8Z07NNl3Ypmbg7jmsMHy153H0O4ritc4_6wVqD9h8xe8l2ppJJyA&return_url=https%3A%2F%2Fwww.merchant.com&keyid=HMAC&objectid=mandate&transactionid=MT0450142024535
{
"objectid":"mandate",
"mandateid":"MN10A1157059143",
"mercid":"BDMERCID",
"customer_refid":"custfefbffrt",
"subscription_refid":"Suhfbfbfffrt",
"subscription_desc":"AVSdhvfibfffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"deleted",
"createdon":"2024-02-26T18:06:04+05:30",
"deletedon":"2024-02-26T18:27:00+05:30",
"payment_method_type":"upi",
"ru":"https://www.merchanturl.com/response.jsp",
"upi":{
"paymentaccountid":"PA0F95154692897",
"vpa":"john.doe@okaxis",
"psp":"okaxis"
},
"customer":{

},
"verification_error_code":"MNS0000",
"verification_error_type":"success",
"verification_error_desc":"Mandate Successful",
"recurrence_rule":"after",
"debit_day":"1",
"bank_umrn":"d70703b954ec42fb9eb80d75d69ac21d@okaxis"
}

{
"objectid":"mandate",
"mandateid":"MN2592157051326",
"mercid":"BDMERCID",
"customer_refid":"custfefbfrt",
"subscription_refid":"Suhfbfbffrt",
"subscription_desc":"AVSdhvfibffyuerftineiu",
"start_date":"2024-02-26",
"end_date":"2026-08-20",
"amount":"10.00",
"amount_type":"fixed",
"currency":"356",
"frequency":"week",
"status":"deleted",
"createdon":"2024-02-26T17:16:37+05:30",
"deletedon":"2024-02-26T17:54:18+05:30",
"payment_method_type":"card",
"ru":"https://www.merchanturl.com/response.jsp",
"card":{
"paymentaccountid":"PA0385154635099",
"masked_value":"xxxxxxxxxxxx2426",
"holder_name":"John",
"type":"CREDIT",
"card_end":"2426",
"network":"MASTER",
"issuer":"Yes Bank",
"cardaccountid":"CA033BF0000048210659"
},
"customer":{

},
"verification_error_code":"TRS0000",
"verification_error_type":"success",
"verification_error_desc":"Transaction Successful",
"issuer_ref_no":"X5nfLK69PY",
"recurrence_rule":"after",
"debit_day":"1",
"is_amex_flow":"N",
"bank_umrn":"X5nfLK69PY"
}

Alternately, merchant can also use the mandateid parameter and call the Retrieve Mandate API to query the status of the mandate.

Updated 6 months ago