API

잔액 조회

작성일 2026.03.11 | 수정일 2026.03.11

GET/cash/v1/balance

현재 계정의 보유 잔액(캐시)과 포인트를 조회합니다.
잔액은 메시지 발송, 충전, 출금 등의 거래에 사용되는 핵심 정보이며, 자동 충전 설정 상태와 잔액 소진 알림 설정도 함께 확인할 수 있습니다.

Response

Name	Type	Required	Description
accountId	string	*	계정 고유 ID
balance	number	*	현재 보유 잔액 (원). 소수점 이하 반올림 처리됩니다.
point	number	*	현재 보유 포인트 (원). 소수점 이하 반올림 처리됩니다.
minimumCash	number	*	자동 충전 기준 금액. 보유 잔액이 이 금액 이하로 떨어지면 자동 충전이 실행됩니다.
rechargeTo	number	*	자동 충전 시 목표 충전 금액
autoRecharge	number	*	자동 충전 활성화 여부. 0이면 비활성, 1 이상이면 활성 상태입니다.
lowBalanceAlert	object	*	잔액 소진 알림 설정 정보
notificationBalance	string	*	마지막으로 알림을 보낸 기준 금액
currentBalance	string\|null	*	알림 발송 당시 보유 금액
balances	array	*	알림을 받을 기준 금액 목록 (최소 200원, 최대 3개)
channels	array	*	알림 수신 채널 목록 (SMS, ATA, EMAIL 중 최소 1개, 최대 2개)
enabled	boolean	*	알림 활성화 여부

Structure

Response

{
  "accountId": "12345678901234",
  "balance": 150000,
  "point": 3000,
  "minimumCash": 10000,
  "rechargeTo": 50000,
  "autoRecharge": 1,
  "lowBalanceAlert": {
    "notificationBalance": "0",
    "currentBalance": null,
    "balances": [
      200
    ],
    "channels": [
      "SMS"
    ],
    "enabled": true
  }
}