복지카드 거래내역 요청

웰포인트 거래와 관련된 API 기능을 제공합니다.

웰포인트 API를 이용하여 거래내역을 요청 할 수 있습니다. 서비스 테스트를 위해서는 API 호출이 필요합니다.
거래내역을 포함하여 충전이력이 함께 응답됩니다.

거래내역 조회는 일 단위, 카드번호, 단말기ID, 일자 범위로 조회가 가능합니다.

일일 거래내역 조회

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
date	-	Y	String	거래일자	일자 규격은 'YYYYMMDD'를 따름.

호출구문

const API = axios.create({
        baseURL: `http://api.ubcn.co.kr/api`,
        headers: {
            "Access-Control-Allow-Origin": "*",
            "PER-ID": "{유출금지}",
            "PER-TOKEN": "{유출금지}",
        },
});

    // post 요청만을 지원합니다.
    // {date}는 "YYYYMMDD" 규격을 따릅니다.
    const res = await API.post("/well/sales/{date}");
    console.log(res.data);

    // 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.
    if (res.code != null) {
        return alert(res.decription);
    }

Response Schema

결과 값에 들어 있는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
result_code	-	Y	String	결과 코드	-
result_msg	-	Y	String	응답 메시지	-
findCnt	-	Y	int	조회된 거래 건수	-
foundList	-	Y	Array	조회된 거래내역 리스트	객체 리스트
	tranDate	Y	String	거래일자	YYYYMMDD
	tsType	Y	String	사용이력 구분	-
	tsNo	Y	String	거래번호	`VM999`의 경우 충전을 의미
	terminalID	Y	String	단말기 ID	-
	cardNo	Y	String	카드번호	-
	vmOut	Y	String	복지금 사용액	-
	vColumn	Y	String	자판기컬럼	-
	pName	Y	String	상품명	-
	originDate	N	String	취소 원거래일	취소된 거래일 때 원거래 날짜 표기
	originTsNo	N	String	취소 원거래번호	취소된 거래일 때 원거래 날짜 표기
	approvalTime	Y	String	승인일자	yyyy-MM-dd HH:mm:ss.S

Response JSON 예시

{
    "findCnt": 2,
    "foundList":[{
    "tranDate": "20220927",
    "tsType": "취소",
    "tsNo": "4",
    "terminalID": "2000011111",
    "cardNo": "CARDubcn",
    "vmOut": "0",
    "vColumn": "01",
    "pName": "상품명",
    "originDate": "null",
    "originTsNo": "null",
    "approvalTime": "2022-09-27 13:36:17.0",
},{..}],
    "result_code": "0000",
    "result_msg": "Success"
}

일일 거래내역 조회 (카드번호)

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
date	-	Y	String	거래일자	일자 규격은 'YYYYMMDD'를 따름.
cardNo	-	Y	String	카드번호	-

호출구문

const API = axios.create({
        baseURL: `http://api.ubcn.co.kr/api`,
        headers: {
            "Access-Control-Allow-Origin": "*",
            "PER-ID": "{유출금지}",
            "PER-TOKEN": "{유출금지}",
        },
});

// {date}는 "YYYYMMDD" 규격, {cardNo}는 카드번호를 따릅니다.
const res = await API.post("/well/sales/{date}/card/{cardNo}");
console.log(res.data);

※ 응답 규격 및 예시는 상단의 [일일 거래내역 조회]와 동일합니다.

일일 거래내역 조회 (단말기ID)

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
date	-	Y	String	거래일자	일자 규격은 'YYYYMMDD'를 따름.
terminalId	-	Y	String	단말기 ID	-

호출구문

const API = axios.create({
        baseURL: `http://api.ubcn.co.kr/api`,
        headers: {
            "Access-Control-Allow-Origin": "*",
            "PER-ID": "{유출금지}",
            "PER-TOKEN": "{유출금지}",
        },
});

// {date}는 "YYYYMMDD" 규격, {terminalId}는 단말기 ID를 따릅니다.
const res = await API.post("/well/sales/{date}/terminal/{terminalId}");
console.log(res.data);

※ 응답 규격 및 예시는 상단의 [일일 거래내역 조회]와 동일합니다.

거래내역 일자범위 조회

Request Schema

요청에서 필요로 하는 필드는 다음과 같습니다.

필드명	상세필드명	필수	타입	설명	비고
startDate	-	Y	String	시작일자	일자 규격은 'YYYYMMDD'를 따름.
endDate	-	Y	String	종료일자	일자 규격은 'YYYYMMDD'를 따름.

호출구문

const API = axios.create({
        baseURL: `http://api.ubcn.co.kr/api`,
        headers: {
            "Access-Control-Allow-Origin": "*",
            "PER-ID": "{유출금지}",
            "PER-TOKEN": "{유출금지}",
        },
});

// {startDate}, {endDate}는 "YYYYMMDD" 규격을 따릅니다.
// 최대 1개월 범위 조회를 지원합니다.
const res = await API.post("/well/sales/range/{startDate}/{endDate}");
console.log(res.data);

※ 응답 규격 및 예시는 상단의 [일일 거래내역 조회]와 동일합니다.