실시간 거래 조회 API
결제수단 별 단건 거래상태를 실시간으로 조회하는 API입니다.
테스트용 키 정보
API 정보
POST/spay/APITrdcheck.do
Content-Type
application/json테스트
https://tbgw.settlebank.co.kr/spay/APITrdcheck.do운영
https://gw.settlebank.co.kr/spay/APITrdcheck.do주의 사항
NOTE
실시간 거래 조회 안내
원 거래 일자는 조회하고자 하는 원 거래 번호의 요청 당시 일자를 입력합니다. 해당 거래일 기준 전일 ~ 익일 사이 거래 건을 조회할 수 있습니다.
- 원 거래 번호가 확인되는 경우 원 거래 번호를 추가 전달하면 정확한 조회가 가능합니다.
- Server to Server로 HTTP Connection하여 JSON 데이터로 POST 요청합니다.
요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*헥토파이낸셜에서 부여하는 고유 상점아이디
헥토파이낸셜에서 부여하는 고유 상점아이디
nx_mid_il: 가상계좌 테스트└verAN(4)영문+숫자, 최대 4byte*전문의 버전
전문의 버전
*고정값
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점에서 생성하는 고유한 거래번호
상점에서 생성하는 고유한 거래번호
└trdDtN(8)숫자, 최대 8byte*요청일자 (YYYYMMDD)
요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*요청시간 (HHMMSS)
요청시간 (HHMMSS)
data 객체
└pktHashAN(64)영문+숫자, 최대 64byte*
SHA-256SHA256 방식으로 생성한 해쉬값(실시간 생성)SHA256 방식으로 생성한 해쉬값
NOTE
해쉬 생성 조합
trdDt + trdTm + mchtId + mchtTrdNo + trdAmt(평문) + hashKey
└methodA(2)영문, 최대 2byte*결제수단 2자리
결제수단 2자리
CA: 신용카드 RA: 계좌이체 MP: 휴대폰결제 VA: 가상계좌 TC: 틴캐시 CG: 컬처랜드상품권(컬처캐쉬) CP: 포인트다모아 BG: 도서상품권 TM: 티머니 SG: 스마트문상 WL: 화이트라벨 KP: 카카오페이 NP: 네이버페이 PC: 페이코 TS: 토스페이└trdAmtN(12)숫자, 최대 12byte*거래금액 (1,000원 -> 1000)
거래금액 (1,000원 -> 1000)
└orgTrdDtN(8)숫자, 최대 8byte*원거래 결제 요청시 요청일자 (YYYYMMDD)
원거래 결제 요청시 요청일자 (YYYYMMDD)
└orgMchtTrdNoAN(100)영문+숫자, 최대 100byte*원거래의 상점주문번호
원거래의 상점주문번호
└orgTrdNoAN(40)영문+숫자, 최대 40byte결제 시 헥토파이낸셜에서 발급한 거래번호
결제 시 헥토파이낸셜에서 발급한 거래번호
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*상점아이디
nx_mid_il상점아이디
└verAN(4)영문+숫자, 최대 4byte*전문의 버전
0A1M전문의 버전
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*요청시의 주문번호 bypass
ORDER20211231100000요청시의 주문번호 bypass
└trdNoAN(40)영문+숫자, 최대 40byte*헥토파이낸셜 거래번호
STFP_PGHMnx_mid_il00220623130711M1872705헥토파이낸셜 거래번호
└trdDtN(8)숫자, 최대 8byte*요청일자 (YYYYMMDD)
20211231요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*요청시간 (HHMMSS)
100000요청시간 (HHMMSS)
└outStatCdAN(4)영문+숫자, 최대 4byte*조회 API 처리 상태 (요청 자체의 성공/실패)
0021조회 API 처리 상태 (요청 자체의 성공/실패)
0021: 조회 성공 0031: 조회 실패*조회된 거래의 성공/실패가 아니라, 조회 요청이 정상 처리되었는지를 나타냅니다. 조회 대상 거래의 실제 상태는 outRsltCd로 확인하세요.
└outRsltCdAN(4)영문+숫자, 최대 4byte*조회된 거래의 실제 상태 (결과코드)
0000조회된 거래의 실제 상태 (결과코드)
0000: 정상거래 (가상계좌는 입금성공) 0001: 취소상태 (가상계좌는 환불상태) 0009: 결제실패 (결제실패내역 존재)*outStatCd가 성공(0021)일 때는 조회 대상 거래의 실제 상태를 나타내고, 실패(0031)일 때는 조회 실패 사유(오류코드)가 내려갑니다.
└outRsltMsgAHN(200)영문+한글+숫자, 최대 200byte*결과메시지
정상거래결과메시지
data 객체
└pktHashAN(64)영문+숫자, 최대 64byte*요청시 hash 값 그대로 return
f395b6725a9a18...요청시 hash 값 그대로 return
└methodA(2)영문, 최대 2byte*결제수단 2자리
VA결제수단 2자리
└trdAmtN(12)숫자, 최대 12byte*거래금액
1000거래금액
└cnclAmtN(12)숫자, 최대 12byte취소금액 (취소 건 미존재 시 0원)
1000취소금액 (취소 건 미존재 시 0원)
요청 예시
{
"params": {
"mchtId": "nx_mid_il",
"ver": "0A1M",
"mchtTrdNo": "PG_vbank_20210806075154649",
"trdDt": "20210806",
"trdTm": "080101"
},
"data": {
"pktHash": "996E651D9435700D54E0D69B5726B5489AD0691C3FC86BE572314D39A2AE8B6D",
"method": "VA",
"trdAmt": "500",
"orgTrdDt": "20210806",
"orgMchtTrdNo": "PG_vbank_20210806075154648",
"orgTrdNo": "STFP_PGVAnx_mid_il00210806075210M1853381"
}
}
결제수단 코드
| 코드 | 결제수단 |
|---|---|
| BG | 도서상품권 |
| CG | 컬처랜드상품권(컬처캐쉬) |
| TC | 틴캐시 |
| CP | 포인트다모아 |
| WL | 화이트라벨 |
| CA | 신용카드 |
| MP | 휴대폰결제 |
| RA | 계좌이체 |
| VA | 가상계좌 |
| TM | 티머니 |
| SG | 스마트문상 |
| KP | 카카오페이 |
| NP | 네이버페이 |
| PC | 페이코 |
| TS | 토스페이 |
