Skip to navigation
RebateRight APIMedicare ClaimingIN Patient Claims

Remittance Advice

Beta

Which in-patient claims does this payment cover?

That is the question this endpoint answers, with the amount deposited, the reference on the bank statement and the benefit for each claim.

Test environment only. Services Australia is certifying this service, and it reaches production once certified.

A remittance advice records one payment for in-patient claims. Services Australia calls it the ECLIPSE Remittance Advice.

These examples were captured before the test environment had generated any remittance advice, so none shows a successful response. The report fields come from Services Australia’s specification, and are not yet confirmed against a live response.

Reconcile payments gives the steps to find and retrieve one, which claim types get one, and what Services Australia requires your software to store.

When one is ready

In the test environment, a claim that completes Monday to Thursday gets its remittance advice the next day. A claim that completes Friday to Sunday normally gets it the following Tuesday. For production, Services Australia states only that a remittance advice follows the claim’s completion. Check the status once a day until it is READY.

Retrieval status

Each ID gets its own entry in content, with one of these values in status:

ValueMeaning
SUCCESSThe remittance advice is in report.
REPORT_NOT_READYThe remittance advice is still being prepared. Check its status again later.
REPORT_NOT_FOUNDNothing from this Minor ID has this ID, or the claim was lodged more than 6 months ago.
INVALID_CONTENT_TYPEThe ID belongs to another kind of record, such as a claim’s own transaction ID.

A malformed request, such as one with an ID that is not 24 characters, 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. Send the Minor ID that lodged the claims. See Keys, Minor ID and environments.

Request

This endpoint expects an object.
transactionIdlist of stringsRequired

The remittance advice IDs to retrieve, up to 1,000, each sent once. Send an array, even for one ID.

Take each ID from a READY or REPORTED row of a Status Report remittance advice lookup. It is 24 letters or digits, and need not start with your Minor ID.

Response

OK
contentlist of objects
One entry for each ID you sent, in the same order.
correlationIdstring
The ID RebateRight generated for this request. Quote it in a support enquiry. It is not a remittance advice ID.

Errors

400
Bad Request Error