정기결제 API
정기결제 승인, 해지 및 관련 정보/내역 조회를 제공합니다.
※ 정기결제 키는 최초 결제 요청 시 rglPmtYn: Y 옵션이나 별도 키 발행 프로세스를 통해 발급받을 수 있습니다.
정기결제 승인
발급받은 정기결제 키를 사용하여 결제를 요청합니다.
API 정보
POST/v1/api/regular/confirm
Content-Type
application/json; charset=UTF-8테스트
https://tbnpay.settlebank.co.kr/v1/api/regular/confirm운영
https://npay.settlebank.co.kr/v1/api/regular/confirm요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└hdInfoAN(50)영문+숫자, 최대 50byte*전문정보 코드
전문정보 코드
*고정값
└mchtIdAN(8)영문+숫자, 최대 8byte*상점아이디
상점아이디
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점 주문번호 (한글 제외)
상점 주문번호 (한글 제외)
└mchtCustIdAN(100)영문+숫자, 최대 100byte*
AES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)고객아이디고객아이디
└reqDtAN(8)영문+숫자, 최대 8byte*요청일자 (yyyyMMdd)
요청일자 (yyyyMMdd)
└reqTmAN(6)영문+숫자, 최대 6byte*요청시간 (HH24MISS)
요청시간 (HH24MISS)
└trdAmtN(13)숫자, 최대 13byte*거래금액
거래금액
└rglChrgKeyAN(32)영문+숫자, 최대 32byte*정기결제 키
정기결제 키
└splAmtN(13)숫자, 최대 13byte공급가액
공급가액
└vatN(13)숫자, 최대 13byte부가세
부가세
└svcAmtN(13)숫자, 최대 13byte봉사료
봉사료
└pmtPrdtNmAN(50)영문+숫자, 최대 50byte결제상품명
결제상품명
└custAcntSumryAN(7)영문+숫자, 최대 7byte통장인자내용
통장인자내용
└csrslssReqYnA(1)영문, 최대 1byte현금영수증 발행여부
현금영수증 발행여부
└csrcIssPsblYnA(1)영문, 최대 1byte현금영수증 발행가능 여부
현금영수증 발행가능 여부
└taxTypeCdA(1)영문, 최대 1byte면세여부 (csrslssReqYn Y 발행일 경우 필수)
면세여부 (csrslssReqYn Y 발행일 경우 필수)
Y: 면세 N: 과세└csrcReqPrposYnN(1)숫자, 최대 1byte현금영수증 용도구분 (csrslssReqYn Y 발행일 경우 필수)
현금영수증 용도구분 (csrslssReqYn Y 발행일 경우 필수)
0: 소득공제 1: 지출증빙└csrcRegNoDivCdN(1)숫자, 최대 1byte현금영수증 발행정보구분 (csrslssReqYn Y 발행일 경우 필수)
현금영수증 발행정보구분 (csrslssReqYn Y 발행일 경우 필수)
1: 카드 2: 주민등록번호 3: 사업자등록번호 4: 휴대폰번호└csrcRegNoAN(20)영문+숫자, 최대 20byte
AES-256AES-256/ECB/PKCS5Padding + Base64 (Standard)현금영수증 발행정보 (csrslssReqYn Y 발행일 경우 필수)현금영수증 발행정보 (csrslssReqYn Y 발행일 경우 필수)
*csrcRegNoDivCd 값에 따른 실제값
└cupDepositAmtN(13)숫자, 최대 13byte컵보증금
컵보증금
└addDdtTypeCdA(1)영문, 최대 1byte추가공제 구분 (csrslssReqYn Y 발행일 경우 필수)
추가공제 구분 (csrslssReqYn Y 발행일 경우 필수)
Y: 대중교통 C: 도서공연비└custIpAN(15)영문+숫자, 최대 15byte고객 IP 주소
고객 IP 주소
└pktHashAN(200)영문+숫자, 최대 200byte*
SHA-256SHA-256 해쉬값(실시간 생성)SHA-256 해쉬값
NOTE
해쉬 생성 조합
mchtId + mchtCustId + reqDt + reqTm + trdAmt(평문) + rglChrgKey + hashKey
응답 파라미터
└outStatCdAN(4)영문+숫자, 최대 4byte*거래상태코드
0021거래상태코드
0021: 성공 0031: 실패└outRsltCdAN(4)영문+숫자, 최대 4byte*거절코드
0000거절코드
└outRsltMsgAN(300)영문+숫자, 최대 300byte*결과메시지
정상처리되었습니다.결과메시지
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점 주문번호
OID201902210001상점 주문번호
└trdNoAN(40)영문+숫자, 최대 40byte거래번호
STFP_FIRM12345678901234567890거래번호
└rglPmtProcStatCdA(1)영문, 최대 1byte정기결제 처리상태
정기결제 처리상태
R: 정기결제 재처리 필요 C: 정기결제 해지대상└trdAmtN(13)숫자, 최대 13byte거래금액
1000거래금액
└svcDivCdN(4)숫자, 최대 4byte결제시 사용된 서비스
1결제시 사용된 서비스
1: 펌뱅킹
