Create Authentication

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

Body Params
string
required
^[A-Za-z0-9]{1,10}$

Unique identifier as defined by BillDesk for each merchant

string
required
^([1-9]{1}[0-9]{0,7}(\.[0-9]{1,2})?)$

Transaction amount in two decimals, eg. 299.28

string
required
^[-/~A-Za-z0-9\_ \:.,#@!\\*\\+]{1,120}$

Unique ID generated by the merchant for each request

string
required

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

string
required
^[A-Za-z0-9]{1,10}$

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

string
required
^[A-Za-z0-9]{1,20}$

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

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
required
=^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;{]*[-a-zA-Z0-9+&@#/%=~_|} ]{1,2000}$

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

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:
string
enum
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

device
object
required
card
required
mandate
object
additional_info
object

Array of 7 additional_info values that can be attached to
the transaction.
Note: Merchant is advised to not pass customer PII
information in additional info fields.

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.

Responses

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