Skip to navigation
RebateRight APIMedicare ClaimingBulk Bill Claim

Bulk Bill Payment Report

Has Medicare paid this bulk bill claim, and how much?

That is the question this endpoint answers: the deposit, the account it went to, and the claims covered by the same payment run.

Retrieve the payment report for a bulk bill claim.

📑 Response — status

ValueMeaning
COMPLETEPayment information is available (paymentRun, paymentInfo, claimSummary).
REPORT_NOT_AVAILABLEThe claim is finalised with nothing to pay, such as a nil or rejected benefit, so it has no payment report.
REPORT_NOT_READYThe claim is not yet finalised and paid. Retry later.
REPORT_NOT_FOUNDNo claim from this Minor ID matches this correlationId, or the payee provider differs from the claim’s.
REPORT_EXPIREDThe claim was lodged more than 6 months ago, outside the retrieval window.

When a payment run exists, the response includes the payment run reference, the masked bank account details, the deposit amount and a claim summary of every claim in that run.

For 6 months from the date the claim was lodged, you can retrieve its report as many times as you need. Only the Minor ID that submitted the claim may request its report.

A malformed request, such as one with an invalid correlationId, receives a 400. See the 400 response examples.

Authentication

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

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. See Keys, Minor ID and environments.

Request

This endpoint expects an object.
correlationIdstringRequired

The original claim’s correlationId, exactly as sent on the claim or as returned on its response. It is urn:uuid:, then the Minor ID you send in x-minor-id, then 16 letters or digits (33 characters in total), for example urn:uuid:MDE0000049cd82a2acce47f2.

See Correlation ID for the rules on reusing it.

payeeProviderobjectRequired

The provider the benefit was paid to. Send the claim’s payeeProvider. If the claim had no payeeProvider, send its servicing provider. A number that does not match the claim returns REPORT_NOT_FOUND.

Response

OK
statusenum
Outcome of the report request. The status table at the top of this page explains each value.
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. The masked bank account details and the deposit amount, in cents, as a string.

claimSummarylist of objectsOptional

Present when status is COMPLETE. One row for each claim in the payment run, including claims other than the one you asked about.

Errors

400
Bad Request Error