Skip to main content
GET
/
v1
/
organisations
/
{organisationId}
/
clients
/
{clientId}
/
wallet
Get client wallet
curl --request GET \
  --url https://api.halth.com/v1/organisations/{organisationId}/clients/{clientId}/wallet
{
  "id": "<string>",
  "customerId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "paymentMethods": [
    {
      "id": "<string>",
      "brand": "<string>",
      "last4": "<string>",
      "customerId": "<string>"
    }
  ],
  "healthFundCards": [
    {
      "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>"
    }
  ],
  "medicareCards": [
    {}
  ],
  "defaultPaymentMethodId": "<string>",
  "defaultHealthFundCardId": "<string>",
  "defaultMedicareCardId": "<string>"
}

Path Parameters

organisationId
string
required
clientId
string
required

Response

200 - application/json
id
string
required

Wallet ID

customerId
string
required

Payments customer ID

createdAt
string<date-time>
required

Created at timestamp

paymentMethods
object[]
required

Payment methods linked to the wallet

healthFundCards
object[]
required

Health fund cards linked to the wallet

medicareCards
object[]
required

Medicare cards linked to the wallet

defaultPaymentMethodId
string
defaultHealthFundCardId
string
defaultMedicareCardId
string