v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Guest Checkout (AltID)

Fetch AltID

This API is used to retrieve the AltID value from network

post/payments/ve1_2/altid/get

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

orderidstring required

Unique ID generated by the merchant for each request

amountstring required

Transaction amount in two decimals, eg. 299.28

currencystring required

ISO currency of the transaction amount, for INR this value will be 356

rupay_auth_ref_nostring

Refers to the specific transaction reference provided by NPCI (for R cards)

Example request

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "amount": "299.28",
  "device": {
    "ip": "123.0.0.1",
    "user_agent": "Mozilla/5.0(WindowsNT10.0;WOW64;rv: 51.0)Gecko/20100101Firefox/51.0"
  },
  "card": {
    "number": "4242420000001234",
    "expiry_month ": "02",
    "expiry_year": "2029",
    "cvv": "123",
    "holder_name": "John Doe"
  }
}

Response

OK

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.

mercidstring

Unique identifier as defined by BillDesk for each merchant

orderidstring

Unique ID generated by the merchant for each request

masked_valuestring

Masked card number, with the last four digits

altid_valuestring

The unique alt id for the Card Number provided in the request.

altid_cryptogramstring

Alt id cyptogram

altid_expiry_monthstring

alt id expiry month

altid_expiry_yearstring

alt id expiry year

request_datestring

Request initiation timestamp in YYYY-MM-DDThh:mm:ssTZD format

Example response

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "masked_value": "xxxxxxxxxxxx1001",
  "altid_expiry_month": "02",
  "altid_expiry_year": "2029"
}