Gold Loan Protocol Changes #520

Het1919 · 2025-07-24T09:41:24Z

Het1919
Jul 24, 2025

We're planning to go live on the GOLD Loan protocol by the 20th August, so please have a look at the link attached below for gold loan protocol changes.

Gold Loan Protocol Note

@Sumitkumar0503 @92shreyansh

92shreyansh · 2025-07-25T18:49:47Z

92shreyansh
Jul 25, 2025
Maintainer

Have reviewed & some comments on the document.
Regarding the payload structure have some comments adding praposed on_select payload of offer

{
  "context": {
    "domain": "ONDC:FIS12",
    "location": {
      "country": {
        "code": "IND"
      },
      "city": {
        "code": "*"
      }
    },
    "action": "on_select",
    "version": "2.0.2",
    "bap_id": "bap.credit.becknprotocol.io",
    "bap_uri": "https://bap.credit.becknprotocol.io/",
    "bpp_id": "bpp.credit.becknprotocol.org",
    "bpp_uri": "https://bpp.credit.becknprotocol.org",
    "transaction_id": "a9aaecca-10b7-4d19-b640-b047a7c62195",
    "message_id": "c8e3968c-cd78-4e46-aa34-0d541e46bd73",
    "timestamp": "2023-05-25T05:23:03.443Z",
    "ttl": "P30M"
  },
  "message": {
    "order": {
      "provider": {
        "id": "PROVIDER_ID",
        "descriptor": {
          "images": [
            {
              "url": "https://www.icicibank.com/content/dam/icicibank/india/assets/images/header/logo.png",
              "size_type": "sm"
            }
          ],
          "name": "ICICI Bank",
          "short_desc": "ICICI Bank Ltd",
          "long_desc": "ICICI Bank Ltd, India."
        },
        "tags": [
          {
            "descriptor": {
              "code": "CONTACT_INFO",
              "name": "Contact Info"
            },
            "list": [
              {
                "descriptor": {
                  "code": "GRO_NAME",
                  "name": "Gro name"
                },
                "value": "ICICI"
              },
              {
                "descriptor": {
                  "code": "GRO_EMAIL",
                  "name": "Gro email"
                },
                "value": "lifeline@iciciprulife.com"
              },
              {
                "descriptor": {
                  "code": "GRO_CONTACT_NUMBER",
                  "name": "Gro contact number"
                },
                "value": "1860 266 7766"
              },
              {
                "descriptor": {
                  "code": "GRO_DESIGNATION",
                  "name": "Gro Designation"
                },
                "value": "Nodal Grievance Redressal Officer"
              },
              {
                "descriptor": {
                  "code": "GRO_ADDRESS",
                  "name": "Gro Address"
                },
                "value": "One Indiabulls centre, Tower 1, 18th Floor Jupiter mill compound 841, Senapati Bapat Marg, Elphinstone Road, Mumbai 400013"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_LINK",
                  "name": "Customer support link"
                },
                "value": "https://buy.iciciprulife.com/buy/GrievanceRedStep.htm?execution=e1s1"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_CONTACT_NUMBER",
                  "name": "Customer support contact number"
                },
                "value": "1800 1080"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_EMAIL",
                  "name": "Customer support email"
                },
                "value": "customer.care@icicibank.com"
              }
            ]
          },
          {
            "descriptor": {
              "code": "LSP_INFO",
              "name": "Lsp Info"
            },
            "list": [
              {
                "descriptor": {
                  "code": "LSP_NAME",
                  "name": "Lsp name"
                },
                "value": "ICICI_LSP"
              },
              {
                "descriptor": {
                  "code": "LSP_EMAIL",
                  "name": "Lsp email"
                },
                "value": "lsp@iciciprulife.com"
              },
              {
                "descriptor": {
                  "code": "LSP_CONTACT_NUMBER",
                  "name": "Lsp contact number"
                },
                "value": "1860 266 7766"
              },
              {
                "descriptor": {
                  "code": "LSP_ADDRESS",
                  "name": "Lsp Address"
                },
                "value": "One Indiabulls centre, Tower 1, 18th Floor Jupiter mill compound 841, Senapati Bapat Marg, Elphinstone Road, Mumbai 400013"
              }
            ]
          }
        ],
        "locations": [
          {
            "id": "L1",
            "gps": "28.574909, 77.194029",
            "descriptor": {
              "name": "Mumbai Central"
            },
            "address": "123 Marine Drive, Mumbai, Maharashtra",
            "area_code": "400001"
          },
          {
            "id": "L2",
            "gps": "28.584909, 77.134029",
            "descriptor": {
              "name": "Mumbai East"
            },
            "address": "162 Dadar, Mumbai, Maharashtra",
            "area_code": "400001"
          },
          {
            "id": "L3",
            "gps": "28.584909, 77.134029",
            "descriptor": {
              "name": "Mumbai West"
            },
            "address": "182 Juhu, Mumbai, Maharashtra",
            "area_code": "400001"
          }
        ]
      },
      "items": [
        {
          "id": "ITEM_ID_Gold_LOAN_2",
          "descriptor": {
            "code": "GOLD_LOAN",
            "name": "Gold Loan"
          },
          "price": {
            "currency": "INR",
            "value": "441800"
          },
          "location_ids": ["L1", "L2", "L3"],
          "tags": [
            {
              "descriptor": {
                "code": "LOAN_INFO",
                "name": "Loan Information"
              },
              "list": [
                {
                  "descriptor": {
                    "code": "INTEREST_RATE",
                    "name": "Interest Rate",
                    "short_desc": "Loans starting from 12% (p.a)"
                  },
                  "value": "12%"
                },
                {
                  "descriptor": {
                    "code": "LTV_RATIO",
                    "name": "LTV Ratio",
                    "short_desc": "Loan to value ration (75%)"
                  },
                  "value": "75%"
                },
                {
                  "descriptor": {
                    "code": "TERM",
                    "name": "Loan Term",
                    "short_desc": "Loans Duration 5 months"
                  },
                  "value": "5 months"
                },
                {
                  "descriptor": {
                    "code": "INTEREST_RATE_TYPE",
                    "name": "Interest rate type",
                    "short_desc": "Fixed Interest type"
                  },
                  "value": "FIXED"
                },
                {
                  "descriptor": {
                    "code": "APPLICATION_FEE",
                    "name": "Application Fees",
                    "short_desc": "Application Fees"
                  },
                  "value": "1000 INR"
                },
                {
                  "descriptor": {
                    "code": "FORECLOSURE_FEE",
                    "name": "Foreclosure Penalty",
                    "short_desc": "Loan Foreclosure Penalty"
                  },
                  "value": "0.5%"
                },
                {
                  "descriptor": {
                    "code": "INTEREST_RATE_CONVERSION_CHARGE",
                    "name": "interest rate conversion charges",
                    "short_desc": "Interest rate conversion charges"
                  },
                  "value": "1000 INR"
                },
                {
                  "descriptor": {
                    "code": "DELAY_PENALTY_FEE",
                    "name": "Delayed payments penalty",
                    "short_desc": "Delayed payments penalty"
                  },
                  "value": "5%"
                },
                {
                  "descriptor": {
                    "code": "OTHER_PENALTY_FEE",
                    "name": "Other Penal Charges",
                    "short_desc": "Other Penal Charges"
                  },
                  "value": "1%"
                },
                {
                  "descriptor": {
                    "code": "ANNUAL_PERCENTAGE_RATE",
                    "name": "Annual Percentage Rate",
                    "short_desc": "Effective annualized interest rate in percentage computed on net disbursed amount using IRR approach and reducing balance method"
                  },
                  "value": "5%"
                },
                {
                  "descriptor": {
                    "code": "REPAYMENT_FREQUENCY",
                    "name": "Repayment Frequency",
                    "short_desc": "Repayment Frequency by borrower"
                  },
                  "value": "MONTHLY"
                },
                {
                  "descriptor": {
                    "code": "NUMBER_OF_INSTALLMENTS_OF_REPAYMENT",
                    "name": "Number of installments of repayment",
                    "short_desc": "Number of installments borrower has to make to payback the loan"
                  },
                  "value": "45"
                },
                {
                  "descriptor": {
                    "code": "TNC_LINK",
                    "name": "Terms & Conditions",
                    "short_desc": "Terms and Conditions"
                  },
                  "value": "https://icicibank.com/loan/tnc.html"
                },
                {
                  "descriptor": {
                    "code": "COOL_OFF_PERIOD",
                    "name": "cool off period",
                    "short_desc": "Cooling off/look-up period during which borrower shall not be\tTAGS m jayega charged any penalty"
                  },
                  "value": "PT30D"
                },
                {
                  "descriptor": {
                    "code": "INSTALLMENT_AMOUNT",
                    "name": "Installment amount",
                    "short_desc": "Each installment amount of repayment"
                  },
                  "value": "46360"
                },
                {
                  "descriptor": {
                    "code": "KFS_LINK",
                    "name": "Key Facts Statement Link",
                    "short_desc": "A link provided by the BPP points to a Key Fact Statement (KFS) document related to a loan. When accessed, the document is returned in text/html format, with the loan details organized in a standard HTML table. This format makes it easy for the buyer's app to read and reformat the information as needed. For more details, refer to the \"KFS_LINK format\" document in the \"feature-ui\" section."
                  },
                  "value": "https://icicibank.com/loan/kfs-terms"
                }
              ]
            }
          ],
          "xinput": {
            "head": {
              "descriptor": {
                "name": "Set Loan Amount"
              },
              "index": {
                "min": 0,
                "cur": 0,
                "max": 1
              },
              "headings": [
                "Set Loan Amount",
                "JOURNEY_OFFLINE"
              ]
            },
            "form": {
              "id": "FO2",
              "mime_type": "text/html",
              "url": "https://https://bpp.credit.becknprotocol.org/loans-details/xinput?formid=FO2",
              "resubmit": false,
              "multiple_sumbissions": false
            },
            "required": true
          }
        }
      ],
      "quote": {
        "id": "LOAN_LEAD_ID_OR_SIMILAR",
        "price": {
          "currency": "INR",
          "value": "442300"
        },
        "breakup": [
          {
            "title": "PRINCIPAL",
            "price": {
              "value": "400000",
              "currency": "INR"
            }
          },
          {
            "title": "INTEREST",
            "price": {
              "value": "40000",
              "currency": "INR"
            }
          },
          {
            "title": "PROCESSING_FEE",
            "price": {
              "value": "1800",
              "currency": "INR"
            }
          },
          {
            "title": "OTHER_UPFRONT_CHARGES",
            "price": {
              "value": "0",
              "currency": "INR"
            }
          },
          {
            "title": "INSURANCE_CHARGES",
            "price": {
              "value": "500",
              "currency": "INR"
            }
          },
          {
            "title": "NET_DISBURSED_AMOUNT",
            "price": {
              "value": "397700",
              "currency": "INR"
            }
          },
          {
            "title": "OTHER_CHARGES",
            "price": {
              "value": "0",
              "currency": "INR"
            }
          }
        ],
        "ttl": "PT15D"
      }
    }
  }
}

And as part of the journey BAP along with submission_id of Set Loan Amount will send selected Branch Location

{
  "context": {
    "domain": "ONDC:FIS12",
    "location": {
      "country": {
        "code": "IND"
      },
      "city": {
        "code": "*"
      }
    },
    "transaction_id": "a9aaecca-10b7-4d19-b640-b047a7c62196",
    "message_id": "bb579fb8-cb82-4824-be12-fcbc405b6608",
    "action": "select",
    "timestamp": "2023-05-25T05:23:03.443Z",
    "version": "2.0.2",
    "bap_uri": "https://bap.credit.becknprotocol.io/",
    "bap_id": "bap.credit.becknprotocol.io",
    "ttl": "PT10M",
    "bpp_id": "bpp.credit.becknprotocol.org",
    "bpp_uri": "https://bpp.credit.becknprotocol.org"
  },
  "message": {
    "order": {
      "provider": {
        "id": "PROVIDER_ID"
      },
      "items": [
        {
          "id": "ITEM_ID_PERSONAL_LOAN_2",
          "location_ids": ["L2"],
          "xinput": {
            "form": {
              "id": "FO2"
            },
            "form_response": {
              "status": "SUCCESS",
              "submission_id": "F02_SUBMISSION_ID"
            }
          }
        }
      ]
    }
  }
}

As a Response to this the lender sends in the updated/reviced offer with agent info inf fulfilment based on selected Branch along with Thank You Page Link.

{
  "context": {
    "domain": "ONDC:FIS12",
    "location": {
      "country": {
        "code": "IND"
      },
      "city": {
        "code": "*"
      }
    },
    "action": "on_select",
    "version": "2.0.2",
    "bap_id": "bap.credit.becknprotocol.io",
    "bap_uri": "https://bap.credit.becknprotocol.io/",
    "bpp_id": "bpp.credit.becknprotocol.org",
    "bpp_uri": "https://bpp.credit.becknprotocol.org",
    "transaction_id": "a9aaecca-10b7-4d19-b640-b047a7c62195",
    "message_id": "c8e3968c-cd78-4e46-aa34-0d541e46bd73",
    "timestamp": "2023-05-25T05:23:03.443Z",
    "ttl": "P30M"
  },
  "message": {
    "order": {
      "provider": {
        "id": "PROVIDER_ID",
        "descriptor": {
          "images": [
            {
              "url": "https://www.icicibank.com/content/dam/icicibank/india/assets/images/header/logo.png",
              "size_type": "sm"
            }
          ],
          "name": "ICICI Bank",
          "short_desc": "ICICI Bank Ltd",
          "long_desc": "ICICI Bank Ltd, India."
        },
        "tags": [
          {
            "descriptor": {
              "code": "CONTACT_INFO",
              "name": "Contact Info"
            },
            "list": [
              {
                "descriptor": {
                  "code": "GRO_NAME",
                  "name": "Gro name"
                },
                "value": "ICICI"
              },
              {
                "descriptor": {
                  "code": "GRO_EMAIL",
                  "name": "Gro email"
                },
                "value": "lifeline@iciciprulife.com"
              },
              {
                "descriptor": {
                  "code": "GRO_CONTACT_NUMBER",
                  "name": "Gro contact number"
                },
                "value": "1860 266 7766"
              },
              {
                "descriptor": {
                  "code": "GRO_DESIGNATION",
                  "name": "Gro Designation"
                },
                "value": "Nodal Grievance Redressal Officer"
              },
              {
                "descriptor": {
                  "code": "GRO_ADDRESS",
                  "name": "Gro Address"
                },
                "value": "One Indiabulls centre, Tower 1, 18th Floor Jupiter mill compound 841, Senapati Bapat Marg, Elphinstone Road, Mumbai 400013"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_LINK",
                  "name": "Customer support link"
                },
                "value": "https://buy.iciciprulife.com/buy/GrievanceRedStep.htm?execution=e1s1"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_CONTACT_NUMBER",
                  "name": "Customer support contact number"
                },
                "value": "1800 1080"
              },
              {
                "descriptor": {
                  "code": "CUSTOMER_SUPPORT_EMAIL",
                  "name": "Customer support email"
                },
                "value": "customer.care@icicibank.com"
              }
            ]
          },
          {
            "descriptor": {
              "code": "LSP_INFO",
              "name": "Lsp Info"
            },
            "list": [
              {
                "descriptor": {
                  "code": "LSP_NAME",
                  "name": "Lsp name"
                },
                "value": "ICICI_LSP"
              },
              {
                "descriptor": {
                  "code": "LSP_EMAIL",
                  "name": "Lsp email"
                },
                "value": "lsp@iciciprulife.com"
              },
              {
                "descriptor": {
                  "code": "LSP_CONTACT_NUMBER",
                  "name": "Lsp contact number"
                },
                "value": "1860 266 7766"
              },
              {
                "descriptor": {
                  "code": "LSP_ADDRESS",
                  "name": "Lsp Address"
                },
                "value": "One Indiabulls centre, Tower 1, 18th Floor Jupiter mill compound 841, Senapati Bapat Marg, Elphinstone Road, Mumbai 400013"
              }
            ]
          }
        ],
        "locations": [
          {
            "id": "L2",
            "gps": "28.584909, 77.134029",
            "descriptor": {
              "name": "Mumbai East"
            },
            "address": "162 Dadar, Mumbai, Maharashtra",
            "area_code": "400001"
          }
        ]
      },
      "items": [
        {
          "id": "ITEM_ID_Gold_LOAN_2",
          "descriptor": {
            "code": "GOLD_LOAN",
            "name": "Gold Loan"
          },
          "price": {
            "currency": "INR",
            "value": "441800"
          },
          "location_ids": ["L2"],
          "tags": [
            {
              "descriptor": {
                "code": "LOAN_INFO",
                "name": "Loan Information"
              },
              "list": [
                {
                  "descriptor": {
                    "code": "INTEREST_RATE",
                    "name": "Interest Rate",
                    "short_desc": "Loans starting from 12% (p.a)"
                  },
                  "value": "12%"
                },
                {
                  "descriptor": {
                    "code": "LTV_RATIO",
                    "name": "LTV Ratio",
                    "short_desc": "Loan to value ration (75%)"
                  },
                  "value": "75%"
                },
                {
                  "descriptor": {
                    "code": "TERM",
                    "name": "Loan Term",
                    "short_desc": "Loans Duration 5 months"
                  },
                  "value": "5 months"
                },
                {
                  "descriptor": {
                    "code": "INTEREST_RATE_TYPE",
                    "name": "Interest rate type",
                    "short_desc": "Fixed Interest type"
                  },
                  "value": "FIXED"
                },
                {
                  "descriptor": {
                    "code": "APPLICATION_FEE",
                    "name": "Application Fees",
                    "short_desc": "Application Fees"
                  },
                  "value": "1000 INR"
                },
                {
                  "descriptor": {
                    "code": "FORECLOSURE_FEE",
                    "name": "Foreclosure Penalty",
                    "short_desc": "Loan Foreclosure Penalty"
                  },
                  "value": "0.5%"
                },
                {
                  "descriptor": {
                    "code": "INTEREST_RATE_CONVERSION_CHARGE",
                    "name": "interest rate conversion charges",
                    "short_desc": "Interest rate conversion charges"
                  },
                  "value": "1000 INR"
                },
                {
                  "descriptor": {
                    "code": "DELAY_PENALTY_FEE",
                    "name": "Delayed payments penalty",
                    "short_desc": "Delayed payments penalty"
                  },
                  "value": "5%"
                },
                {
                  "descriptor": {
                    "code": "OTHER_PENALTY_FEE",
                    "name": "Other Penal Charges",
                    "short_desc": "Other Penal Charges"
                  },
                  "value": "1%"
                },
                {
                  "descriptor": {
                    "code": "ANNUAL_PERCENTAGE_RATE",
                    "name": "Annual Percentage Rate",
                    "short_desc": "Effective annualized interest rate in percentage computed on net disbursed amount using IRR approach and reducing balance method"
                  },
                  "value": "5%"
                },
                {
                  "descriptor": {
                    "code": "REPAYMENT_FREQUENCY",
                    "name": "Repayment Frequency",
                    "short_desc": "Repayment Frequency by borrower"
                  },
                  "value": "MONTHLY"
                },
                {
                  "descriptor": {
                    "code": "NUMBER_OF_INSTALLMENTS_OF_REPAYMENT",
                    "name": "Number of installments of repayment",
                    "short_desc": "Number of installments borrower has to make to payback the loan"
                  },
                  "value": "45"
                },
                {
                  "descriptor": {
                    "code": "TNC_LINK",
                    "name": "Terms & Conditions",
                    "short_desc": "Terms and Conditions"
                  },
                  "value": "https://icicibank.com/loan/tnc.html"
                },
                {
                  "descriptor": {
                    "code": "COOL_OFF_PERIOD",
                    "name": "cool off period",
                    "short_desc": "Cooling off/look-up period during which borrower shall not be\tTAGS m jayega charged any penalty"
                  },
                  "value": "PT30D"
                },
                {
                  "descriptor": {
                    "code": "INSTALLMENT_AMOUNT",
                    "name": "Installment amount",
                    "short_desc": "Each installment amount of repayment"
                  },
                  "value": "46360"
                },
                {
                  "descriptor": {
                    "code": "KFS_LINK",
                    "name": "Key Facts Statement Link",
                    "short_desc": "A link provided by the BPP points to a Key Fact Statement (KFS) document related to a loan. When accessed, the document is returned in text/html format, with the loan details organized in a standard HTML table. This format makes it easy for the buyer's app to read and reformat the information as needed. For more details, refer to the \"KFS_LINK format\" document in the \"feature-ui\" section."
                  },
                  "value": "https://icicibank.com/loan/kfs-terms"
                }
              ]
            }
          ],
          "xinput": {
            "head": {
              "descriptor": {
                "name": "JOURNEY_OFFLINE"
              },
              "index": {
                "min": 0,
                "cur": 1,
                "max": 1
              },
              "headings": [
                "Set Loan Amount",
                "JOURNEY_OFFLINE"
              ]
            },
            "form": {
              "id": "FO3",
              "mime_type": "text/html",
              "url": "https://https://bpp.credit.becknprotocol.org/loans-details/xinput?formid=FO2",
              "resubmit": false,
              "multiple_sumbissions": false
            },
            "required": true
          }
        }
      ],
      "quote": {
        "id": "LOAN_LEAD_ID_OR_SIMILAR",
        "price": {
          "currency": "INR",
          "value": "442300"
        },
        "breakup": [
          {
            "title": "PRINCIPAL",
            "price": {
              "value": "400000",
              "currency": "INR"
            }
          },
          {
            "title": "INTEREST",
            "price": {
              "value": "40000",
              "currency": "INR"
            }
          },
          {
            "title": "PROCESSING_FEE",
            "price": {
              "value": "1800",
              "currency": "INR"
            }
          },
          {
            "title": "OTHER_UPFRONT_CHARGES",
            "price": {
              "value": "0",
              "currency": "INR"
            }
          },
          {
            "title": "INSURANCE_CHARGES",
            "price": {
              "value": "500",
              "currency": "INR"
            }
          },
          {
            "title": "NET_DISBURSED_AMOUNT",
            "price": {
              "value": "397700",
              "currency": "INR"
            }
          },
          {
            "title": "OTHER_CHARGES",
            "price": {
              "value": "0",
              "currency": "INR"
            }
          }
        ],
        "ttl": "PT15D"
      },
      "fulfillments" : [
        {
          "type": "LOAN",
          "agent": {
            "person": {
              "name": "Rajesh Sharma"
            },
            "contact": {
              "number": "+91-99xx99xx99xx"
            }
          }
        }
      ]
    }
  }
}

Would like to also include a optional feature linked with discussion here. Something like having the Checklist in the fulfillment section.

One more is possible change in xinput to support mime-type as "none" and no URL as part of JOURNEY_OFFLINE avoidng redirection

It would be great if the document details can be also added as part of the discussion discription itself

0 replies

Het1919 · 2025-07-28T10:46:13Z

Het1919
Jul 28, 2025
Author

Hi @92shreyansh

We've reviewed the payloads you've shared and have aligned with the provided structure.

Regarding the xInput, we're comfortable with passing the redirectionUrl as is, since we intend to keep it consistent with the new PL protocol.

1 reply

92shreyansh Jul 29, 2025
Maintainer

Works for me

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Gold Loan Protocol Changes #520

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 2 comments 1 reply

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Gold Loan Protocol Changes #520

Uh oh!

Uh oh!

Het1919 Jul 24, 2025

Replies: 2 comments · 1 reply

Uh oh!

Uh oh!

92shreyansh Jul 25, 2025 Maintainer

Uh oh!

Het1919 Jul 28, 2025 Author

Uh oh!

92shreyansh Jul 29, 2025 Maintainer

Het1919
Jul 24, 2025

Replies: 2 comments 1 reply

92shreyansh
Jul 25, 2025
Maintainer

Het1919
Jul 28, 2025
Author

92shreyansh Jul 29, 2025
Maintainer