Bulk Bill Payment Report

View as Markdown
Bulk Bill Payment Report Web Service (BPYW) is used to retrieve a payment report, providing payment information relating to Bulk Bill claims including the payment deposited, the bank account details the deposit was made to, and the list of claims covered by the payment run. This report is available for six months after its initial generation (date of lodgement for claim) and can be retrieved in real time as many times as required. The report can only be requested by the same transmitting location that submitted the claim. ## 📑 Request Fields #### 🔸correlationId The correlationId from the original Bulk Bill claim. --- #### 🔸payeeProvider.providerNumber Details of the health professional to whom the Medicare benefit is to be paid, as submitted in the original claim transmission. - Must be filled with leading zeros if the provider number is greater than 2 characters but less than 8 characters --- ## 📑 Response Fields ### 🔸status Indicates the status of the report being requested. - **Valid values:** - `COMPLETE` - `REPORT_NOT_AVAILABLE` - `REPORT_NOT_READY` - `REPORT_NOT_FOUND` - `REPORT_EXPIRED` When `status = COMPLETE`, the following values may be returned: --- #### 🔸paymentRun.runDate The date on which the agency is requesting the RBA to make the payment. --- #### 🔸paymentRun.runNumber A unique identifier for the payment run. --- #### 🔸paymentInfo.depositAmount The total amount of Medicare benefit to be deposited into the payee provider's account for the claims detailed in the payment run. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸paymentInfo.accountInfo.accountName The payee provider's financial institution account name. --- #### 🔸paymentInfo.accountInfo.accountNumber The payee provider's financial institution account number. - **Note:** Only the last 4 digits are returned and prefixed with asterisks, e.g., `\\\*1234`. --- #### 🔸paymentInfo.accountInfo.bsbCode The branch identifier (BSB) for where the payee provider's account is held. --- #### 🔸claimSummary.benefit The total amount of Medicare benefit paid for all services in the claim. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸claimSummary.chargeAmount The total amount charged for all services in the claim. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸claimSummary.claimId The unique identifier that is generated by Medicare for the original Bulk Bill claim. --- #### 🔸claimSummary.lodgementDate The date when Medicare received the original claim. --- #### 🔸claimSummary.transactionId The unique identifier of the claim request maintained throughout the life of a claim.

Authentication

x-api-keystring
API Key authentication via header

Headers

x-minor-idstringOptional

Request

This endpoint expects an object.
correlationIdstringRequired
payeeProviderobjectRequired

Response

OK
statusstring
correlationIdstring