계좌 관리

1. RegistBankAccount - 계좌 등록

계좌조회 서비스를 이용할 계좌를 팝빌에 등록합니다.

def registBankAccount(CorpNum, AccountInfo, UserID=None)

계좌를 등록할 때 결제기간만큼 포인트가 차감됩니다. 단, 파트너 포인트를 이용하는 경우에는 1개월 요금이 과금됩니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	AccountInfo	EasyFinBankAccountForm	-	Y	계좌 정보
EasyFinBankAccountForm 순번 변수명 타입 길이 필수 설명 1 BankCode str 4 Y 은행 기관코드 → [참고] 조회 가능한 금융기관 2 AccountNumber str 30 Y 계좌번호 3 AccountPWD str 4 Y 계좌 비밀번호 4 AccountType str 2 Y 계좌 유형 법인 개인 5 IdentityNumber str 10 Y 실명번호 ('-' 제외) → {AccountType}="법인" 경우 사업자번호 {AccountType}="개인" 경우 생년월일 (형식 : yyMMdd) 6 AccountName str 100 N 계좌 별칭 7 BankID str 50 조건부 인터넷뱅킹 아이디 → {BankCode}="0004"(국민은행) 경우 필수 8 FastID str 50 조건부 조회전용 계정 아이디 → {BankCode}="0031"(아이엠뱅크) or "0088"(신한은행) or "0048"(신협중앙회) 경우 필수 9 FastPWD str 50 조건부 조회전용 계정 비밀번호 → {BankCode}="0031"(아이엠뱅크) or "0088"(신한은행) or "0048"(신협중앙회) 경우 필수 10 UsePeriod int 2 N 정액제 이용할 개월수 1 1개월 : 기본값 2 2개월 3 3개월 4 4개월 5 5개월 6 6개월 7 7개월 8 8개월 9 9개월 10 10개월 11 11개월 12 12개월 → 파트너 포인트 사용시 입력값에 관계 없이 기본값 적용 11 Memo str 200 N 메모
3	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

2. UpdateBankAccount - 계좌정보 수정

팝빌에 등록된 계좌정보를 수정합니다.

def updateBankAccount(CorpNum, AccountInfo, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	AccountInfo	BankAccountInfo	-	Y	수정할 계좌 정보
3	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

3. GetBankAccountInfo - 계좌정보 확인

팝빌에 등록된 계좌 정보를 확인합니다.

def getBankAccountInfo(CorpNum, BankCode, AccountNumber, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	BankCode	str	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	AccountNumber	str	30	Y	계좌번호
4	UserID	str	50	N	팝빌회원 아이디

응답

EasyFinBankAccount

순번	변수명	타입	길이	설명
1	accountNumber	str	30	계좌번호
2	bankCode	str	4	은행 기관코드 → [참고] 조회 가능한 금융기관
3	accountName	str	100	계좌 별칭
4	accountType	str	2	계좌 유형 법인 개인
5	state	int	1	계좌 상태 1 사용 2 정지
6	regDT	str	14	팝빌에 계좌를 등록한 일시 → 형식 : yyyyMMddHHmmss
7	contractDT	str	14	정액제 서비스 시작일시 → 형식 : yyyyMMddHHmmss
8	useEndDate	str	8	정액제 서비스 만료일자 → 형식 : yyyyMMdd
9	baseDate	int	2	자동연장 결제일 5 15 25
10	contractState	int	1	정액제 서비스 상태 1 사용 또는 사용제한 2 해지
11	closeRequestYN	bool	-	정액제 서비스 해지신청 여부 True 신청 False 미신청
12	useRestrictYN	bool	-	정액제 서비스 사용제한 여부 True 사용제한 False 사용
13	closeOnExpired	bool	-	정액제 서비스 해지 구분 True 일반해지 (정액제 서비스 만료일 해지) False 중도해지 (요청 즉시 해지)
14	unPaidYN	bool	-	미수금 보유 여부 True 보유 False 미보유
15	memo	str	200	메모

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

4. ListBankAccount - 계좌정보 목록 조회

팝빌에 등록된 계좌정보 목록을 반환합니다.

def listBankAccount(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	str	50	N	팝빌회원 아이디

응답

list[EasyFinBankAccount]

순번	변수명	타입	길이	설명
1	accountNumber	str	30	계좌번호
2	bankCode	str	4	은행 기관코드 → [참고] 조회 가능한 금융기관
3	accountName	str	100	계좌 별칭
4	accountType	str	2	계좌 유형 법인 개인
5	state	int	1	계좌 상태 1 사용 2 정지
6	regDT	str	14	팝빌에 계좌를 등록한 일시 → 형식 : yyyyMMddHHmmss
7	contractDT	str	14	정액제 서비스 시작일시 → 형식 : yyyyMMddHHmmss
8	useEndDate	str	8	정액제 서비스 만료일자 → 형식 : yyyyMMdd
9	baseDate	int	2	자동연장 결제일 5 15 25
10	contractState	int	1	정액제 서비스 상태 1 사용 또는 사용제한 2 해지
11	closeRequestYN	bool	-	정액제 서비스 해지신청 여부 True 신청 False 미신청
12	useRestrictYN	bool	-	정액제 서비스 사용제한 여부 True 사용제한 False 사용
13	closeOnExpired	bool	-	정액제 서비스 해지 구분 True 일반해지 (정액제 서비스 만료일 해지) False 중도해지 (요청 즉시 해지)
14	unPaidYN	bool	-	미수금 보유 여부 True 보유 False 미보유
15	memo	str	200	메모

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

5. GetBankAccountMgtURL - 계좌 등록 팝업 URL

미리보기

계좌를 등록하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,550px (최소 800px) / height = 680px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

def getBankAccountMgtURL(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	str	50	N	팝빌회원 아이디

응답

str - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

6. CloseBankAccount - 정액제 해지요청

팝빌에 등록된 계좌의 정액제 해지를 요청합니다.

def closeBankAccount(CorpNum, BankCode, AccountNumber, CloseType, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	BankCode	str	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	AccountNumber	str	30	Y	계좌번호
4	CloseType	str	2	Y	정액제 해지 구분 일반 해지 요청일이 포함된 정액제 이용기간 만료 후 해지
5	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

7. RevokeCloseBankAccount - 정액제 해지요청 취소

신청한 정액제 해지요청을 취소합니다.

def revokeCloseBankAccount(CorpNum, BankCode, AccountNumber, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	BankCode	str	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	AccountNumber	str	30	Y	계좌번호
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

8. DeleteBankAccount - 계좌 삭제

등록된 계좌를 삭제합니다.

def deleteBankAccount(CorpNum, BankCode, AccountNumber, UserID=None)

정액제가 아닌 종량제 이용 시에만 등록된 계좌를 삭제할 수 있습니다.
정액제 이용시 [CloseBankAccount – 정액제 해지요청] 함수를 사용하여 정액제를 해지할 수 있습니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	BankCode	str	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	AccountNumber	str	30	Y	계좌번호
4	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지