Payments #
Payment reports for successful claims are available for most claim types with the payment API call.
Once claims are accepted, they are typically aggregated with other claims from the same practitioner for payment in a batch. For example all BulkBill claims that have been processed and paid on a given day will appear as a single deposit in the practitioner’s nominated bank account. The API appends a payment ID to each successful claim object, which is then retrieved with the payment API call.
Claims can result in payment to the practitioner, the patient, or a billing agent, depending on the type of claim and if the patient paid the invoice in full prior to submission.
NOTE: Medicare Patient claims can be submitted to Medicare via the API on behalf of the patient. There’s some limited reporting when the claim is lodged, but no further processing or payment reports will be available.
GET - List all payments
#
{{base_url}}/{{version}}/payments
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"total": 12,
"records": 8,
"offset": 0,
"results": {
"14785": {
"paymentId": 14785,
"runNumber": "TSTADV123",
"date": "2021-05-23",
"amount": 125,
"claims": [
{
"medicareIdentifier": "SAP00000mRaCrs6LNoxpZC9P",
"claimId": 178663,
"amount": 1.44
}
],
"bank": {
"bsb": "002913",
"accountNumber": "*****6789",
"accountName": "Dummy Health Fund Account"
},
"payerName": "Mock Health Fund Pty Ltd",
"remittanceAdviceId": "TSTADV123",
"eraTransactionId": "AAA99556ffff60a9edb00d00",
"paymentReference": "HHF00041012NAB2004REMADVA33562"
},
"14951": {
"paymentId": 14951,
"runNumber": "",
"date": "2021-06-06",
"amount": 38.2,
"claims": [
{
"medicareIdentifier": "SAP0000006062021111944",
"claimId": 0,
"amount": 38.2
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-IMIbZKvTovAnY8g4YNRDHPBe"
},
"14952": {
"paymentId": 14952,
"runNumber": "",
"date": "2021-06-06",
"amount": 38.75,
"claims": [
{
"medicareIdentifier": "SAP0000006062021122005",
"claimId": 0,
"amount": 38.75
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-74DEngbe1O3AP75MUh67RQbx"
},
"14953": {
"paymentId": 14953,
"runNumber": "",
"date": "2021-06-06",
"amount": 77.5,
"claims": [
{
"medicareIdentifier": "SAP0000006062021122106",
"claimId": 0,
"amount": 77.5
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-nTWT7l/Gt8JF+3osawgMQHt/"
},
"14954": {
"paymentId": 14954,
"runNumber": "",
"date": "2021-06-06",
"amount": 132.4,
"claims": [
{
"medicareIdentifier": "SAP0000006062021123642",
"claimId": 0,
"amount": 132.4
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-WHOySDdSiWrYU5/Qq2d8ExME"
},
"14955": {
"paymentId": 14955,
"runNumber": "",
"date": "2021-06-06",
"amount": 66.2,
"claims": [
{
"medicareIdentifier": "SAP0000006062021124901",
"claimId": 0,
"amount": 66.2
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-RTOfptIViHMSU0uGmmBtFr1a"
},
"14956": {
"paymentId": 14956,
"runNumber": "",
"date": "2021-06-06",
"amount": 66.2,
"claims": [
{
"medicareIdentifier": "SAP0000006062021124909",
"claimId": 0,
"amount": 66.2
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-MhdpypmSwKbzwHxyaoLdhz6b"
},
"14957": {
"paymentId": 14957,
"runNumber": "",
"date": "2021-06-06",
"amount": 38.75,
"claims": [
{
"medicareIdentifier": "SAP0000006062021130609",
"claimId": 0,
"amount": 38.75
}
],
"bank": {
"bsb": "",
"accountNumber": "",
"accountName": ""
},
"payerName": "Medicare Australia",
"remittanceAdviceId": "",
"eraTransactionId": "PCI-2021-06-06-LkK2PIFKjC7V9r7m+KDILQzm"
}
}
}
Headers:
| Header | Value |
|---|---|
| Server | nginx/1.19.3 |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 3091 |
| Connection | keep-alive |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |
GET - Check the status of a payment
#
{{base_url}}/{{version}}/payments/{{payment_id}}?location={{location_id}}
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Params
| Param | value |
|---|---|
| location | {{location_id}} |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/payment/321' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"paymentId": 1,
"runNumber": "0000",
"date": "1970-01-01",
"amount": 3169.45,
"claims": [
{
"medicareIdentifier": "A0000@",
"claimId": 0,
"amount": 84.3
}
],
"bank": {
"bsb": "000000",
"accountNumber": "000000000",
"accountName": "EXAMPLE BANK"
},
"payerName": "Medicare Australia",
"remittanceAdviceId": ""
}
GET - Check the status of a range of payments
#
To find all the payments since a given date use the suffix since=yyyy-mm-dd and you will receive an array of all payments since that date. The array presented will be limited to the chunk size and where in the array the offset parameter has been set.
For example; https://sandbox.claiming.com.au/v2/payments?location=25&limit=10&offset=0&since=2021-08-02
Will return 10 results at index 0 of an array since 2021-08-02.
{{base_url}}/{{version}}/payments?location={{location_id}}&limit=10&offset=0&since={{since}}
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Params
| Param | value |
|---|---|
| location | {{location_id}} |
| limit | 10 |
| offset | 0 |
| since | {{since}} |
Example Request:
curl --location -g 'https://sandbox.claiming.com.au/v2/payments?location=25&limit=10&offset=0&since={{today-28}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"offset": 0,
"records": 1,
"results": {
"1": {
"paymentId": 1,
"runNumber": "0000",
"date": "1970-01-01",
"amount": 3169.45,
"claims": [
{
"medicareIdentifier": "A0000@",
"claimId": 0,
"amount": 84.3
}
],
"bank": {
"bsb": "000000",
"accountNumber": "000000000",
"accountName": "EXAMPLE BANK"
},
"payerName": "Medicare Australia",
"remittanceAdviceId": ""
}
},
"status": "OK",
"total": 1
}