Skip to main content

Claim

The claim is where money actually moves.

APIs​

CallCalled byMethod and pathWhat it does
Provider: submit a claimProviderPOST /v1/claim/submitProvider submits the final itemised Claim bundle (Claim.use claim), or a claim query response or resubmission; NHCX routes it to the payer.
Payer: send the claim responsePayerPOST /v1/claim/on_submitPayer returns interim (response.partial) and final (response.complete) ClaimResponseBundles for a claim to the provider via NHCX.

One path, two meanings by scheme​

Nothing in the envelope names the scheme, so the payer you address decides what /v1/claim/submit carries.

PayerWhat travels on /v1/claim/submitWorkflow
General networkA provisional discharge submission first, then the final claim14, then 15
PMJAYOne combined discharge and claim submission. No separate discharge step exists15

Discharge and claim and PMJAY scheme rules carry the detail.

Callbacks you host​

The exchange posts these to the endpoint_url you registered. Answer each with HTTP 202 first.

PathHosted by
/v1/claim/submitThe payer
/v1/claim/on_submitThe provider

Base URLs​

EnvironmentBase URL
Sandbox, NHCX exchange.https://apisbx.abdm.gov.in/hcx
Production.https://apisprod.nha.gov.in/hcx

Guides that use these calls​

The whole specification, with a request you can send from the page, is the Claim API reference.