What does this API do?
The CGTMSE Outstanding API allows Member Lending Institutions (MLIs) to update the outstanding loan amount for a guaranteed account in the CGTMSE system.
This API is used during the lifecycle of a loan to:
- Report the current outstanding balance against a CGPAN (CGTMSE Guarantee Number).
- Keep CGTMSE records updated with the latest loan exposure.
- Support processes such as claim settlement, monitoring, and reconciliation.
Regular updates through this API ensure that the guarantee coverage reflects the actual outstanding loan amount.
Who can use it?
Any onboarded Member Lending Institution (MLI) that has subscribed to the CGTMSE service on the ULI Platform Developer Portal.
Eligible institution types include:
- Scheduled Commercial Banks
- Small Finance Banks
- Regional Rural Banks (RRBs)
- NBFCs
- Other financial institutions registered with CGTMSE
Prerequisites
Complete all common platform prerequisites as described in Getting Started with ULI Platform APIs. Additionally, ensure:
- CGTMSE Service Subscription
Enabled separately for Sandbox and Production. - JWT Token Generation
Required for Authorization header. - CGTMSE Sign-in Token
Must be generated using the Sign-in API and passed inx-cgtmse-token. - Valid CGPAN
Required to identify the guarantee account. - Whitelisting Requirements
- IP whitelisting
- URL whitelisting
API Endpoints
| Environment | URL |
|---|---|
| Sandbox (Non-Prod) | https://extgw.nonprod.rbihub.io/cgtmse/outstandingupdate/1.3/en |
| Production | https://extgw.api.rbihub.io/cgtmse/outstandingupdate/1.3/en |
- HTTP Method: POST
- URL Path Convention:
/{service name}/{ver}/{lang}- Service name:
cgtmse/outstandingupdate - Version:
1.3 - Language:
en
- Service name:
Headers
| Header | Description | Example |
|---|---|---|
| Authorization | Bearer JWT token generated by platform authentication service | Bearer <JWT token> |
| client-id | Base64-encoded Client ID issued during registration | pNRxiviTvgBrf7qMANqBVskDYfEa |
| provider | Service provider code for CGTMSE | 112 |
| x-cgtmse-token | Token obtained from CGTMSE Sign-in API | <authToken> |
| api-key | Reserved for future use | 24-char alphanumeric key |
Request Body
The request follows the standard encrypted platform envelope.
Plain Payload (before encryption)
The plain payload contains outstanding loan details, including:
- CGPAN (mandatory)
- Outstanding amount
- Reporting date
- Other loan-related fields as per CGTMSE specification
Encrypted Request Format
{ "meta": { "ver": "1.3", "ts": "<ISO-8601 timestamp>", "txncode": "<unique transaction code>" }, "hmac": "<SHA-256 hash of encrypted data>", "data": "<encrypted payload>" }
Field Description
| Field | Description |
|---|---|
| meta.ver | Version of request template (1.3) |
| meta.ts | Timestamp in ISO-8601 format |
| meta.txncode | Unique transaction code |
| hmac | SHA-256 hash of data |
| data | Encrypted payload containing outstanding details |
Response Fields
Sample Response Structure
{ "result": { "errcode": "E000", "status": "success", "info": "" }, "data": { "response": "<encrypted response>" }, "signature": "<digital signature>", "meta": { "txncode": "<txncode>", "ver": "1.3", "ts": "<timestamp>" }, "hmac": "<hash>", "publickey": "<public key>", "sig-algo": "SHA256withECDSA" }
Field Description
| Field | Description |
|---|---|
| result.errcode | Error code (E000 = success) |
| result.status | success / fail |
| data | Encrypted response payload |
| signature | Digital signature of response |
| hmac | SHA-256 hash of data |
| publickey | Platform public key |
| sig-algo | Signing algorithm |
| meta.txncode | Echoed transaction code |
| meta.ver | Response version |
| meta.ts | Response timestamp |
Decrypted Response (Business Data)
After decrypting the response:
- Confirms whether the outstanding update was successful
- May include acknowledgment or updated outstanding details
- Additional response fields as per CGTMSE specification
Error Codes
| Error Code | Description |
|---|---|
| E000 | Success — no error |
| E801 | Authentication failure at CGTMSE |
| E802 | Missing x-cgtmse-token |
| E043 | Provider internal error |
For platform-level errors, refer to the Platform Error Code documentation.
Who to contact?
If you encounter any issues, contact support with the following details:
- Email: support@rbihub.in
- Subject: CGTMSE API Error
- Details to include:
- Platform Service Name: CGTMSE
- Environment: Sandbox / Production
- Service Provider Code: 112
- Request payload (headers + body)
- Error code and message
- Logs or screenshots
- Prerequisites status:
- IP Whitelisting
- URL Whitelisting
- Service Subscription
- Token Generation
- CGTMSE Sign-in Token
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article