Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
transactions
/
{transactionId}
/
claims
Create claim for transaction
curl --request POST \
  --url https://api.halth.com/v1/businesses/{businessId}/transactions/{transactionId}/claims \
  --header 'Content-Type: application/json' \
  --data '{
  "medicare": {}
}'
{
  "id": "<string>",
  "businessId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "pending",
  "amount": 123,
  "currency": "<string>",
  "paymentTransactions": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "source": "<string>",
      "amount": 123,
      "status": "pending",
      "adjustmentTransactions": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "source": "<string>",
          "amount": 123
        }
      ],
      "paymentId": "<string>",
      "payment": {
        "id": "<string>",
        "amount": 123,
        "currency": "<string>",
        "status": "<string>",
        "paymentMethodId": "<string>",
        "clientSecret": "<string>"
      },
      "claimId": "<string>",
      "claim": {
        "id": "<string>",
        "referenceNumber": "<string>",
        "status": "created",
        "createdAt": "2023-11-07T05:31:56Z",
        "isRebateEstimate": true,
        "totalChargeAmount": 123,
        "totalRebateAmount": 123,
        "totalGapAmount": 123,
        "serviceTypeCode": "F",
        "providerNumber": "<string>",
        "items": [
          {
            "id": "<string>",
            "chargeAmount": 123,
            "itemCode": "<string>",
            "serviceDate": "2023-11-07T05:31:56Z",
            "patientReferenceNumber": "<string>",
            "rebateAmount": 123,
            "serviceReference": "<string>",
            "itemDescription": "<string>",
            "itemName": "<string>",
            "response": {
              "statusCode": "<string>",
              "responseCode": "<string>"
            }
          }
        ],
        "device": {
          "terminalId": "<string>"
        },
        "serviceType": {
          "code": "<string>",
          "name": "<string>"
        },
        "healthFund": {
          "id": "<string>",
          "name": "<string>",
          "capabilities": {
            "claims": "active",
            "rebatesEstimates": "active"
          }
        },
        "cancelledAt": "2023-11-07T05:31:56Z",
        "voidedAt": "2023-11-07T05:31:56Z",
        "response": {
          "statusCode": "<string>",
          "responseCode": "<string>",
          "freeText": "<string>"
        },
        "payment": {
          "paymentAmount": 123,
          "bankAccountNumberLast4": "<string>",
          "bankAccountBsb": "<string>",
          "paymentDate": "2023-11-07T05:31:56Z",
          "paymentReference": "<string>"
        },
        "provider": {
          "providerNumber": "<string>",
          "name": "<string>",
          "categoryCode": "<string>",
          "serviceTypeCode": "F"
        }
      },
      "medicareClaimId": "<string>",
      "medicareClaim": {
        "id": "<string>",
        "status": "created",
        "createdAt": "2023-11-07T05:31:56Z",
        "type": "patient",
        "totalChargeAmount": 123,
        "totalRebateAmount": 123,
        "totalGapAmount": 123,
        "itemsCount": 123,
        "mcolTransactionId": "<string>",
        "items": [
          {
            "id": "<string>",
            "itemCode": "<string>",
            "chargeAmount": 123,
            "rebateAmount": 123,
            "gapAmount": 123,
            "mcolAssessmentCode": "<string>",
            "mcolErrorCode": "<string>",
            "mcolErrorMessage": "<string>",
            "patientCount": 123,
            "quantity": 123
          }
        ],
        "paymentStatus": "full_paid",
        "reference": "<string>",
        "patientMedicareCardId": "<string>",
        "claimantMedicareCardId": "<string>",
        "mcolClaimId": "<string>",
        "mcolErrorCode": "<string>",
        "mcolErrorMessage": "<string>",
        "transactionId": "<string>"
      }
    }
  ],
  "transactionItems": [
    {
      "type": "charge",
      "chargeAmount": 123,
      "id": "<string>",
      "description": "<string>",
      "clinicalCode": "<string>",
      "itemCode": "<string>",
      "billableItemId": "<string>",
      "billableItem": {
        "name": "<string>",
        "basePrice": 123,
        "totalPrice": 123,
        "taxAmount": 123,
        "taxRate": 123,
        "type": "service",
        "id": "<string>",
        "itemCode": "<string>",
        "pmsBillableItemId": "<string>"
      },
      "appointmentTypeId": "<string>"
    }
  ],
  "confirmations": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "contactType": "sms",
      "contactValue": "<string>",
      "verified": true,
      "action": "payment_confirmation",
      "expiresAt": "2023-11-07T05:31:56Z",
      "verificationCode": "<string>",
      "verifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "paymentMethodId": "<string>",
  "paymentMethod": {
    "id": "<string>",
    "brand": "<string>",
    "last4": "<string>",
    "customerId": "<string>"
  },
  "healthFundCardId": "<string>",
  "healthFundCard": {
    "id": "<string>",
    "memberNumberLast4": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "healthFundId": "<string>",
    "healthFund": {
      "id": "<string>",
      "name": "<string>",
      "capabilities": {
        "claims": "active",
        "rebatesEstimates": "active"
      }
    },
    "cardholders": [
      "<string>"
    ],
    "fingerprint": "<string>",
    "verified": true,
    "defaultReferenceNumber": "<string>",
    "issueNumber": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z"
  },
  "medicareCardId": "<string>",
  "medicareCard": {
    "id": "<string>",
    "memberNumberLast4": "<string>",
    "referenceNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "fingerprint": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "dateOfBirth": "<string>",
    "verified": true,
    "secondInitial": "<string>",
    "sex": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z"
  },
  "bookingId": "<string>",
  "customer": {
    "name": "<string>"
  },
  "clientName": "<string>",
  "client": {
    "id": "<string>",
    "deleted": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "memberId": "memb_38JiySr0Z0ePjHpqvosimyLQuUC",
    "firstName": "<string>",
    "lastName": "<string>",
    "dateOfBirth": "<string>",
    "mobileNumber": "<string>",
    "email": "<string>",
    "source": "pms",
    "pmsPatientId": "<string>",
    "pmsCreatedAt": "2023-11-07T05:31:56Z",
    "profileImageUrl": "<string>"
  },
  "serviceProvider": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "locationIds": [
      "<string>"
    ],
    "deleted": true,
    "mobileNumber": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "title": "Dr",
    "profileImageUrl": "<string>",
    "locationLinks": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "providerId": "<string>",
        "locationId": "<string>",
        "deleted": true,
        "acceptedTerms": true,
        "registrationStatus": "not_started",
        "applicationStatus": "not_started",
        "serviceTypeCode": "<string>",
        "categoryCode": "<string>",
        "medicare": {
          "suggestedProviderNumber": "<string>",
          "providerNumber": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "registrationLetter": "<string>"
        },
        "association": {
          "registrationLetter": "<string>"
        }
      }
    ],
    "locations": [
      {
        "id": "<string>",
        "name": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "timeZone": "<string>",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "suburb": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postcode": "<string>",
          "country": "<string>",
          "countryCode": "<string>"
        },
        "suggestedTaxIdentifier": "<string>",
        "bookingCustomText": "<string>",
        "businessId": "<string>",
        "business": {
          "id": "<string>",
          "name": "<string>",
          "settings": {
            "autoReconciliationEnabled": true,
            "autoInviteClientsEnabled": true
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "taxIdentifier": "<string>",
          "countryCode": "<string>",
          "structure": "public_corporation",
          "merchantId": "<string>",
          "capabilities": [
            {
              "id": "bookings_client_funding_phi",
              "status": "inactive"
            }
          ],
          "events": {}
        },
        "email": "<string>",
        "registrations": [
          {
            "type": "medicare",
            "medicare": {
              "minorId": "<string>",
              "prodaLocationId": "<string>",
              "status": "<string>"
            },
            "phi": {
              "phiLocationId": "<string>",
              "status": "<string>"
            }
          }
        ]
      }
    ]
  },
  "location": {
    "id": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "timeZone": "<string>",
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "suburb": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postcode": "<string>",
      "country": "<string>",
      "countryCode": "<string>"
    },
    "suggestedTaxIdentifier": "<string>",
    "bookingCustomText": "<string>",
    "businessId": "<string>",
    "business": {
      "id": "<string>",
      "name": "<string>",
      "settings": {
        "autoReconciliationEnabled": true,
        "autoInviteClientsEnabled": true
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "taxIdentifier": "<string>",
      "countryCode": "<string>",
      "structure": "public_corporation",
      "merchantId": "<string>",
      "capabilities": [
        {
          "id": "bookings_client_funding_phi",
          "status": "inactive"
        }
      ],
      "events": {}
    },
    "email": "<string>",
    "registrations": [
      {
        "type": "medicare",
        "medicare": {
          "minorId": "<string>",
          "prodaLocationId": "<string>",
          "status": "<string>"
        },
        "phi": {
          "phiLocationId": "<string>",
          "status": "<string>"
        }
      }
    ]
  }
}

Path Parameters

businessId
string
required
transactionId
string
required

Body

application/json
medicare
object

Response

201 - application/json
id
string
required
businessId
string
required
createdAt
string<date-time>
required
status
enum<string>
required
Available options:
pending,
completed,
requires_confirmation,
requires_payment,
requires_review,
reversed,
failed
amount
number
required
currency
string
required
paymentTransactions
object[]
required
transactionItems
object[]
required
confirmations
object[]
required
paymentMethodId
string
paymentMethod
object
healthFundCardId
string
healthFundCard
object
medicareCardId
string
medicareCard
object
bookingId
string
customer
object
clientName
string
client
object
serviceProvider
object
location
object