Skip to navigation
RebateRight APIDVA

DVA Payment Report

View as Markdown
Has DVA paid this claim, and how much?

That is the question this endpoint answers, for a DVA claim submitted through Medicare from the same Minor ID.

Retrieve a payment report for a DVA medical claim submitted through Medicare, from the same Minor ID that submitted the claim.

📑 Response — status

ValueMeaning
COMPLETEPayment information is available (paymentRun, paymentInfo, claimSummary).
REPORT_NOT_AVAILABLEClaim is finalised but there is no payment report (for example, nil or rejected benefit — nothing to pay).
REPORT_NOT_READYClaim not yet paid and finalised — retry later.
REPORT_NOT_FOUNDNo matching claim for this location and identifiers.
REPORT_EXPIREDOutside the six-month window.

When a payment run exists, the response includes the payment run reference, bank / EFT mask details, deposit amount, and a claim summary listing claims included in that run (not only the claim you asked about).

Reports can be retrieved for six months from the original claim lodgement date, as often as needed. Only the transmitting location may request the report.

Malformed requests (for example an invalid correlationId) receive HTTP 400 — see the 400 response examples.

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring

Your Minor ID is three uppercase letters followed by five digits, such as MDE00001. Send the Minor ID exactly as issued. A malformed value gets a 400 with “The Minor ID is not valid.” on every endpoint.

Request

This endpoint expects an object.
correlationIdstringRequired

Transaction identifier from the successful DVA medical claim response; must match exactly what was returned when the claim was accepted. Format is urn:uuid: + Minor ID (8 characters) + 16 hexadecimal characters (33 characters total), for example urn:uuid:MDE0000015181774ceb04e27.

payeeProviderobjectRequired

Payee provider from the original claim transmission; use the same values as on that claim.

Response

OK
statusenum

Outcome of the report request. When status is COMPLETE, monetary fields on related objects are in cents as string numerics and account numbers are typically masked.

ValueMeaning
COMPLETEReport returned with payment-run data
REPORT_NOT_AVAILABLEReport not available
REPORT_NOT_READYReport not ready yet — retry later
REPORT_NOT_FOUNDReport not found
REPORT_EXPIREDReport has expired
Allowed values:
correlationIdstring

Echo of the correlationId sent on the request.

paymentRunobjectOptional

Present when status is COMPLETE. Identifies the payment run that included this claim.

paymentInfoobjectOptional

Present when status is COMPLETE. Masked bank / EFT details and deposit amount; amounts are in cents as decimal strings.

claimSummarylist of objectsOptional

Present when status is COMPLETE. One row per claim line included in the payment run (not only the claim you queried).

Errors

400
Bad Request Error