Skip to main content

Claim

The claim is where money actually moves.

Calls

CallMethod and pathWhat it does
Claim submitPOST /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.
Claim callbackPOST /v1/claim/on_submitPayer returns interim (response.partial) and final (response.complete) ClaimResponseBundles for a claim to the provider via NHCX.
Claim submit (internal) (adapter)POST /internal/v1/claim/submitInternal twin of /v1/claim/submit (operationId claimSubmitPostInternal) with the same JWEPayload body and response set.
Claim callback (internal) (adapter)POST /internal/v1/claim/on_submitInternal twin of /v1/claim/on_submit (operationId claimOnSubmitPostInternal) taking the same bare object body.

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.