Read (Poll) Offers | Credit Platform | Documentation

curl https://credit.aarthiklabs.com/api/v1/hybrid/personal-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers \
     -H "x-correlation-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
     -H "Authorization: Bearer <token>"

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "data": {
    "status": "OFFERED",
    "lenders": {
      "AA Bank": {
        "minimumLoanAmount": "50000.00",
        "maximumLoanAmount": "5000000.00",
        "offers": [
          {
            "consentHandleAvailable": true,
            "annualPercentageRate": null,
            "installmentAmount": null,
            "ltvRatio": null,
            "status": "OFFER_AWAITED",
            "offerID": null,
            "amountPrincipal": null,
            "interestRate": null,
            "offerTerm": null,
            "ondcTransactionID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          }
        ],
        "accountAggregatorURL": "https://credit.aarthiklabs.com/lab/account-aggregator?token=xxXxxX0x0x..."
      },
      "ONDC Bank": {
        "minimumLoanAmount": "50000.00",
        "maximumLoanAmount": "5000000.00",
        "offers": [
          {
            "consentHandleAvailable": false,
            "annualPercentageRate": "5.00",
            "installmentAmount": "88460.00",
            "ltvRatio": null,
            "status": "OFFER_RECEIVED",
            "offerID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "amountPrincipal": "400000",
            "interestRate": "12.00",
            "offerTerm": "5 months",
            "ondcTransactionID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          }
        ]
      }
    },
    "account_aggregator": {
      "available": true,
      "status": "READY",
      "lenders": [
        "AA Bank"
      ],
      "poll_after_ms": 3000,
      "url": "https://credit.aarthiklabs.com/lab/account-aggregator?token=xxXxxX0x0x...",
      "expires_at": "1970-01-01T00:15:00.000Z"
    }
  },
  "error": null
}

Read-only API-key call. Poll this endpoint until data.status reaches OFFERED with at least one selectable OFFER_RECEIVED offer, NOT_OFFERED, or an actionable data.account_aggregator.status = READY URL.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Path parameters

borrowerProviderIDstringRequired1-128 characters

Stable borrower identity from the partner system. Keep a 1:1 mapping between mobile number and borrowerProviderID to preserve resume and post-disbursal continuity.

Response

Current Hybrid offer state.

request_idstring

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors