Dummy Payer
Use the NHCX dummy payer to test provider flows in the sandbox.
The NHCX dummy payer is a sandbox payer for provider tests.
Use participant ID 1000003538@hcx as the dummy payer.
Use it to test each supported use case before payer tests.
Dummy payer values
For the dummy payer, set provider ID 32722 in the FHIR bundle.
Set policy number 100217 for the dummy payer test policy.
Supported use cases
| Use case | Provider action | Dummy payer action |
|---|---|---|
| Insurance plan | Submit an insurance plan request. | Return plan data for the test policy. |
| Coverage eligibility | Submit a coverage eligibility check. | Return eligibility data. |
| Preauthorization | Submit a preauthorization request. | Trigger approve, reject, or query. |
| Claim | Submit a claim request. | Trigger approve, reject, or query. |
| Payment notice | Receive a payment notice. | Start a payment notice prompt. |
| Communication | Respond to a query. | Start a communication request. |
Insurance plan
Prepare the bundle
Set provider ID 32722 in the FHIR bundle.
Set policy number 100217.
Submit the request
Call v1/insuranceplan/request with the required payload and headers.
Read the response
Process the dummy payer response through your provider callback.
Coverage eligibility
Prepare the request
Use the required payload and protected headers.
Submit the check
Call v1/coverageeligibility/check.
Store the correlation ID
Use the correlation ID for all callback events in this request cycle.
Preauthorization
Submit the request
Call v1/preauth/submit with the required payload and headers.
Trigger a payer action
Call /process/request with Approve, Reject, or Query.
Handle a query
For Query, receive the payer communication request.
Send documents
Call v1/communication/on_request with the required documents.
Receive the final response
Receive the final response on v1/preauth/on_submit.
Claim
Submit the request
Call v1/claim/submit with the required payload and headers.
Trigger a payer action
Call /process/request with Approve, Reject, or Query.
Handle a query
For Query, receive the payer communication request.
Send documents
Call v1/communication/on_request with the required documents.
Receive the final response
Receive the final response on v1/claim/on_submit.
Payment notice
Start the prompt
Call /paymentNotice/init to start the payment notice prompt.
Send an acknowledgment
Send the payment notice acknowledgment from the provider system.
Communication
Submit a parent request
Call v1/preauth/submit with the required payload and headers.
Trigger a query
Call /process/request with Query as the action.
Receive the communication request
Receive the dummy payer request on v1/communication/request.
Send the response
Call v1/communication/on_request with the required documents.
Receive adjudication
Receive the final response on v1/preauth/on_submit or v1/claim/on_submit.
Test action API
Use this API to trigger the dummy payer action for a preauthorization or claim cycle.
curl --location --request POST 'https://apisbx.abdm.gov.in/pmjay/sbxhcx/dummyhcxpayer/process/request' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'bearer_auth: ******' \
--data-raw '{
"action": "Approve",
"method": "Claim",
"correlationId": "aed629f7-XXXX-XXXX-XXXX-2f225169e68c"
}'| Field | Allowed value |
|---|---|
action | Approve, Reject, or Query. |
method | Preauth or Claim. |
correlationId | The correlation ID for the request cycle. |
Payment notice trigger API
Use this API to trigger a payment notice from the dummy payer.
curl --location --request POST 'https://apisbx.abdm.gov.in/pmjay/sbxhcx/dummyhcxpayer/paymentNotice/init' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'bearer_auth: ******' \
--data-raw '{
"providerId": "XXXXXXX@hcx",
"claimNumber": ""
}'Sources
- dummy-payer-implementation.md (NHCX sandbox portal)