API ReferenceMedicare ClaimingBulk Bill Claim

Bulk Bill Payment Report

View as Markdown
Retrieve a payment report for a Bulk Bill claim, providing payment information including the deposit amount, masked bank account details, and the list of claims covered by the same payment run. ## 📑 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, provider, and identifiers. | | `REPORT_EXPIRED` | Lodgement is outside the six-month retrieval window. | When a payment run exists, the response includes the **payment run** reference, **masked bank / EFT** details, **deposit amount**, and a **claim summary** listing every claim included in that run (not only the claim you queried). Reports can be retrieved for **six months** from the date the original claim was lodged, as many times as needed. Only the location that submitted the claim may request its 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 Bulk Bill 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:MDE00000a081f297cf7741ad.

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_AVAILABLEClaim finalised but no payment to make
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 the deposit amount; monetary values are in cents as decimal strings.

claimSummarylist of objects

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

Errors

400
Bad Request Error