Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Penny Drop

Penny Drop

This API facilitates account validation with pennydrop

post/pgauth/ve1_2/accountvalidation

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

Unique identifier as defined by BillDesk for each merchant

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

itemcodestring

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

orderidstring

Unique ID generated by the merchant for each request

payment_method'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.

Example request

{
  "mercid": "BDMERCID",
  "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"
  },
  "orderid": "TEST0000009005",
  "bank_account": {
    "number": "12233445566",
    "ifsc": "IDBK10000002"
  },
  "customer": {
    "name": "John Doe"
  },
  "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"
  }
}

Response

OK

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.

validationidstring
mercidstring

Unique identifier as defined by BillDesk for each merchant

orderidstring

Unique ID generated by the merchant for each request

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

itemcodestring

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

auth_status'pending' | 'failure'

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

bankrefnostring

Transaction reference number generated by bank or acquirer

name_matched'true' | 'false'

Value that indicates the status of name matching

createdonstring date-time

object creation timestamp

Example response

{
  "bank_account": {
    "number": "12233445566",
    "ifsc": "IDBK10000002",
    "name": "John Doe"
  },
  "customer": {
    "name": "John Doe"
  },
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "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"
  }
}