v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB

Authentication

Retrieve Authentication

This endpoint retrieves the details of a particular authentication using either of mercid and orderid or transactionid.

post/payments/ve1_2/authentications/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

authenticationidstring

Unique authenticationid created by BillDesk

orderidstring

Unique ID generated by the merchant for each request

Example request

{
  "mercid": "BDMERCID",
  "authenticationid": "A1HM0000389872",
  "orderid": "TEST0000009005"
}

Response

itemcodestring

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

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

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

mercidstring required

Unique identifier as defined by BillDesk for each merchant

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

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

ecistring

Authentication ECI indicator, as per the 3ds protocol (for V, M, D, A cards)

cavvstring

CAVV value generated by issuer (for V, M, D, A cards)

rupay_auth_ref_nostring

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

threeds_version'2.1.0' | '2.2.0'

Protocol of the 3ds2.0 version used for authentication

ds_transaction_idstring

Directory server transaction id for 3ds2.0

threeds_transaction_idstring uuid

Threeds server transaction id

Example response

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