Skip to main content
POST
/
v1
/
health-fund-cards
Create health fund card
curl --request POST \
  --url https://api.halth.com/v1/health-fund-cards \
  --header 'Content-Type: application/json' \
  --data '
{
  "memberNumber": "123456789",
  "healthFundId": "TEST",
  "issueNumber": "1",
  "defaultReferenceNumber": "1",
  "issueDate": null,
  "cardholders": []
}
'
{
  "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>"
}

Body

application/json
memberNumber
string
required

Member number

Required string length: 4 - 16
Example:

"123456789"

healthFundId
string
required

Health fund ID

Example:

"TEST"

issueNumber
string

Issue number

Required string length: 1 - 3
Example:

"1"

defaultReferenceNumber
string

Default reference number

Required string length: 1 - 2
Example:

"1"

issueDate
string

Issue date

Example:

null

cardholders
string[]

Cardholders

Example:
[]

Response

201 - application/json
id
string
required
memberNumberLast4
string
required
createdAt
string<date-time>
required
healthFundId
string
required
healthFund
object
required
cardholders
string[]
required
fingerprint
string
required
defaultReferenceNumber
string
issueNumber
string