Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Mandate

List Mandates

All mandates created for a customer or for created date range [not exceeding 7 days] can be listed through this API.

post/pgsi/ve1_2/mandates/list

Headers

BD-Traceidstring required
Example:20201203182838

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.

BD-Timestampstring required
Example:20201203182838

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.

Content-Typestring required
Example:application/json

Request Content-Type to take the values application/jose

Acceptstring required
Example:application/jose

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

Request body

mercidstring required

Unique identifier as defined by BillDesk for each merchant

customer_refidstring

Unique reference of the customer in the merchant system, and can be linked to different subscriptions of the same customer Required for mandate and tokenization

subscription_refidstring

Unique reference assigned by merchant for a subscription

from_datestring date

Start mandate creation date for the date range

to_datestring date

End mandate creation date for the date range

Example request

{
  "mercid": "BDMERCID",
  "customer_refid": "CSREF00001",
  "subscription_refid": "SUBREF101",
  "from_date": "2023-05-16",
  "to_date": "2029-10-22"
}

Response

objectid'transaction' | 'authentication' | 'mandate' | 'invoice' | 'cardaccount' | 'validatevpa' | 'dispute' | 'settlement' | 'altid' | 'mandate_token' | 'accountvalidation'

String representing the object's type. Objects of the same type share the same value.

Example response

{
  "mandates": [
    {
      "mandateid": "MA19E400049927",
      "mercid": "BDMERCID",
      "customer_refid": "CSREF00001",
      "subscription_refid": "SUBREF101",
      "subscription_desc": "Unlimited Plan",
      "start_date": "2021-05-08",
      "end_date": "2059-12-31",
      "amount": "2400.00",
      "customer": {
        "first_name": "John",
        "last_name": "Doe",
        "mobile": "9022979988",
        "email": "abc@xyz.com"
      }
    }
  ]
}