Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Transaction

Retrieve Transaction

Merchant can retrieve the transaction either by using mercid and orderid or the mercid and the transactionid.

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

Unique ID generated by the merchant for each request

transactionidstring

Unique transactionid created by BillDesk

refund_details'true'

Boolean value that should be provided as true to retrieve the refund information associated with transaction

Example request

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "transactionid": "U4560001099939"
}

Response

OK

mercidstring

Unique identifier as defined by BillDesk for each merchant

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.

transactionidstring

Unique transactionid created by BillDesk

orderidstring

Unique ID generated by the merchant for each request

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

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

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

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

bank_ref_nostring

Transaction reference number generated by bank or acquirer

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_typestring

Represents the error type for the response

transaction_error_descstring

Represents the error description for the response

payment_method_type'card' | 'netbanking' | 'upi' | 'eft' | 'cardless' | 'bankaccount'

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.

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

{
  "mercid": "BDMERCID",
  "transactionid": "U4560001099939",
  "orderid": "TEST0000009005",
  "transaction_date": "2023-03-14T15:14:39+05:30",
  "amount": "299.28",
  "txn_process_type": "y3ds",
  "bankid": "1HM",
  "itemcode": "DIRECT",
  "additional_info": {
    "additional_info1": "Details1",
    "additional_info2": "Details2",
    "additional_info3": "Details3",
    "additional_info4": "Details4",
    "additional_info5": "Details5",
    "additional_info6": "Details6",
    "additional_info7": "Details7"
  },
  "split_payment": {
    "mercid": "BDMERCID",
    "amount": "299.28"
  },
  "payment_category": "18",
  "me_ref_id": "545963"
}