Product Configuration Entity

{
  "requested_configuration": [],
  "active_configuration": {
    "payment_capture": {
      "mode": "automatic",
      "refund_speed": "normal",
      "automatic_expiry_period": 7200
    },
    "settlements": {
      "account_number": "1234567890",
      "ifsc_code": "HDFC0000317",
      "beneficiary_name": "Gaurav Kumar"
    },
    "checkout": {
      "theme_color": "#528FFF",
      "flash_checkout": true,
      "logo": "https://example.com/your_logo"
    },
    "refund": {
      "default_refund_speed": "optimum"
    },
    "notifications": {
      "whatsapp": false,
      "sms": false,
      "email": [
        "gaurav.kumar@example.com",
        "acd@example.com"
      ]
    }
  },
  "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": "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": "payment_gateway",
  "activation_status": "needs_clarification",
  "requested_at": 1605181524
}

{
  "requested_configuration": [],
  "active_configuration": {
    "payment_capture": {
      "mode": "automatic",
      "refund_speed": "normal",
      "automatic_expiry_period": 7200
    },
    "settlements": {
      "account_number": "1234567890",
      "ifsc_code": "HDFC0000317",
      "beneficiary_name": "Gaurav Kumar"
    },
    "checkout": {
      "theme_color": "#528FFF",
      "flash_checkout": true,
      "logo": "https://example.com/your_logo"
    },
    "refund": {
      "default_refund_speed": "optimum"
    },
    "notifications": {
      "whatsapp": false,
      "sms": false,
      "email": [
        "gaurav.kumar@example.com",
        "acd@example.com"
      ]
    }
  },
  "requirements": [
    {
      "field_reference": "settlements.account_number",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "settlements.ifsc",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "settlements.beneficiary_name",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    }
  ],
  "tnc":{
    "id": "tnc_IgohZaDBHRGjPq",
    "accepted": true,
    "accepted_at": 1641550798
  },
  "id": "acc_prd_HEgNpywUFctQ9f",
  "account_id": "acc_HQVlm3bnPmccC0",
  "product_name": "payment_links",
  "activation_status": "needs_clarification",
  "requested_at": 1605181524
}

The Product Configuration entity has the following parameters:

{
  "requested_configuration": [],
  "active_configuration": {
    "payment_capture": {
      "mode": "automatic",
      "refund_speed": "normal",
      "automatic_expiry_period": 7200
    },
    "settlements": {
      "account_number": "1234567890",
      "ifsc_code": "HDFC0000317",
      "beneficiary_name": "Gaurav Kumar"
    },
    "checkout": {
      "theme_color": "#528FFF",
      "flash_checkout": true,
      "logo": "https://example.com/your_logo"
    },
    "refund": {
      "default_refund_speed": "optimum"
    },
    "notifications": {
      "whatsapp": false,
      "sms": false,
      "email": [
        "gaurav.kumar@example.com",
        "acd@example.com"
      ]
    }
  },
  "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": "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": "payment_gateway",
  "activation_status": "needs_clarification",
  "requested_at": 1605181524
}

{
  "requested_configuration": [],
  "active_configuration": {
    "payment_capture": {
      "mode": "automatic",
      "refund_speed": "normal",
      "automatic_expiry_period": 7200
    },
    "settlements": {
      "account_number": "1234567890",
      "ifsc_code": "HDFC0000317",
      "beneficiary_name": "Gaurav Kumar"
    },
    "checkout": {
      "theme_color": "#528FFF",
      "flash_checkout": true,
      "logo": "https://example.com/your_logo"
    },
    "refund": {
      "default_refund_speed": "optimum"
    },
    "notifications": {
      "whatsapp": false,
      "sms": false,
      "email": [
        "gaurav.kumar@example.com",
        "acd@example.com"
      ]
    }
  },
  "requirements": [
    {
      "field_reference": "settlements.account_number",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "settlements.ifsc",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    },
    {
      "field_reference": "settlements.beneficiary_name",
      "resolution_url": "/accounts/acc_HQVlm3bnPmccC0/products/acc_prd_HEgNpywUFctQ9f",
      "reason_code": "field_missing",
      "status": "required"
    }
  ],
  "tnc":{
    "id": "tnc_IgohZaDBHRGjPq",
    "accepted": true,
    "accepted_at": 1641550798
  },
  "id": "acc_prd_HEgNpywUFctQ9f",
  "account_id": "acc_HQVlm3bnPmccC0",
  "product_name": "payment_links",
  "activation_status": "needs_clarification",
  "requested_at": 1605181524
}

string

The unique identifier of a product generated by Razorpay for a sub-merchant account. This id is used to fetch or update a product.

string

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

payment_gateway
payment_links

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 the following fields:

string

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

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.

integer

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

string

The status of the product activation.

requested
needs_clarification
under_review
activated
suspended

object

The following are the possible configurations:

object

The payment methods configured, such as, netbanking, UPI, Wallet and EMI.

object

The UPI type payment method.

string

The status of UPI payment method.

array

The list of UPI instruments requested or enabled.

object

The netbanking type payment method.

string

The status of the netbanking payment method.

array

The netbanking instrument object.

string

The type of netbanking payment method. Possible values:

Retail
Corporate

array

The list of netbanking banks requested or enabled. Refer the Appendix page for netbanking bank codes.

object

The Wallet type payment method.

string

The status of the Wallet payment method.

array

The list of Wallet instruments requested or enabled.

string

The EMI type payment method.

string

The status of EMI payment method.

array

The EMI instrument object.

string

The type of EMI payment method. Possible values:

card_emi
cardless_emi

array

The list of EMI partners requested or enabled. Possible values:

For card_emi: debit and credit.
For cardless_emi: zestmoney and earlysalary.

object

The payment method to be enabled.

boolean

Enables or disables the payment method. Possible values:

true: Enables the paylater payment method.
false: Does not enable the paylater payment method.

string

The Paylater service provider. Possible values are:

epaylater
getsimpl

object

The payment capture settings object.

string

The mode through which payment capture is done. Possible values:

automatic: Payments are auto-captured (default)
manual: You have to manually capture payments using our Capture API or from the Partner’s Dashboard.

numeric

This denotes the time in minutes when the payment is in the authorized state. This is auto-captured.

numeric

This denotes the time in minutes until you can manually capture payments in the authorized state.

Must be equal to or greater than the automatic_expire_period value.
The default and the maximum value is 7200 minutes.
The payments in the authorized state after the manual_expiry_period are auto-refunded.

object

The Settlement settings object.

string

The bank account number to which settlements are made. Account details can be found on the Partner’s Dashboard. For example, 7878780080316316.

string

The IFSC associated with the bank account. For example, RATN0VAAPIS.

string

The name of the beneficiary associated with the bank account.

Handy TipThis API parameter is needed complete the KYC process. However, it is optional for this API.

object

This denotes the payment refund settings.

string

Speed at which the refund is to be processed. Possible values are:

normal: Indicates that the refund will be processed at the normal speed. By default, the refund will take 5-7 working days.
optimum: Indicates that the refund will be processed at an optimal speed based on Razorpay’s internal fund transfer logic. That is:
- If the refund can be processed instantly, Razorpay will initiate the process irrespective of the payment method used to make the payment.
- If an instant refund is not made, Razorpay will initiate a refund that is processed at the normal speed. For example, payments made using debit cards, netbanking or unsupported credit cards.

object

The checkout form of the payment capture.

string

The theme color for sub-merchant’s checkout page

string

The logo of the sub-merchant’s business on the checkout page.

boolean

The flagging options Enable or Disable for Razorpay’s Flash Checkout to securely save the card details of your customers.

object

This denotes the notifications settings.

string

The email addresses that will receive notifications regarding payments, settlements, daily payment reports, webhooks, and so on.

boolean

The WhatsApp notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc.

boolean

The SMS notifications you receive regarding payments, settlements, daily payment reports, webhooks, etc. This attribute will be set to false.

object

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

object

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

object

The list of requirements to be enabled for this product or some of the configurations under this product. It is classified into two types:

Required document: field_reference: “proof_type.document_type”. For example: business_proof_of_identification.business_pan_url. The sub-merchant needs to upload the business_pan_url document to get the requirement fulfilled.
Selected required document: field_reference : “proof_type”. For example: individual_proof_of_address. The sub-merchant can upload ONE of the following groups, that is, submit [aadhar_front ,aadhar_back] or [voter_id_front, voter_id_back] or [passport_front, passport_back]. Once all the documents of any ONE of the groups are uploaded, the requirement gets fulfilled.

string

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

string

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

string

The status of the requirement.

string

The reason code for showing in the requirement. Description will be sent only when reason code is "". Possible values are:

field_missing
needs_clarification
document_missing

string

This parameter is displayed when the reason_code is needs_clarification.

integer

The Unix timestamp at which the product configuration is requested.

Partners

Payout APIs

Product Configuration Entity