API ReferenceDVA

DVA Payment Report

Beta
View as Markdown
> 🚧 **Coming Soon** — This endpoint is not yet available. > RebateRight is completing DVA certification. Availability will be announced when certification is complete. Retrieve a **payment report** for a **DVA medical claim** submitted through **Medicare**, from the same Minor ID that submitted the claim. ## 📑 Response — `status` | Value | Meaning | |---|---| | `COMPLETE` | Payment information is available (`paymentRun`, `paymentInfo`, `claimSummary`). | | `REPORT_NOT_AVAILABLE` | Claim is finalised but there is **no payment report** (for example, nil or rejected benefit — nothing to pay). | | `REPORT_NOT_READY` | Claim not yet paid and finalised — retry later. | | `REPORT_NOT_FOUND` | No matching claim for this location and identifiers. | | `REPORT_EXPIRED` | Outside 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
API Key authentication via header

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.

paymentRunobject

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

paymentInfoobject

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

claimSummarylist of objects

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