잔액 옵션 조회 API

자동충전을 사용하는 가맹점 전용 잔액조회 API, 응답값 내의 고객 자동충전 사용 여부 값 ( custAutoChrgYn ) 이 Y 인 경우, 고객 또한 사용시 부족분 자동충전 기능을 사용 및 계좌 등록이 되었다는 뜻으로 해당 고객은 잔액보다 거래금액이 큰 사용 API 요청도 허용된다 (부족한 잔액에 대해서 자동으로 충전된 뒤 사용처리 됨)


API 정보

POST/v1/wallet/option/balance
Content-Typeapplication/json;charset=UTF-8
테스트https://tb-mps-api.hectofinancial.co.kr/v1/wallet/option/balance
운영https://mps-api.hectofinancial.co.kr/v1/wallet/option/balance

요청 파라미터

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
custNoAN(20)영문+숫자, 최대 20byte*
선불 회원 번호
*헥토파이낸셜에서 부여하는 고유 선불 회원 번호
ciAN(255)영문+숫자, 최대 255byte*AES-256AES-256/ECB/PKCS5Padding + Base64
선불 회원 CI
*고객의 고유한 CI 값

응답 파라미터

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
rsltCdAN(4)영문+숫자, 최대 4byte*0000
응답코드
0000: 성공
rsltMsgAN(200)영문+숫자, 최대 200byte*성공
응답 메시지

rsltObj (응답 객체)

custNoAN(20)영문+숫자, 최대 20byte*20240000
선불 회원 번호
*헥토파이낸셜에서 부여하는 고유 선불 회원 번호
custDivCdAN(1)영문+숫자, 최대 1byte*0
고객 구분 코드
0: 무기명 1: 기명
chrgblAmtN(7)숫자, 최대 7byte*500000
충전 가능금액
*조회 시점의 충전 가능 머니 금액
mnyBlcN(7)숫자, 최대 7byte*1500000
머니 잔액
pntBlcN(7)숫자, 최대 7byte*1000
포인트 잔액
waitMnyBlcN(7)숫자, 최대 7byte*0
대기 머니 잔액
expMnyBlcN(7)숫자, 최대 7byte*0
2M 소멸 예정 머니 금액
*머니 유효기간 10년
custAutoChrgYnAN(1)영문+숫자, 최대 1byte*Y
고객 자동충전 사용 여부
*고객이 자동충전을 사용하면서, 부족분 자동충전 허용으로 설정된 경우 Y.
'Y' 일 경우, 고객의 잔액 < 거래금액 으로 사용 API 인입시 부족분 자동충전 후 사용처리

요청 예시

{
  "custNo": "2400001605",
  "ci": "AES암호화된CI값"
}

응답 예시

성공

{
  "rsltCd": "0000",
  "rsltMsg": "성공",
  "rsltObj": {
    "custNo": "2400001605",
    "custDivCd": "0",
    "chrgblAmt": "500000",
    "mnyBlc": "1500000",
    "pntBlc": "1000",
    "waitMnyBlc": "0",
    "expMnyBlc": "0",
    "custAutoChrgYn": "Y"
  }
}

실패 (자동충전 미사용 상점의 요청)

{
  "rsltCd": "M-007",
  "rsltMsg": "자동충전 미사용 상점으로 해당 API 사용 불가합니다."
}
❓

더 궁금한 내용이 있나요?

FAQ
💬

기술지원이 필요한가요?