Create Authentication

This endpoint creates a new authentication request to initiate a charge using a payment method.

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.

Acceptstring required

Example:application/jose

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

Content-Typestring required

Example:application/json

Request Content-Type to take the values application/jose

Request body

mercidstring required

Unique identifier as defined by BillDesk for each merchant

amountstring required

Transaction amount in two decimals, eg. 299.28

orderidstring required

Unique ID generated by the merchant for each request

currencystring required

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

bankidstring required

BillDesk defined unique identifier for acquirer Mandatory for Upi and Netbanking flows

itemcodestring required

Itemcode value as provided by BillDesk, with a default value DIRECT

authentication_type'3ds2' required

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

3ds_parameter'merchant' required

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

rustring required

Merchants URL where the customer will be redirected after a transaction is completed

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.

txn_process_type'y3ds' | '3ds' | 'collect' | 'intent' | 'qr' | 'nb' | 'eft' | 'si' required

Indicates transaction processing type, will be the following values: AFA payment • card - 3ds or y3ds or 3ds_redirect • upi – collect, qr or intent • netbanking – nb • eft - offline Recurring payment • card, upi, bankaccount – si

Example request

{
  "mercid": "BDMERCID",
  "amount": "299.28",
  "orderid": "TEST0000009005",
  "bankid": "1HM",
  "itemcode": "DIRECT",
  "authentication_type": "3ds2",
  "ru": "https://www.merchant.com",
  "txn_process_type": "y3ds",
  "device": {
    "user_agent": "Mozilla/5.0(WindowsNT10.0;WOW64;rv: 51.0)Gecko/20100101Firefox/51.0",
    "accept_header": "application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
    "browser_language": "en-US",
    "browser_tz": "-330",
    "browser_color_depth": "652",
    "browser_screen_height": "452",
    "browser_screen_width": "702"
  },
  "card": {
    "number": "4242420000001234",
    "expiry_month": "02",
    "expiry_year": "2029",
    "holder_name": "John Doe",
    "cvv": "123"
  },
  "mandate": {
    "mercid": "BDMERCID",
    "customer_refid": "CUSTREF00A00011",
    "subscription_refid": "SUBREF00A00011",
    "start_date": "2021-05-08",
    "end_date": "2059-12-31",
    "amount": "200.28",
    "currency": "356",
    "frequency": "adho",
    "debit_day": "1"
  },
  "additional_info": {
    "additional_info1": "Details1",
    "additional_info2": "Details2",
    "additional_info3": "Details3",
    "additional_info4": "Details4",
    "additional_info5": "Details5",
    "additional_info6": "Details6",
    "additional_info7": "Details7"
  }
}

Response

OK

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

itemcodestring

Itemcode value as provided by BillDesk, with a default value DIRECT

authenticationidstring

Unique authenticationid created by BillDesk

authentication_datestring

Authentication date and time in YYYY-MM-DDThh:mm:ssTZD format

amountstring

Transaction amount in two decimals, eg. 299.28

currencystring

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

bankidstring

BillDesk defined unique identifier for acquirer Mandatory for Upi and Netbanking flows

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.

authentication_type'3ds2'

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

orderidstring

Unique ID generated by the merchant for each request

next_step'redirect' | 'capture_otp' | '3ds2_challenge' | '3ds2_frictionless'

Refers to the action to be taken by the merchant, for eg. redirect or capture_otp

authentication_status'pending' | 'success' | 'failure'

Represents the status of the request – with possible values as • pending • success • failure

authentication_error_codestring

Represents the error code for the response

authentication_error_typestring

Represents the error type for the response

authentication_error_descstring

Represents the error description for the response

threeds_transaction_idstring uuid

Threeds server transaction id

Example response

{
  "mercid": "BDMERCID",
  "itemcode": "DIRECT",
  "authenticationid": "A1HM0000389872",
  "amount": "299.28",
  "bankid": "1HM",
  "authentication_type": "3ds2",
  "orderid": "TEST0000009005",
  "card": {
    "type": "debit, credit, prepaid",
    "masked_value": "xxxxxxxxxxxx1001",
    "network": "VISA, MASTER"
  },
  "additional_info": {
    "additional_info1": "Details1",
    "additional_info2": "Details2",
    "additional_info3": "Details3",
    "additional_info4": "Details4",
    "additional_info5": "Details5",
    "additional_info6": "Details6",
    "additional_info7": "Details7"
  },
  "threeds_transaction_id": "4184a9f8-b0f3-47d2-91ec-bc9939080e32"
}

v1

Create Authentication

Headers

Request body

Example request

Response

Example response