KOS OpenAPI
string · object-id · 필수boolean
선불카드 관련 API입니다.
내원객의 선불카드 잔액, 선불카드 목록, 선불카드 충전 이벤트 조회 기능을 제공합니다.
주요 개념
- 선불카드
- 정의: 내원객이 병원에서 사용할 수 있도록 미리 충전해 둔 금액 또는 포인트 단위의 카드입니다.
설명: 선불카드 목록 조회에서는 카드 이름, 잔액, 연결 내원객, 만료일 같은 정보를 확인합니다. - 선불카드 잔액
- 정의: 내원객이 사용할 수 있는 남은 선불카드 금액입니다.
설명: 현금 잔액과 포인트 잔액이 구분되어 제공될 수 있으며, 내원객 기준 잔액 조회에서 확인합니다. - 충전 이벤트
- 정의: 선불카드 금액이 변동된 이력입니다.
설명: 충전, 사용, 사용 취소, 환불, 만료, 차감 같은 이벤트를 통해 잔액 변화의 원인을 추적합니다. - 카드 소유자
- 정의: 선불카드를 수납한 내원객입니다. 선불카드당 소유자는 한 명만 존재합니다.
설명: 하나의 선불카드를 여러 내원객이 공유하여 사용할 수 있으므로, 목록에서 각 내원객이 해당 선불카드의 소유자인지 확인할 수 있습니다. - 금액 유형
- 정의: 선불카드 이벤트 금액이 현금 잔액인지 포인트인지 구분하는 값입니다.
설명: 잔액과 포인트가 별도로 관리되는 경우 이벤트 금액을 올바르게 해석하는 데 필요합니다.
선불카드 이벤트 조회
POST
https://open-api.kos-solution.com
/purchase/open/prepaid-card/v1/queries/get-prepaid-card-charging-events
Authorization (header)
선불카드 목록 조회
POST
https://open-api.kos-solution.com
/purchase/open/prepaid-card/v1/queries/get-prepaid-card-summaries
Authorization (header)
내원객의 선불카드 목록을 조회합니다.
선불카드 목록 조회 › 요청
visitorId선불카드 목록을 조회할 내원객 ID
available사용 가능 여부 필터
값을 생략하면 사용 가능 여부와 관계없이 조회합니다. true이면 만료되지 않았고 현금 잔액 또는 포인트 잔액이 남아 있는 선불카드만 조회합니다. false이면 만료되었거나 현금 잔액과 포인트 잔액이 모두 남아 있지 않은 선불카드만 조회합니다.
선불카드 목록 조회 › 응답
성공
OK
선불카드 목록
삭제되지 않은 선불카드만 포함합니다. available을 전달하면 해당 사용 가능 여부 조건을 만족하는 선불카드만 포함합니다.
내원객 선불카드 합산 잔액 조회
POST
https://open-api.kos-solution.com
/purchase/open/prepaid-card/v1/queries/get-visitor-prepaid-card-balance
Authorization (header)