This is the API for prepaid cards.
It provides features for querying a Client's prepaid card balance, prepaid card list, and prepaid card top-up events.
Key Concepts
- Prepaid Card
- Definition: A card pre-loaded with a monetary amount or points that a Client can use at the clinic.
Description: The prepaid card list displays information such as card name, balance, linked Client, and expiration date. - Prepaid Card Balance
- Definition: The remaining prepaid card amount available for a Client to use.
Description: Cash balance and point balance may be provided separately, and can be checked in the balance inquiry by Client. - Charging Event
- Definition: A record of changes to the prepaid card amount.
Description: Events such as charge, use, use cancellation, refund, expiration, and deduction are used to track the cause of balance changes. - Card Owner
- Definition: The Client who paid for the prepaid card. Only one owner exists per prepaid card.
Description: A single prepaid card can be shared and used by multiple Clients, so the list shows whether each Client is the owner of that prepaid card. - Amount Type
- Definition: A value that distinguishes whether the prepaid card event amount is a cash balance or points.
Description: Required to correctly interpret event amounts when balances and points are managed separately.
Retrieve prepaid card events
Retrieves charge, usage, usage cancellation, refund, expiration, and deduction events for a prepaid card.
If no prepaid card matching the ID exists, an empty list is returned.
Retrieve prepaid card events › Responses
OK
Prepaid card event list
If the prepaid card does not exist, the list is empty.
Retrieve prepaid card list
Retrieves the list of prepaid cards for a Client.
Retrieve prepaid card list › Request Body
visitorIdClient ID for retrieving the prepaid card list
availableAvailability filter
If the value is omitted, the query is performed regardless of availability. If true, only prepaid cards that have not expired and have a remaining cash balance or point balance are retrieved. If false, only prepaid cards that have expired or have no remaining cash balance and no remaining point balance are retrieved.
Retrieve prepaid card list › Responses
OK
Prepaid card list
Includes only prepaid cards that have not been deleted. If available is provided, only prepaid cards that satisfy the corresponding availability condition are included.
Retrieve Client prepaid card combined balance
Retrieves the combined cash balance and point balance of available prepaid cards held by the Client.
Retrieve Client prepaid card combined balance › Request Body
visitorIdClient ID for retrieving the balance
Retrieve Client prepaid card combined balance › Responses
OK
Combined balance information of available prepaid cards
Only prepaid cards that have not expired, have a remaining cash balance or point balance, and have not been deleted are included in the total. If there are no prepaid cards to look up, the combined balance is 0.