자금반환청구 확인 API
가맹점 서버에서 헥토파이낸셜 서버로 자금반환청구 진행 상황을 조회합니다.
'자금반환청구 요청' API로 요청한 건에 대한 진행 상황을 확인할 수 있습니다.
API 정보
POST/v2/api/fundsReturn/check
Content-Type
application/json테스트
https://tbnpay.settlebank.co.kr/v2/api/fundsReturn/check운영
https://npay.settlebank.co.kr/v2/api/fundsReturn/check요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└hdInfoAN(50)영문+숫자, 최대 50byte*전문정보 코드
전문정보 코드
*고정값
└mchtIdAN(8)영문+숫자, 최대 8byte*헥토파이낸셜에서 부여하는 고유 상점아이디
헥토파이낸셜에서 부여하는 고유 상점아이디
└reqDtAN(8)영문+숫자, 최대 8byte*요청일자
요청일자
*YYYYMMDD
└reqTmAN(6)영문+숫자, 최대 6byte*요청시간
요청시간
*HH24MISS
└ornMchtTrdNoAN(100)영문+숫자, 최대 100byte*원 상점주문번호
원 상점주문번호
*한글제외. 자금반환청구 요청시 사용한 주문번호
└pktHashAN(200)영문+숫자, 최대 200byte*
SHA-256SHA256 방식으로 생성한 해쉬값(실시간 생성)SHA256 방식으로 생성한 해쉬값
*상점아이디 + 요청일자 + 요청시간 + 원 상점주문번호 + 인증키
요청 전문 해쉬 코드
| 항목 | 조합 필드 |
|---|---|
| pktHash 값 | 상점아이디 + 요청일자 + 요청시간 + 원 상점주문번호 + 인증키 |
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└outStatCdAN(4)영문+숫자, 최대 4byte*거래상태코드 (성공/실패)
거래상태코드 (성공/실패)
0021: 성공 0031: 실패└outRsltCdAN(4)영문+숫자, 최대 4byte*거절코드
거절코드
*거절코드 테이블 참조
└outRsltMsgAN(300)영문+숫자, 최대 300byte*결과메시지
정상처리되었습니다.결과메시지
*오류가 발생시 오류에 대한 메시지 전달
└trdNoAN(40)영문+숫자, 최대 40byte*헥토파이낸셜 거래번호
STFP_FIRM20230330095423555헥토파이낸셜 거래번호
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점 주문번호
OID20230330095512450상점 주문번호
*한글제외
└prgStatCdAN(2)영문+숫자, 최대 2byte*진행상태코드
진행상태코드
01: 접수 02: 진행중 03: 완료 04: 거부 05: 취소*자금반환청구 진행 상태
└prgStatMsgAN(100)영문+숫자, 최대 100byte진행상태 메시지
자금반환청구가 접수되었습니다.진행상태 메시지
*진행 상태에 대한 상세 메시지
└rtnAmtN(13)숫자, 최대 13byte반환금액
1000반환금액
*실제 반환된 금액 (완료시)
└rtnDtAN(8)영문+숫자, 최대 8byte반환일자
20230331반환일자
*YYYYMMDD. 반환 완료 일자
요청 예시
{
"hdInfo": "SPAY_FC0W_1.0",
"mchtId": "midtest",
"reqDt": "20230330",
"reqTm": "095512",
"ornMchtTrdNo": "OID201902210001",
"pktHash": "해시값"
}
응답 예시
{
"outStatCd": "0021",
"outRsltCd": "0000",
"outRsltMsg": "정상처리되었습니다.",
"trdNo": "STFP_FIRM20230330095423555",
"mchtTrdNo": "OID20230330095512450",
"prgStatCd": "03",
"prgStatMsg": "자금반환청구가 완료되었습니다.",
"rtnAmt": "1000",
"rtnDt": "20230331"
}
