API Explorer

Modify Mandate

post
https://uat1.billdesk.com/u2/pgsi/ve1_2/mandates/modify

List of attributes that can be modified depend upon the payment method type. An AFA using the payment method linked with the mandate is required to modify one or more of the attributes.

Body Params
string
required

Unique identifier as defined by BillDesk for each merchant

string
required

Unique mandateid created by BillDesk

date

Subscription end date in yyyy-mm-dd format Note: Should be greater than current date (IST timezone). For mandates that are valid ‘until cancelled’ by the customer, end_date year could be 2099, and for upi, maximum duration allowed for a mandate is 30 years

string

Subscription amount in two decimals, eg. 2400.00

string
enum

Indicates whether subscription amount is fixed or has a maximum limit. The following values are possible • maximum - indicates the maximum amount that can be charged for the subscription • fixed – indicates the fixed amount to be charged for the subscription Please note: For upi, only "maximum" is allowed. This is required to allow for token debit (small value transaction)

Allowed:
string
enum

Frequency at which the subscription debits will be processed, possible values are: •week - weekly •mnth - monthly •bimn – bi-monthly •qurt - quarterly •bian – bi-annually •year - yearly •adho – adhoc

Allowed:
string
enum
required

Represents the type of authentication initiated in the request, will be fixed value - 3ds2

Allowed:
string
enum
required

Value that determines which entity will capture the device attributes, possible values are merchant

Allowed:
string
enum
required

Represents the method of payment, and can take the following values - card, netbanking, wallet, upi, eft, bankaccount, cashcard, cardless (non-card emi option) The associated object will also be provided in the request.

Allowed:
card
required
device
object
required

Device Object

Headers
string
required

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

string
required

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

string
required

Request Content-Type to take the values application/jose

string
required

Accept Response Content-Type to take the values application/jose

Responses

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago