プリペイドカード

サーバー

スキーマをダウンロード

プリペイドカード関連のAPIです。

患者のプリペイドカード残高、プリペイドカードリスト、プリペイドカードチャージイベント照会機能を提供します。

主要概念

プリペイドカード: 定義：患者がクリニックで使用できるよう、あらかじめチャージしておいた金額またはポイント単位のカードです。
説明：プリペイドカードリストの照会では、カード名、残高、連携患者、満了日などの情報を確認します。
プリペイドカード残高: 定義：患者が使用できる残りのプリペイドカード金額です。
説明：現金残高とポイント残高が区別して提供される場合があり、患者基準の残高照会で確認します。
チャージイベント: 定義：プリペイドカード金額が変動した履歴です。
説明：チャージ、使用、使用キャンセル、返金、満了、差し引きなどのイベントを通じて、残高変化の原因を追跡します。
カード所有者: 定義：プリペイドカードを会計した患者です。プリペイドカード1枚につき、所有者は1名のみです。
説明：1枚のプリペイドカードを複数の患者が共有して使用できるため、リストで各患者が該当プリペイドカードの所有者であるかどうかを確認できます。
金額タイプ: 定義：プリペイドカードイベントの金額が現金残高かポイントかを区別する値です。
説明：残高とポイントが別途管理される場合に、イベント金額を正しく解釈するために必要です。

プリペイドカードイベント照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-prepaid-card-charging-events

Authorization (header)

プリペイドカードのチャージ、使用、使用キャンセル、返金、満了、差し引きイベントを照会します。

IDに該当するプリペイドカードがない場合、空のリストが返されます。

プリペイドカードイベント照会 › リクエスト

GetPrepaidCardChargingEventsQuery

id

string · 必須

プリペイドカードID

プリペイドカードイベント照会 › レスポンス

成功

GetPrepaidCardChargingEventsQueryResponse

PrepaidCardChargingEvent[]

プリペイドカードイベントリスト

該当するプリペイドカードがない場合、リストは空です。

POST/purchase/open/prepaid-card/v1/queries/get-prepaid-card-charging-events

curl https://open-api.kos-solution.com/purchase/open/prepaid-card/v1/queries/get-prepaid-card-charging-events \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": "id"
}'

リクエスト例

{
  "id": "id"
}

json

レスポンス例

{
  "data": [
    {
      "type": "PrepaidCardChargingEventType_UNKNOWN",
      "amount": {
        "type": "PrepaidCardChargingEventAmountType_UNKNOWN",
        "amount": {
          "value": 0,
          "currency": "currency"
        }
      },
      "chargingId": "chargingId",
      "createdDateTimeUtc": "2024-08-25T15:00:00Z",
      "memo": "memo",
      "visitor": {
        "name": "name",
        "chartNumber": "chartNumber",
        "owner": true,
        "visitorId": "visitorId"
      }
    }
  ]
}

json

application/json

プリペイドカードリスト照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-prepaid-card-summaries

Authorization (header)

患者のプリペイドカードリストを照会します。

プリペイドカードリスト照会 › リクエスト

GetPrepaidCardSummariesQuery

visitorId

string · object-id · 必須

プリペイドカードリストを照会する患者ID

available

boolean

使用可否フィルター

値を省略した場合、使用可否に関わらず照会します。trueの場合、有効期限が切れておらず、現金残高またはポイント残高が残っているプリペイドカードのみ照会します。falseの場合、有効期限が切れているか、現金残高とポイント残高がいずれも残っていないプリペイドカードのみ照会します。

プリペイドカードリスト照会 › レスポンス

成功

GetPrepaidCardSummariesQueryResponse

PrepaidCardSummaryContract[]

プリペイドカードリスト

削除されていないプリペイドカードのみを含みます。availableを指定した場合、該当する使用可否条件を満たすプリペイドカードのみを含みます。

POST/purchase/open/prepaid-card/v1/queries/get-prepaid-card-summaries

curl https://open-api.kos-solution.com/purchase/open/prepaid-card/v1/queries/get-prepaid-card-summaries \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "available": true,
  "visitorId": "visitorId"
}'

リクエスト例

{
  "available": true,
  "visitorId": "visitorId"
}

json

レスポンス例

{
  "data": [
    {
      "title": "title",
      "description": "description",
      "createdDateTimeUtc": "2024-08-25T15:00:00Z",
      "expirationDateTimeUtc": "2024-08-25T15:00:00Z",
      "id": "id",
      "ownerId": "ownerId",
      "remainingBalance": {
        "balance": {
          "value": 0,
          "currency": "currency"
        },
        "total": {
          "value": 0,
          "currency": "currency"
        }
      },
      "remainingPoint": {
        "balance": {
          "value": 0,
          "currency": "currency"
        },
        "total": {
          "value": 0,
          "currency": "currency"
        }
      },
      "translsMap": {
        "key": {
          "translation": {
            "key": "string"
          }
        }
      },
      "updatedDateTimeUtc": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

患者プリペイドカード合算残高照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-visitor-prepaid-card-balance

Authorization (header)

患者が保有する使用可能なプリペイドカードの現金残高とポイント残高を合算して照会します。

患者プリペイドカード合算残高照会 › リクエスト

GetVisitorPrepaidCardBalanceQuery

visitorId

string · object-id · 必須

残高を照会する患者ID

患者プリペイドカード合算残高照会 › レスポンス

成功

GetVisitorPrepaidCardBalanceQueryResponse

object · 必須

使用可能なプリペイドカードの合算残高情報

有効期限が切れておらず、現金残高またはポイント残高が残っており、削除されていないプリペイドカードのみを合算します。照会対象のプリペイドカードがない場合、合算残高は0です。

POST/purchase/open/prepaid-card/v1/queries/get-visitor-prepaid-card-balance

curl https://open-api.kos-solution.com/purchase/open/prepaid-card/v1/queries/get-visitor-prepaid-card-balance \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "visitorId": "visitorId"
}'

リクエスト例

{
  "visitorId": "visitorId"
}

json

レスポンス例

{
  "data": {
    "lastBalanceChargedDateTimeUtc": "2024-08-25T15:00:00Z",
    "lastPointChargedDateTimeUtc": "2024-08-25T15:00:00Z",
    "remainingBalance": {
      "balance": {
        "value": 0,
        "currency": "currency"
      },
      "total": {
        "value": 0,
        "currency": "currency"
      }
    },
    "remainingPoint": {
      "balance": {
        "value": 0,
        "currency": "currency"
      },
      "total": {
        "value": 0,
        "currency": "currency"
      }
    }
  }
}

json

application/json

画像商品

プリペイドカード関連のAPIです。

患者のプリペイドカード残高、プリペイドカードリスト、プリペイドカードチャージイベント照会機能を提供します。

主要概念

プリペイドカード: 定義：患者がクリニックで使用できるよう、あらかじめチャージしておいた金額またはポイント単位のカードです。
説明：プリペイドカードリストの照会では、カード名、残高、連携患者、満了日などの情報を確認します。
プリペイドカード残高: 定義：患者が使用できる残りのプリペイドカード金額です。
説明：現金残高とポイント残高が区別して提供される場合があり、患者基準の残高照会で確認します。
チャージイベント: 定義：プリペイドカード金額が変動した履歴です。
説明：チャージ、使用、使用キャンセル、返金、満了、差し引きなどのイベントを通じて、残高変化の原因を追跡します。
カード所有者: 定義：プリペイドカードを会計した患者です。プリペイドカード1枚につき、所有者は1名のみです。
説明：1枚のプリペイドカードを複数の患者が共有して使用できるため、リストで各患者が該当プリペイドカードの所有者であるかどうかを確認できます。
金額タイプ: 定義：プリペイドカードイベントの金額が現金残高かポイントかを区別する値です。
説明：残高とポイントが別途管理される場合に、イベント金額を正しく解釈するために必要です。

プリペイドカードイベント照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-prepaid-card-charging-events

Authorization (header)

プリペイドカードのチャージ、使用、使用キャンセル、返金、満了、差し引きイベントを照会します。

IDに該当するプリペイドカードがない場合、空のリストが返されます。

プリペイドカードイベント照会 › リクエスト

GetPrepaidCardChargingEventsQuery

id

string · 必須

プリペイドカードID

プリペイドカードイベント照会 › レスポンス

成功

GetPrepaidCardChargingEventsQueryResponse

PrepaidCardChargingEvent[]

プリペイドカードイベントリスト

該当するプリペイドカードがない場合、リストは空です。

プリペイドカードリスト照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-prepaid-card-summaries

Authorization (header)

患者のプリペイドカードリストを照会します。

プリペイドカードリスト照会 › リクエスト

GetPrepaidCardSummariesQuery

visitorId

string · object-id · 必須

プリペイドカードリストを照会する患者ID

available

boolean

使用可否フィルター

プリペイドカードリスト照会 › レスポンス

成功

GetPrepaidCardSummariesQueryResponse

PrepaidCardSummaryContract[]

プリペイドカードリスト

削除されていないプリペイドカードのみを含みます。availableを指定した場合、該当する使用可否条件を満たすプリペイドカードのみを含みます。

患者プリペイドカード合算残高照会

POST

https://open-api.kos-solution.com

/purchase/open/prepaid-card/v1/queries/get-visitor-prepaid-card-balance

Authorization (header)

患者が保有する使用可能なプリペイドカードの現金残高とポイント残高を合算して照会します。

患者プリペイドカード合算残高照会 › リクエスト

GetVisitorPrepaidCardBalanceQuery

visitorId

string · object-id · 必須

残高を照会する患者ID

患者プリペイドカード合算残高照会 › レスポンス

成功

GetVisitorPrepaidCardBalanceQueryResponse

object · 必須

使用可能なプリペイドカードの合算残高情報