Product Configuration Entity

Know about product configuration entity parameters and their description.

Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States

The Product Configuration entity has the following parameters.

Entity

{
  "requested_configuration":[
    
  ],
  "active_configuration":{
    "settlements":{
      "account_number":"1234567890",
      "ifsc_code":"HDFC0000317",
      "beneficiary_name":"Gaurav Kumar"
    }
  },
  "requirements":[
    {
      "field_reference":"settlements.account_number",
      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code":"field_missing",
      "status":"required"
    },
    {
      "field_reference":"settlements.ifsc",
      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code":"field_missing",
      "status":"required"
    },
    {
      "field_reference":"kyc.pan",
      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code":"kyc_failed",
      "status":"required"
    },
    {
      "field_reference":"settlements.beneficiary_name",
      "resolution_url":"/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9e",
      "reason_code":"field_missing",
      "status":"required"
    }
  ],
  "tnc":{
    "id":"tnc_IgohZaDBHRGjPv",
    "accepted":true,
    "accepted_at":1641550798
  },
  "id":"acc_prd_HEgNpywUFctQ9e",
  "account_id":"acc_HQVlm3bnPmccC0",
  "product_name":"route",
  "activation_status":"needs_clarification",
  "requested_at":1605181524
}

id · string

The unique identifier of a product generated by Razorpay. This id is used to fetch or update a product.

product_name · string

The product(s) to be configured. Possible values:

• Route

tnc_accepted · object

It consists of the configuration for the accepted terms and conditions by the merchant for the requested product. If the terms and conditions are accepted by the user for the requested product, it would consist of following fields:

id · string

The unique identifier representing the acceptance of terms and conditions for a product by a user.

accepted · boolean

The flag that represents whether the terms and conditions are accepted by the user.

• true: Terms and conditions are accepted by user.
• false: Terms and conditions are not accepted by user.

accepted_at · integer

The Unix timestamp at which the terms and conditions were accepted by the user for the requested product.

requested_configuration · object

The configuration of the product requested by the user that is yet to be set as active.

active_configuration · object

The configuration of the product that has been set as active.

settlements · object

The Settlement settings object.

beneficiary_name · string

The name of the beneficiary associated with the bank account. This API parameter is needed to complete the KYC process. However, it is optional for this API.

requirements · object

The list of requirements to be enabled for this product or some of the configurations under this product.

field_reference · string

The field which is in issue or missing. The JSON key path in resolution URL.

resolution_url · string

The URL to address the requirement. The API endpoint to be used for updating missing fields or documents.

status · string

The status of the requirement.

reason_code · string

The reason code for showing in the requirement. Possible values are:

• field_missing
• needs_clarification
• document_missing

id · string

The unique identifier of the account generated by Razorpay. For example, acc_prd_K1eopFF8G21tux. The product is created for this account id.

account_id · string

The unique identifier generated by Razorpay. For example, acc_K1em7bWYEiwmnc.

product_name · string

The product(s) to be configured. Here it is route.

activation_status · string

The status of the product activation.

• requested
• needs_clarification
• under_review
• activated
• suspended

requested_at · integer

The Unix timestamp at which the product configuration has been requested.