generated: '2026-10-14'
method: derived
generator: derive-vocabulary.py
source:
- openapi/billdesk-linkpay-openapi.yml
- openapi/billdesk-pa-settlements-openapi.yml
- openapi/billdesk-payments-openapi.yml
- openapi/billdesk-penny-drop-openapi.yml
- openapi/billdesk-recurring-openapi.yml
vocabulary:
  name: BillDesk Domain Vocabulary
  description: 'Terms declared by BillDesk''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-14'
  terms:
  - term: amount
    definition: Payment link amount
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/amount
  - term: payment_method_allowed
    definition: Comma separated values to define payment method allowed in the payment link. Allowed values - quickpay, card, emi, nb, upi, wallets,
      qr, gpay, neft_rtgs, whatsapppay, cbdc or all
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/payment_method_allowed
  - term: customer_notification-request
    definition: Merchant can choose to send Email or SMS or both to the customer once payment link is generated.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/customer_notification-request
  - term: link_expiry_date
    definition: Expiry timestamp of the link. If not passed, the default expiry date is one month from the link creation date.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/link_expiry_date
  - term: link_desc
    definition: Merchant specific description of the link which gets displayed to the customer
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/link_desc
  - term: partial_payment_allowed
    definition: To determine if partial payment is allowed on the link against the total amount used for link creation.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/partial_payment_allowed
  - term: flow_type
    definition: Fixed value "payment"
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/flow_type
  - term: UDF
    definition: 'User defined fields defined by merchant which will be displayed to the customer on link summary page. Maximum udf objects allowed
      are 7. Note: Merchant is advised to not pass customer PII information in UDF fields.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/udf
  - term: max_payments_allowed
    definition: Only applicable in case partial payment allowed is true. Maximum number of partial payments that can be processed on the same
      link. This can be a maximum value of 10 (successful transactions).
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/max_payments_allowed
  - term: minimum_partial_amount
    definition: Minimum amount that is required to be paid for every partial payment. Applicable when partial payment allowed is true. If not
      passed, default value will be set to 1.00
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/minimum_partial_amount
  - term: objectid
    definition: String representing the object's type. Objects of the same type share the same value.
    tags:
    - Enumeration
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/objectid
  - term: linkid
    definition: Unique ID generated by BillDesk for a payment link
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/linkid
  - term: link
    definition: Payment link generated where customer must be redirected for payment
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/link
  - term: customer_notification
    definition: Merchant can choose to send Email or SMS or both to the customer once payment link is generated.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/customer_notification
  - term: Additional-Info
    definition: '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.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Additional-Info
  - term: createdon
    definition: object creation timestamp
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Createdon
  - term: currency
    definition: ISO currency code of the transaction amount as provided by BillDesk, with a fixed value 356.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Currency
  - term: customer
    definition: 'Object declared by the contract with fields: first_name, last_name, mobile, email.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Customer
  - term: mercid
    definition: Unique identifier as defined by BillDesk for each merchant
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Mercid
  - term: forwarding_url
    definition: 'Merchant specific url where customer will be redirected post transaction is completed. Please note : transaction details will
      not be posted on this url.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/forwarding_url
  - term: merc_link_ref_number
    definition: Unique reference number provided by merchant
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/merc_link_ref_no
  - term: link_title
    definition: Merchant specific title of the link which gets displayed to the customer
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/link_title
  - term: payment_method_allowed-response
    definition: If not passed or if passed as null, in response it will be all
    tags:
    - Enumeration
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/payment_method_allowed-response
  - term: max_payments_allowed-response
    definition: Maximum number of partial payments that can be processed on the same link. This can be a maximum value of 10 (successful transactions).
      Value of 1 indicates a single payment can be collected against the link.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/max_payments_allowed-response
  - term: minimum_partial_amount-response
    definition: Value equal to amount indicates a single payment can be collected against the link.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/minimum_partial_amount-response
  - term: error-object
    definition: 'Object declared by the contract with fields: status, error_type, error_code, message.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/error-object
  - term: customer-response
    definition: 'Customer object response. Note : PII data will be masked'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/customer-response
  - term: payment-object
    definition: This object is required for payment flow_type. Contains parameters pertaining to payment details.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/payment-object
  - term: payment-object-response
    definition: Payment object contains parameters pertaining to payment details.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/payment-object-response
  - term: avs
    definition: The avs object can be added to the request to initiate a payment with a third-party bank account validation. AVS is supported
      for the card (debit card), netbanking and upi payment methods.
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/avs-object
  - term: link_status
    definition: Status of payment link
    tags:
    - Enumeration
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/link_status
  - term: amount
    definition: Transaction amount in two decimals, eg. 299.28
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/amount-transaction
  - term: auth_status
    definition: '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'
    tags:
    - Enumeration
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Auth_status
  - term: payment_method_type
    definition: Represents the method of payment, and can take the following values - card, upi, wallets, nb.
    tags:
    - Enumeration
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Payment_method_type
  - term: transaction_date
    definition: BillDesk transaction date and time in YYYY-MM-DDThh:mm:ssTZD format
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Transaction_date
  - term: transactionid
    definition: Unique transactionid created by BillDesk
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/Transactionid
  - term: amount_pending
    definition: 'Remaining amount required to be paid against the link after the successful payments. Note : When partial payment is allowed'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/amount_pending
  - term: total_attempts
    definition: Total successful payment attempts processed out of the maximum number of payments allowed for the link
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/total_attempts
  - term: payment-object-fetch-response
    definition: 'Object declared by the contract with fields: amount, amount_pending, max_payments_allowed, minimum_partial_amount, partial_payment_allowed.'
    tags:
    - Object
    source: openapi/billdesk-linkpay-openapi.yml#/components/schemas/payment-object-fetch-response
  - term: Error-object
    definition: 'Object declared by the contract with fields: status, error_type, error_code, message.'
    tags:
    - Object
    source: openapi/billdesk-pa-settlements-openapi.yml#/components/schemas/Error-object
  - term: objectid
    definition: String representing the object's type. Objects of the same type share the same value.
    tags:
    - Enumeration
    source: openapi/billdesk-pa-settlements-openapi.yml#/components/schemas/Objectid
  - term: bdorderid
    definition: Unique value generated by BillDesk for each order id generated using Create Order API
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/bdorderid
  - term: rdata
    definition: Unique key generated by BillDesk for each request
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/rdata
  - term: authorization
    definition: Unique value generated by BillDesk for each request
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/authorization
  - term: IFSC
    definition: IFSC of the bank account number
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/IFSC
  - term: Mandate-Response
    definition: 'Object declared by the contract with fields: objectid, mercid, customer_refid, subscription_refid, subscription_desc, amount,
      amount_type, start_date, end_date, frequency, payment_method_type, currency. (6 more)'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Mandate-Response
  - term: Mandate
    definition: 'Object declared by the contract with fields: mercid, customer_refid, subscription_refid, subscription_desc, start_date, end_date,
      amount, currency, frequency, amount_type, recurrence_rule, debit_day.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Mandate
  - term: amount
    definition: Transaction amount in two decimals, eg. 299.28
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Amount
  - term: amount_type
    definition: 'Indicates whether subscription amount is fixed or has a maximum limit. The following values are possible • maximum - indicates
      the maximum amount that can be charged for the subscription • fixed – indicates the fixed amount to be charged for the subscription Please
      note: For upi, only "maximum" is allowed. This is required to allow for token debit (small value transaction)'
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Amount_type
  - term: Account validation
    definition: This API can be used to verify the bank account number by initiating a penny drop to the account. For upi, validation is done
      at acquiring bank end
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Avs-request
  - term: bankacc_number
    definition: Bank account number
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Bankacc_number
  - term: bankaccount_holder_name
    definition: Name of the bank account holder
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Bankaccount_holder_name
  - term: debit_day
    definition: Required only where payment_method_type = upi. Default value "1" to be passed
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Debit_day
  - term: Device
    definition: Device
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Device-order
  - term: end_date
    definition: 'Subscription end date in yyyy-mm-dd format Note: Should be greater than current date (IST timezone). For mandates that are valid
      ‘until cancelled’ by the customer, end_date year could be 2099, and for upi, maximum duration allowed for a mandate is 30 years'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/End_date
  - term: Invoice
    definition: 'Object declared by the contract with fields: invoice_number, invoice_display_number, customer_name, invoice_date, gst_details.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Invoice
  - term: item code
    definition: Itemcode value as provided by BillDesk, with a default value DIRECT
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Itemcode
  - term: next_step
    definition: Refers to the action to be taken by the merchant, for eg. redirect or capture_otp
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Next_step
  - term: orderid
    definition: Unique ID generated by the merchant for each request
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Orderid
  - term: recurrence_rule
    definition: 'Note: Required only where payment_method_type = upi. Default value : ''after'''
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Recurrence_rule
  - term: return URL
    definition: Merchants URL where the customer will be redirected after a transaction is completed
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Ru
  - term: split_payment_request
    definition: This object is applicable in case a merchant has opted to receive the settlement in multiple settlement accounts
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Split_payment_request
  - term: start_date
    definition: 'Subscription start date in yyyy-mm-dd format Note: Should be greater than or equal to current date (IST timezone). Note for UPI
      : Should be equal to mandate creation date for UPI. In UPI, an subsequent charge is created on a successful mandate. This includes the first
      charge as well along with mandate creation. Since first charge is done immediately, it is important that the mandate “start_date” s'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Start_date
  - term: mandate_tokenid
    definition: Unique value generated by BillDesk for each mandate_token created by the merchant
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/mandate_tokenid
  - term: customer_refid
    definition: 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
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Customer_refid
  - term: frequency
    definition: 'Frequency at which the subscription debits will be processed, possible values are: •week - weekly •mnth - monthly •bimn – bi-monthly
      •qurt - quarterly •bian – bi-annually •year - yearly •adho – adhoc'
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Frequency
  - term: subscription_desc
    definition: Customer friendly description for the subscription, this narration is generally displayed to the customer at the issuer channel
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Subscription_desc
  - term: subscription_refid
    definition: Unique reference assigned by merchant for a subscription
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Subscription_refid
  - term: mandateid
    definition: Unique mandateid created by BillDesk
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Mandateid
  - term: subscription_amount
    definition: Subscription amount in two decimals, eg. 2400.00
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Subscription_amount
  - term: subscription_status
    definition: 'Represents the status of the mandate and depends upon the linked payment method. The following values are possible: card, upi
      • initiated - mandate request has been initiated, and this status is applicable for the SDK based workflow • pending - mandate request has
      been initiated and the linked payment method is not yet validated • active – linked payment method has been validated and recurring cha'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Subscription_status
  - term: 3ds_parameter
    definition: Value that determines which entity will capture the device attributes, possible values are merchant
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/3ds_parameter
  - term: Device
    definition: 'Object declared by the contract with fields: init_channel, ip, user_agent, accept_header, browser_language, browser_javascript_enabled,
      browser_tz, browser_color_depth, browser_java_enabled, browser_screen_height, browser_screen_width.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Device
  - term: Pay using alt id token
    definition: 'Object declared by the contract with fields: altid_token, card_end, cvv, holder_name.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Pay-using-altid
  - term: Pay using card account id
    definition: 'Object declared by the contract with fields: cardaccountid, cvv, card_end, holder_name.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Pay-using-card-account-id
  - term: Pay using card number - pan
    definition: 'Object declared by the contract with fields: number, expiry_month, expiry_year, holder_name, cvv, tokenize, coft_consent.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Pay-using-card-number-pan
  - term: Pay using issuer token
    definition: 'Object declared by the contract with fields: issuer_token, card_end, cvv, holder_name.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Pay-using-issuer-token
  - term: Pay using network token
    definition: 'Object declared by the contract with fields: network_token, card_end, cvv, holder_name.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Pay-using-network-token
  - term: authentication_type
    definition: Represents the type of authentication initiated in the request, will be fixed value - 3ds2
    tags:
    - Enumeration
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Authentication_type
  - term: Avs-response
    definition: 'Object declared by the contract with fields: bankaccount, account_matched, name_matched.'
    tags:
    - Object
    source: openapi/billdesk-payments-openapi.yml#/components/schemas/Avs-response