Read Gold Loan Offer And Hand-Off URL | Credit Platform | Documentation

curl -G https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted \
     -H "x-correlation-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
     -H "Authorization: Bearer <token>" \
     -d journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "data": {
    "hosted_url": "https://credit.aarthiklabs.com/lab/handoff?handoff=xxXxxX0x0x...#bt_test_xxx000",
    "expires_at": "2026-05-14T09:16:30.000Z",
    "target_offer_id": "offer_gl_001",
    "target_branch_id": "branch_001",
    "target_journey_id": "journey_gl_001",
    "journey": {
      "id": "journey_gl_001",
      "type": "GOLD_LOAN",
      "status": "OFFERED",
      "lender": {
        "id": "lender_001",
        "lender_name": "Gold Lender",
        "lender_gro_name": "Support Lead",
        "lender_gro_email": "gro@example.com",
        "lender_customer_support_contact_number": "1800123456"
      },
      "offer": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "accepted": false,
        "expired": false,
        "amountPrincipal": "400000",
        "amountTotalInterestPayable": "42300",
        "amountNetDisbursedAmount": "392000",
        "offerTerm": "5 months",
        "interestRate": "12.00",
        "interestType": "FIXED",
        "annualPercentageRate": "5.00",
        "numberOfInstallments": 5,
        "coolOffPeriod": "3 days",
        "termsAndConditionsLink": "https://example.com/tnc.pdf",
        "keyFactsStatementLink": "https://example.com/kfs.pdf",
        "applicationFees": "0",
        "foreclosureFees": "0",
        "interestRateConversionCharges": "0",
        "delayPenaltyFees": "0",
        "otherPenaltyFees": "0",
        "processingFees": "8000",
        "otherUpfrontCharges": "0",
        "insuranceCharges": "0",
        "otherCharges": "0",
        "installments": [
          {
            "serialNumber": 1,
            "type": "INSTALLMENT",
            "amount": "12000.00",
            "status": "PAID | OVERDUE | NOT-DUE",
            "dueDate": "2024-08-01"
          },
          {
            "serialNumber": 2,
            "type": "INSTALLMENT",
            "amount": "12000.00",
            "status": "PAID | OVERDUE | NOT-DUE",
            "dueDate": "2024-08-01"
          },
          {
            "serialNumber": 3,
            "type": "INSTALLMENT",
            "amount": "12000.00",
            "status": "PAID | OVERDUE | NOT-DUE",
            "dueDate": "2024-08-01"
          }
        ],
        "relationshipManager": {
          "name": "Rajesh Sharma",
          "phone": "+91-9876543210"
        }
      }
    }
  },
  "error": null
}

Backend-only API-key call. Use after the borrower selects a Gold Loan offer and branch in your UI. Pass the Start response data.journey.id as journeyID so the Hosted handoff continues the intended application attempt. The branch ID must come from data.lenders.<lenderName>.branches[].id in Read Gold Loan Offers. The response returns a short-lived hosted_url plus lender details, offer details, and the lender relationship manager contact details received as fulfillment-agent details in the second on_select response. Hosted owns tracking, resume, status, and post-disbursal steps after this handoff. If journeyID is omitted, borrower-only fallback is legacy behavior and may return a 409 ambiguity error when the same borrower has multiple active Hybrid application attempts.

Backend-only API-key call. Use after the borrower selects a Gold Loan offer and branch in your UI. Pass the Start response `data.journey.id` as `journeyID` so the Hosted handoff continues the intended application attempt. The branch ID must come from `data.lenders.<lenderName>.branches[].id` in Read Gold Loan Offers. The response returns a short-lived hosted_url plus lender details, offer details, and the lender relationship manager contact details received as fulfillment-agent details in the second on_select response. Hosted owns tracking, resume, status, and post-disbursal steps after this handoff. If `journeyID` is omitted, borrower-only fallback is legacy behavior and may return a 409 ambiguity error when the same borrower has multiple active Hybrid application attempts.

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 the borrower and borrowerProviderID across sessions and application attempts to preserve resume, history, and post-disbursal continuity.

offerIDstringRequired>=1 character

Offer identifier returned in data.lenders.<lenderName>.offers[].offerID.

branchIDstringRequired>=1 character

Branch identifier returned in data.lenders.<lenderName>.branches[].id by Read Gold Loan Offers.

Query parameters

journeyIDstringOptional>=1 character

Journey ID returned as data.journey.id by Start. Send this on Offers and Hosted handoff calls to continue the intended application attempt. The journey_id query parameter is also accepted.

Response

Hosted URL and Gold Loan offer detail issued for the selected offer.

request_idstring

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors