서비스코인

서비스 코인과 관련된 API 기능을 제공합니다.

서비스 코인의 존재 유무 확인을 할 수 있습니다.

서비스 코인은 가맹점주가 웹을 통해 등록하며, 등록된 코인은 단말기에서 특정 버튼(터치)을 통해 사용 가능합니다.
서비스 코인은 최초 등록 후, 10분 동안만 사용 가능합니다.
서비스 코인은 단말기 ID를 기준으로 조회할 수 있습니다.

서비스 코인을 이용하기 위해서는 머신기와 단말기 사이의 전용 펌웨어 개발이 필요하기 때문에 별도 계약이 필요합니다.

기본 호출 구문

const API = axios.create({
    baseURL: `http://api.ubcn.co.kr/pay/servicecoin`,
    headers: {
        "Access-Control-Allow-Origin": "*",
        "company": "{company}", //유비씨엔 발급
        "token"  : "{token}",     //유비씨엔 발급
    },
});

서비스 코인 조회하기

단말기 ID 를 통해 단말기 ID 에 등록된 서비스 코인을 조회할 수 있습니다.

GET /pay/servicecoin/tid/{tid}

//유비씨엔(주)에서 제공하는 단말기 ID를 기준으로 서비스 코인을 조회합니다.
const res = await API.get("/tid/{tid}");

Request Schema

필드명	필수	타입	설명	비고
tid	Y	String	단말기 ID	-

Response Schema

응답 결과의 필드는 다음과 같으며, 결과 값이 정상일 때와 비정상일 때의 필드가 다릅니다.

정상결과

필드명	필수	타입	설명	비고
tid	Y	String	요청 단말기 ID	-
amount	Y	String	등록된 서비스 코인 금액	-
expireDate	Y	String	만료일자	-

비정상

필드명	필수	타입	설명	비고
code	Y	String	API 결과코드	-
message	Y	String	결과문구	-
description	Y	String	결과문구 요약	-

서비스 코인 등록하기

서비스 코인을 특정 단말기 에 등록할 수 있습니다.

POST /pay/servicecoin

const res = await API.post("/",
{
    "tid" : "{tid}",
    "amount": "{amount}",
    "companySeq": "{companySeq}",
    "userSeq" : "{userSeq}",
    "tranType" : "C"
});

Request Schema

필드명	필수	타입	설명	비고
tid	Y	String	단말기 ID	-
amount	Y	String	금액	-
companySeq	Y	String	소속 고유번호	-
userSeq	Y	String	사용자 고유번호	-
tranType	Y	String	유형	고정값: 'C'

Response Schema

필드명	필수	타입	설명	비고
code	Y	String	API 결과코드	-
message	Y	String	결과문구	-
description	Y	String	결과문구 요약	-

서비스 코인 사용처리

서비스 코인을 사용처리 상태로 변경합니다. (사용처리가 되면 , 기 등록된 서비스 코인은 삭제됩니다.)

DELETE /pay/servicecoin

const res = await API.delete("/tid/{tid}");

Request Schema

필드명	필수	타입	설명	비고
tid	Y	String	단말기 ID	-

Response Schema

필드명	필수	타입	설명	비고
code	Y	String	API 결과코드	-
message	Y	String	결과문구	-
description	Y	String	결과문구 요약	-