Skip to main content

Payment notice and acknowledgement

The payer's notice that money has moved against an approved claim, and the provider's acknowledgement. The only exchange that carries actual money rather than an adjudicated figure.

The notice

Sent on /v1/paymentnotice/request, workflow 30 initiated, 31 processed, 33 settled.

The bundle

#ResourceProfile
1Tasknone declared; NRCeS Task
2PaymentNoticenone declared; NRCeS PaymentNotice
3PaymentReconciliationnone declared; NRCeS PaymentReconciliation
4Organization (prov)none declared; NRCeS Organization
5Organization (pay)none declared; NRCeS Organization

Elements

1. Task

NRCeS profile: Task.

ElementExample
statusrequested
intentorder
code.coding[]deliver deliver in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-codes
descriptionSettled in full: INR 135000 paid against INR 150000 approved.
authoredOn2026-09-10T23:53:39+05:30
requesterreference <participant-defined>
ownerreference <participant-defined>
input[].type.coding[]status Status code in http://terminology.hl7.org/CodeSystem/financialtaskinputtype
input[].valueReferencereference <participant-defined>

2. PaymentNotice

NRCeS profile: PaymentNotice.

ElementExample
identifier[]system <participant-defined>, value NM-26-0SE00002L
identifier[].type.coding[]CLN Claim number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
statusactive
created2026-09-10T23:53:39+05:30
paymentreference <participant-defined>
recipientreference <participant-defined>
amountvalue 135000, currency INR
paymentStatus.coding[]cleared Cleared in http://terminology.hl7.org/CodeSystem/paymentstatus

3. PaymentReconciliation

NRCeS profile: PaymentReconciliation.

ElementExample
identifier[]system <participant-defined>, value NM-26-0SE00002L
identifier[].type.coding[]CLN Claim number in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
statusactive
created2026-09-10T23:53:39+05:30
dispositionSettled in full: INR 135000 paid against INR 150000 approved.
paymentDate2026-09-10
paymentAmountvalue 135000, currency INR
paymentIdentifiersystem <participant-defined>, value UTR1789064619092
paymentIdentifier.type.coding[]UTR Unique Transaction Reference in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-identifier-type-code
detail[]id PAY-2026-0009/TDS, date 2026-09-10
id PAY-2026-0009/Payment, date 2026-09-10
detail[].identifiersystem <participant-defined>, value PAY-2026-0009/TDS
system <participant-defined>, value PAY-2026-0009/Payment
detail[].identifier.type.coding[]PLAC Placer Identifier in https://https://nrces.in/ndhm/fhir/r4/ValueSet-ndhm-identifier-type-code.html
detail[].type.coding[]TDS TDS in http://hl7.org/fhir/ValueSet/payment-type
Payment Payment in http://hl7.org/fhir/ValueSet/payment-type
detail[].amountvalue 15000
value 135000

The Organization entries are shaped as in the chapters that introduce them.

The acknowledgement

Sent on /v1/paymentnotice/on_request, workflow 30 echoed; 17 under PMJAY.

The bundle

#ResourceProfile
1TaskTask
2Organization (prov)Organization
3Organization (pay)Organization

Elements

1. Task

NRCeS profile: Task.

ElementExample
statuscompleted
intentorder
code.coding[]status in http://terminology.hl7.org/CodeSystem/financialtaskcode
authoredOn2026-09-10T23:53:40+05:30
requesterreference https://nhcx.abdm.gov.in/provider
ownerreference https://nhcx.abdm.gov.in/payer
descriptionReceived the payment for claim NM-26-0SE00002L
output[].type.coding[]status Status in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-output-type
claimNumber ClaimNumber in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-input-type-code
output[].valueCodeableConcept.coding[]paymentack Payment is acknowledged in https://nrces.in/ndhm/fhir/r4/CodeSystem/ndhm-task-output-value
output[]valueString NM-26-0SE00002L

The Organization entries are shaped as in the chapters that introduce them.

Rules

1. The notice

A Task coded deliver in ndhm-task-codes whose input references the PaymentNotice. PaymentNotice.amount is the net that reaches the account. PaymentReconciliation carries the payment date, the UTR and one detail[] line per money type.

2. The arithmetic

Net plus the deductions equals the adjudicated benefit, not the submitted amount. Run the check on every notice and flag a case that fails it.

3. The acknowledgement

A Task coded status in financialtaskcode, completed, with an output paymentack and the claim number as a second output. It confirms receipt, not agreement.

4. Three notices

30, 31 and 33, each with its own correlation id. The bank reference arrives on 33. Keep the path for the acknowledgement configurable per payer.

PMJAY

The generic bundle above is what every payer takes, IRDAI-regulated insurers and TPAs included. PMJAY takes it with the changes and requirements below.

What changes in the bundle

The notice

Systems PMJAY binds differently
ElementGenericPMJAY
PaymentNotice.identifier[]<participant-defined>https://hcx.pmjay.gov.in/v1/preauthorization
PaymentReconciliation.identifier[]<participant-defined>https://hcx.pmjay.gov.in/v1/preauthorization
PaymentReconciliation.paymentIdentifier<participant-defined>https://payer.gov.in
PaymentReconciliation.detail[].identifier<participant-defined>https://hcx.pmjay.gov.in/v1/claim

The acknowledgement

The PMJAY bundle has the same resources, elements and systems as the generic one.

What PMJAY specifies

  • Deduction lines use the scheme's own codes, such as RF, beside the Payment line.
  • The notice names the claim under https://hcx.pmjay.gov.in/v1/preauthorization.
  • Before 33 the UTR field can carry a scheme reference rather than a bank reference. Store it; reconcile against the bank only on 33.

What PMJAY requires

  • Acknowledge each notice on 17.
  • Keep the UTR from 33; the shortfall window opens only once 33 is acknowledged.

Use cases, APIs and data elements

C9 Send payment notice (payer)

The money, on a new thread of its own, with the reconciliation itemised by type: approved, claimed, tds, servicetax, advance, recovered, penality. The bank's UTR rides on the settled notice.

API/v1/paymentnotice/request apis/06-payment-notice/v1-paymentnotice-request.bru
Callback/v1/paymentnotice/on_request apis/06-payment-notice/v1-paymentnotice-on-request.bru
Workflow30 initiated, 31 processed, 33 settled
Carries JWEyes
Focal resourcePaymentReconciliation

Request headers

HeaderExample value
x-hcx-sender_code1518@hcx
x-hcx-recipient_code1000004446@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id30
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusrequest.initiated
x-hcx-ben-abha-id91711234567890

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
30Payment Initiatedpayerrequest.initiated, response.partial, response.errorPayment initiated by payer, on a new thread
31Payment Processedpayerrequest.initiatedPayment has been processed
33Payment Settledpayerrequest.initiatedPayment has been fully settled

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
utrNumberBank UTR NumberPaymentstring1..1PaymentReconciliation.paymentIdentifier.valueCMS2602260081728
paymentDateRemittance DatePaymentdate1..1PaymentReconciliation.paymentDate2026-03-05
settledAmountNet Bank Remittance AmountPaymentdecimal1..1PaymentReconciliation.paymentAmount.value14850.00
tdsDeductionTax Deducted at Source (TDS)Payment Detaildecimal0..1PaymentReconciliation.detail[type=tds].amount.value650.00

NRCeS profiles: PaymentReconciliation.

B7 Acknowledge payment notice (provider)

The receipt for a payment notice, as a Task on this endpoint. The notice arrives on a new thread of its own; a generic payer takes the acknowledgement with the notice's 30 echoed, PMJAY with 17.

API/v1/paymentnotice/on_request apis/06-payment-notice/v1-paymentnotice-on-request.bru
Callback/v1/paymentnotice/request apis/06-payment-notice/v1-paymentnotice-request.bru
Workflow30 echoed from the notice on the generic network; 17 under PMJAY
Carries JWEyes
Focal resourcePaymentReconciliation / Task

Request headers

HeaderExample value
x-hcx-sender_code1000004446@hcx
x-hcx-recipient_code1518@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id17
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusresponse.complete
x-hcx-ben-abha-id91711234567890
x-hcx-debug_flagINFO

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
30Payment Initiatedpayerrequest.initiated, response.partial, response.errorPayment initiated by payer, on a new thread
17Payment Receivedproviderresponse.completePayment received acknowledgment under PMJAY; a generic payer takes it with the notice's 30 echoed

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
settlementNumberPayment ReferenceSettlementstring1..1PaymentReconciliation.identifier[0].valueSETTLE-2026-001
statusAcknowledgment StatusSettlementcode1..1PaymentReconciliation.statusactive

NRCeS profiles: PaymentReconciliation.

D13 Acknowledge the payment notice (pmjay)

Three notices may arrive: 30 when the transfer is initiated, 31 when the bank processes it, 33 when it settles with the UTR. The reconciliation splits the amount into what was paid and what was deducted as tax. Keep the UTR; it is the reference for any dispute.

API/v1/paymentnotice/on_request apis/06-payment-notice/v1-paymentnotice-on-request.bru
Callback/v1/paymentnotice/request apis/06-payment-notice/v1-paymentnotice-request.bru
Workflow17
Carries JWEyes
Focal resourcePaymentReconciliation / Task
Simulator console/builder?family=paymentnotice&usecase=acknowledge

Request headers

HeaderExample value
x-hcx-sender_code1000004446@hcx
x-hcx-recipient_code1518@hcx
x-hcx-api_call_id{{$guid}}
x-hcx-request_id{{$guid}}
x-hcx-correlation_id{{$guid}}
x-hcx-workflow_id17
x-hcx-timestamp{{$isoTimestamp}}
x-hcx-statusresponse.complete
x-hcx-ben-abha-id91711234567890
x-hcx-debug_flagINFO

Workflow codes

CodeNameAuthored byx-hcx-statusMeans
17Payment Receivedproviderresponse.completePayment received acknowledgment under PMJAY; a generic payer takes it with the notice's 30 echoed

Data elements

ElementLabelGroupTypeCard.FHIR pathExampleNotes
settlementNumberSettlement Advice NumberPaymentstring1..1PaymentReconciliation.identifier[0].valueSETTLE-PMJAY-001
workflowIdWorkflow CodeHeaderstring1..1Header.x-hcx-workflow_id17

NRCeS profiles: PaymentReconciliation.