출금동의 API

웹사이트 또는 모바일로 신청한 자동이체 내역을 확인하고 패스 앱으로 전자서명하여 출금동의 증빙자료로 이용할 수 있는 패스 자동이체 출금동의 API 입니다. 개발하는 웹/앱 방식에 따라 패스 앱으로 푸시(Push) 인증 메시지를 전송하여 인증하는 “푸시(Push) 인증”과 이용기관 앱에서 패스 앱을 실행하여 패스 인증 메시지 전송없이 비밀번호 입력만으로 인증하는 “앱투앱 인증” 방식 중 선택하여 연동할 수 있습니다.

자동이체 출금동의 증빙자료의 금융결제원 제출, 자동이체 출금은 이용기관에서 직접 처리해야 합니다.
전자서명 당사자와 자동이체 출금계좌 예금주의 동일인 체크 의무는 이용기관에게 있습니다.

자동이체 출금동의 증빙자료 금융결제원 제출방법은 어떻게 되나요?

1) 자동이체 출금동의 검증(VerifyCMS) 함수로 객체의 변수 "signedData"값을 반환받습니다.
2) 반환받은 "signedData"값을 base64 방식으로 디코딩합니다.
3) 디코딩 후 binary형식으로 구성된 der확장자 파일을 금융결제원에 제출합니다.

1. RequestCMS - 자동이체 출금동의 요청

패스 이용자에게 자동이체 출금동의를 요청합니다.
앱투앱 인증 방식을 이용하는 이용기관은 [앱스킴 호출] 을 참고하여 주시기 바랍니다.

def requestCMS(clientCode, cms)

Parameter

순번	변수명	타입	길이	필수	설명
	clientCode	String	12	Y	이용기관 코드
	cms	CMS	-	Y	자동이체 출금동의 요청 정보

Return CMSReceipt Throws BarocertException

2. GetCMSStatus - 자동이체 출금동의 상태확인

자동이체 출금동의 요청 후 반환받은 접수아이디로 인증 진행 상태를 확인합니다.
상태확인 함수는 자동이체 출금동의 요청 함수를 호출한 당일 23시 59분 59초까지만 호출 가능합니다.
자동이체 출금동의 요청 함수를 호출한 당일 23시 59분 59초 이후 상태확인 함수를 호출할 경우 오류가 반환됩니다.

def getCMSStatus(clientCode, receiptID)

Parameter

순번	변수명	타입	길이	필수	설명
	clientCode	String	12	Y	이용기관 코드
	receiptID	String	32	Y	접수 아이디

Return CMSStatus Throws BarocertException

3. VerifyCMS - 자동이체 출금동의 검증

완료된 전자서명을 검증하고 전자서명값(signedData)을 반환 받습니다.
검증 함수는 자동이체 출금동의 요청 함수를 호출한 당일 23시 59분 59초까지만 호출 가능합니다.
자동이체 출금동의 요청 함수를 호출한 당일 23시 59분 59초 이후 검증 함수를 호출할 경우 오류가 반환됩니다.
패스 보안정책에 따라 검증 API는 1회만 호출할 수 있습니다. 재시도시 오류가 반환됩니다.

이용기관 서버에서는 출금동의 검증을 통해 반환받은 이용자의 개인정보(CI, 성명, 생년월일 등)와 전자서명을 요청한 이용자의 개인정보를 비교해 올바른 이용자인지 검증해야 합니다.

def verifyCMS(clientCode, receiptID, cmsVerify)

Parameter

변수명	타입	길이	필수	설명
clientCode	String	12	Y	이용기관 코드
receiptID	String	32	Y	접수 아이디
cmsVerify	CMSVerify	-	Y	출금동의 서명검증 요청정보

Return CMSResult Throws BarocertException

4. 앱스킴 호출

4.1 Android

자동이체 출금동의를 요청하기 위하여 이용기관은 이용기관 App 에서 패스 App 앱스킴을 호출합니다.
패스 App 앱스킴 호출시 입력한 callbackScheme으로 이용자의 전자서명 결과값 [ResponseCode]를 반환 받습니다.

{scheme}&callbackScheme={clientAppScheme}&packageName={clientPackageName}

Parameter

변수명	타입	길이	필수	설명
scheme	String	-	Y	자동이체 출금동의 요청시 반환된 앱스킴
clientAppScheme	String	-	Y	패스 앱 인증완료 후 호출될 이용기관 앱스킴
clientPackageName	String	-	Y	패스 앱 인증완료 후 호출될 이용기관 앱패키지명

Return {clientAppScheme}://?code={ResponseCode}

4.2 iOS

자동이체 출금동의를 요청하기 위하여 이용기관은 이용기관 App 에서 패스 App 앱스킴을 호출합니다.
패스 App 앱스킴 호출시 입력한 callbackScheme으로 이용자의 전자서명 결과값 [ResponseCode]를 반환 받습니다.

{scheme}&callbackScheme={clientAppScheme}

Parameter

순번	변수명	타입	길이	필수	설명
	scheme	String	-	Y	자동이체 출금동의 요청시 반환된 앱스킴
	clientAppScheme	String	-	Y	패스 앱 인증완료 후 호출될 이용기관 앱스킴

Return {clientAppScheme}://?code={ResponseCode}

4.3 ResponseCode

순번	code	설명
	E0000	성공
	E3001	패스 서비스 미가입자
	E3002	패스 인증서 미발급자
	E3003	사용자 인증 시 취소 또는 서명 과정 중 취소
	E3004	사용자 인증 시 인증 실패 (생체 인증 실패 등)
	E3005	단말 네트워크 환경 등으로 인한 통신 실패
	E3006	통신사 서버에서 에러 발생
	E3007	인증서 Library 서명에서 에러 발생
	E3999	기타 오류

5. 객체정보

5.1. BarocertException

순번	변수명	타입	길이	필수	설명
	Code	Integer	-	Y	API 처리에 대한 응답코드
	message	String	-	Y	API 처리에 대한 응답메시지

5.2. CMS

변수명	타입	길이	필수	설명
receiverHP	String	11	Y	수신자 휴대폰번호 → 하이픈(-) 제외하고 입력
receiverName	String	80	Y	수신자 성명
receiverBirthday	String	8	N	수신자 생년월일 → 형식: yyyyMMdd
reqTitle	String	40	Y	인증요청 메시지 제목
reqMessage	String	500	Y	인증요청 메시지 내용
callCenterNum	String	11	Y	이용기관 연락처
expireIn	Integer	4	Y	요청 만료시간 → 최대: 1000초(s) / 권장: 300초(s)
userAgreementYN	Boolean	-	N	사용자 동의 필요 여부 └True필요 └False불필요 : 기본값
receiverInfoYN	Boolean	-	N	사용자 정보 포함 여부 └True포함 : 기본값 └False불포함
bankName	String	100	Y	출금은행명
bankAccountNum	String	31	Y	출금계좌번호
bankAccountName	String	100	Y	출금계좌 예금주명
bankServiceType	String	9	Y	서비스 종류 └CMSCMS └OPEN_BANK오픈뱅킹
bankWithdraw	String	-	조건부	출금액 → {bankServiceType}="CMS" 인 경우 필수
appUseYN	Boolean	-	N	앱투앱 인증 방식 이용 여부 └True앱투앱 인증[앱스킴 호출] └False푸시(Push) 인증 : 기본값
telcoType	String	3	조건부	통신사 유형 └SKT └KT └LGU appUseYN=True 경우 필수
deviceOSType	String	7	조건부	모바일장비 운영체제 └ANDROID └IOS appUseYN=True 경우 필수

5.3. CMSVerify

순번	변수명	타입	길이	필수	설명
	receiverHP	String	11	Y	수신자 휴대폰번호 → 하이픈(-) 제외하고 입력
	receiverName	String	80	Y	수신자 성명

5.4. CMSReceipt

변수명	타입	길이	필수	설명
receiptID	String	32	Y	접수아이디
scheme	String	-	N	앱스킴 appUseYN=True 경우 반환
marketUrl	String	-	N	앱 다운로드 URL appUseYN=True 경우 반환

5.5. CMSStatus

변수명	타입	길이	필수	설명
receiptID	String	32	Y	접수아이디
clientCode	String	12	Y	이용기관 코드
state	Integer	1	Y	상태 └0대기 └1완료 └2만료 └3거절 └4실패 └5미처리
requestDT	String	14	Y	전자서명 요청일시 → 형식: yyyyMMddHHmmss
completeDT	String	14	N	전자서명 완료일시 → 형식: yyyyMMddHHmmss
expireDT	String	14	Y	전자서명 만료일시 → 형식: yyyyMMddHHmmss
rejectDT	String	14	N	전자서명 거절일시 → 형식: yyyyMMddHHmmss

5.6. CMSResult

변수명	타입	길이	필수	설명
receiptID	String	32	Y	접수아이디
state	Integer	1	Y	상태 └0대기 └1완료 └2만료 └3거절 └4실패 └5미처리
receiverHP	String	11	N	RSA 암호화 수신자 휴대폰번호 → 하이픈(-) 제외하고 입력 receiverInfoYN=True 경우 반환
receiverName	String	80	N	RSA 암호화 수신자 성명 receiverInfoYN=True 경우 반환
receiverYear	String	4	N	RSA 암호화 수신자 출생년도 → 형식 : yyyy receiverInfoYN=True 경우 반환
receiverDay	String	4	N	RSA 암호화 수신자 출생월일 → 형식 : MMdd receiverInfoYN=True 경우 반환
receiverGender	String	1	N	RSA 암호화 수신자 성별 └M남성 └F여성 receiverInfoYN=True 경우 반환
receiverForeign	String	1	N	RSA 암호화 외국인 여부 └Y외국인 └N내국인 receiverInfoYN=True 경우 반환
receiverTelcoType	String	3	N	RSA 암호화 통신사 유형 └SKT └KT └LGU receiverInfoYN=True 경우 반환
signedData	String	-	Y	전자서명값
ci	String	-	Y	RSA 암호화 CI