Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
transactions
/
{transactionId}
Get transaction by ID
curl --request GET \
  --url https://api.halth.com/v1/businesses/{businessId}/transactions/{transactionId}
{
  "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",
      "paymentId": "<string>",
      "payment": {},
      "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",
            "rebateAmount": 123,
            "serviceReference": "<string>",
            "patient": {
              "referenceNumber": "<string>"
            },
            "itemDescription": "<string>",
            "itemName": "<string>",
            "response": {
              "statusCode": "<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>",
          "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"
        }
      }
    }
  ],
  "transactionItems": [
    {
      "id": "<string>",
      "type": "charge",
      "chargeAmount": 123,
      "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": "mobile",
      "contactValue": "<string>",
      "verified": true,
      "action": "claim_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>",
    "defaultReferenceNumber": "<string>",
    "issueNumber": "<string>"
  },
  "bookingId": "<string>",
  "customer": {
    "name": "<string>"
  }
}

Path Parameters

businessId
string
required
transactionId
string
required

Query Parameters

expand
enum<string>[]
Available options:
transactionItems.billableItem

Response

200 - 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,
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
bookingId
string
customer
object