본문으로 건너뛰기

실시간 현금정보 API

1. 개요​

기기에서 현금 현송 후 기기에 채워진 잔액 및 잔량 정보를 전송하는 API입니다.
부분방출발생여부는, 방출수량, 거래요청매수, 미반환금액은 항상 “0”(정상)으로 전송됩니다.

2. API 기본 정보​

항목값
업무구분실시간 현금정보
URL/api/v1/kioskCashInfo
프로토콜HTTPS
요청방식POST
생성일2020. 3. 10

3. 요청 정보​

3.1 요청 헤더​

필드ID필드명데이터타입필수길이설명
msgSendYmd메시지 전송 일자StringM8메시지 전송 일자
(YYYYMMDD, 예: 20170123)
msgSendHms메시지 전송 시각StringM6메시지 전송 시각
(hhmmss, 예: 185612)
kioskBranchId키오스크 지점번호StringM1~8키오스크 지점번호
kioskDeviceId키오스크 기기번호StringM1~12키오스크 기기번호

3.2 요청 바디​

필드ID필드명데이터타입필수길이설명
sendTypeCd전송 유형StringM1~51: 개시
2: 현송 전(마감)
3: 현송 후
cashInfo현금정보ObjectM-현금 관련 상세 정보
└ operateYmd기기 조작일자StringM1~8YYYYMMDD
└ operateHms기기 조작시각StringM1~6hhmmss
└ balance기기내 잔액Number (1/10)M-기기 내 잔액
└ balance50000출금부 오만원권 잔량Number (1/5)M-오만원권 잔량
└ balance10000출금부 만원권 잔량Number (1/5)M-만원권 잔량
└ balance5000출금부 오천원권 잔량Number (1/5)M-오천원권 잔량
└ balance1000출금부 천원권 잔량Number (1/5)M-천원권 잔량
└ balance500출금부 오백원권 잔량Number (1/5)M-오백원권 잔량
└ balance100출금부 백원권 잔량Number (1/5)M-백원권 잔량
└ release50000오만원권 방출수량Number (1/5)M-오만원권 방출 수량
└ release10000만원권 방출수량Number (1/5)M-만원권 방출 수량
└ release5000오천원권 방출수량Number (1/5)M-오천원권 방출 수량
└ release1000천원권 방출수량Number (1/5)M-천원권 방출 수량
└ release500오백원권 방출수량Number (1/5)M-오백원권 방출 수량
└ release100백원권 방출수량Number (1/5)M-백원권 방출 수량
└ noRtnTotAmt미반환금액Number (1/12)M-미반환 금액 총액
└ partialRelease부분방출발생여부StringM10: 정상
1: 부분방출
└ request50000오만원권 거래요청매수Number (1/5)M-오만원권 거래 요청 매수
└ request10000만원권 거래요청매수Number (1/5)M-만원권 거래 요청 매수
└ request5000오천원권 거래요청매수Number (1/5)M-오천원권 거래 요청 매수
└ request1000천원권 거래요청매수Number (1/5)M-천원권 거래 요청 매수
└ request500오백원권 거래요청매수Number (1/5)M-오백원권 거래 요청 매수
└ request100백원권 거래요청매수Number (1/5)M-백원권 거래 요청 매수
└ reject50000오만원권 리젝트함 매수Number (1/5)M-오만원권 리젝트함 매수
└ reject10000만원권 리젝트함 매수Number (1/5)M-만원권 리젝트함 매수
└ reject5000오천원권 리젝트함 매수Number (1/5)M-오천원권 리젝트함 매수
└ reject1000천원권 리젝트함 매수Number (1/5)M-천원권 리젝트함 매수
└ reject500오백원권 리젝트함 매수Number (1/5)M-오백원권 리젝트함 매수
└ reject100백원권 리젝트함 매수Number (1/5)M-백원권 리젝트함 매수

3.3 요청 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010",
    "loginSesKey": "ABCDEF1234567890",
    "langCd": "ko"
  },
  "body": {
    "sendTypeCd": "1",
    "cashInfo": {
      "operateYmd": "20170205",
      "operateHms": "125651",
      "balance": 307500,
      "balance50000": 5,
      "balance10000": 4,
      "balance5000": 3,
      "balance1000": 2,
      "balance500": 1,
      "balance100": 0,
      "release50000": 0,
      "release10000": 0,
      "release5000": 0,
      "release1000": 0,
      "release500": 0,
      "release100": 0,
      "noRtnTotAmt": 0,
      "partialRelease": "0",
      "request50000": 0,
      "request10000": 0,
      "request5000": 0,
      "request1000": 0,
      "request500": 0,
      "request100": 0,
      "reject50000": 0,
      "reject10000": 0,
      "reject5000": 0,
      "reject1000": 0,
      "reject500": 0,
      "reject100": 0
    }
  }
}

4. 응답 정보​

4.1 응답 헤더​

필드ID필드명데이터타입필수길이설명
msgSendYmd메시지 전송 일자StringM8메시지 전송 일자
(YYYYMMDD, 예: 20170123)
msgSendHms메시지 전송 시각StringM6메시지 전송 시각
(hhmmss, 예: 185612)
kioskBranchId키오스크 지점번호StringM1~8키오스크 지점번호
kioskDeviceId키오스크 기기번호StringM1~12키오스크 기기번호
respCd응답코드StringM5문자 5글자 (예: 00000)
respMsg응답메시지StringM0~250응답 메시지

4.2 응답 바디​

응답 바디 없음

4.3 응답 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010",
    "loginSesKey": "ABCDEF1234567890",
    "langCd": "",
    "respCd": "00000",
    "respMsg": "정상"
  },
  "body": null
}