v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB

Transaction

Create Transaction

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

post/payments/ve1_2/transactions/create

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

bankidstring

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

currencystring required

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

rustring required

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

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

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

itemcodestring required

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

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.

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

Example request

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "amount": "299.28",
  "bankid": "1HM",
  "ru": "https://www.merchant.com",
  "authentication_type": "3ds2",
  "txn_process_type": "y3ds",
  "itemcode": "DIRECT",
  "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"
  },
  "customer_refid": "CSREF00001",
  "avs": {
    "bankaccounts": [
      {
        "number": "12233445566",
        "ifsc": "IDBK10000002",
        "name": "John Doe"
      }
    ]
  },
  "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"
  },
  "upi": {
    "vpa": "abc@okbank"
  },
  "additional_info": {
    "additional_info1": "Details1",
    "additional_info2": "Details2",
    "additional_info3": "Details3",
    "additional_info4": "Details4",
    "additional_info5": "Details5",
    "additional_info6": "Details6",
    "additional_info7": "Details7"
  }
}

Response

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

transactionidstring

Unique transactionid created by BillDesk

orderidstring

Unique ID generated by the merchant for each request

mercidstring

Unique identifier as defined by BillDesk for each merchant

transaction_datestring date-time

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

amountstring

Transaction amount in two decimals, eg. 299.28

surchargestring

Customer surcharge in two decimals applied to the transaction amount, if any

discountstring

Customer discount in two decimals applied to the transaction amount, if any

charge_amountstring

Total charge to the customer

currencystring

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

rustring

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

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

bankidstring

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

itemcodestring

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

auth_status'0300' | '0002' | '0399'

Represents the authorization status of the transaction with the following possible values: • 0300 - transaction is successful • 0002 - transaction is pending for authorization • 0399 - transaction failed

transaction_error_codestring

Represents the error code for the response

transaction_error_descstring

Represents the error description for the response

transaction_error_typestring

Represents the error type for the response

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

payment_categorystring

Payment Category Code, defines the transaction belonging to the payment mode. • 00 - Card Gateway • 01 - Netbanking • 02 - Credit card • 03 - Debit card • 04 - Cash card • 05 - Mobile wallet • 10 - UPI • 11 - Bharat QR • 12 - Loan EMI • 13 - NEFT • 18 - UPI Credit • 19 - ENACH • 20 - CBDC • 21 - UPI Prepaid Wallet • 22 - UPI Credit Line

me_ref_idstring

Unique identifier for a merchant, defined by the acquiring bank as a 6 digit code

Example response

{
  "transactionid": "U4560001099939",
  "orderid": "TEST0000009005",
  "mercid": "BDMERCID",
  "transaction_date": "2023-03-14T15:14:39+05:30",
  "amount": "299.28",
  "ru": "https://www.merchant.com",
  "txn_process_type": "y3ds",
  "bankid": "1HM",
  "itemcode": "DIRECT",
  "card": {
    "masked_value": "xxxxxxxxxxxx1001",
    "type": "debit, credit, prepaid",
    "network": "VISA, MASTER",
    "cardaccountid": "CA0AAEF9000000000123",
    "cardaccount": {
      "mercid": "BDMERCID",
      "customer_refid": "CSREF00001",
      "orderid": "TEST0000009005"
    }
  },
  "additional_info": {
    "additional_info1": "Details1",
    "additional_info2": "Details2",
    "additional_info3": "Details3",
    "additional_info4": "Details4",
    "additional_info5": "Details5",
    "additional_info6": "Details6",
    "additional_info7": "Details7"
  },
  "avs": {
    "bankaccount": [
      {
        "number": "12233445566",
        "ifsc": "IDBK10000002",
        "name": "John Doe"
      }
    ]
  },
  "payment_category": "18",
  "me_ref_id": "545963"
}