POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
API Reference
계좌조회
Python
API Reference 계좌조회 Python 객체정보

A. 객체정보

Response

순번 변수명 타입 길이 비고
code int - API 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지

PopbillException

순번 변수명 타입 길이 비고
code int - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드
message str - API 처리 실패에 대한 오류메시지

EasyFinBankAccount

순번 변수명 타입 길이 비고
accountNumber str 30 계좌번호
bankCode str 4 기관코드
  • 0011농협
  • 0004국민은행
  • 0020우리은행
  • 0088신한은행
  • 0003기업은행
  • 0081하나은행
  • 0023SC은행
  • 0002산업은행
  • 0027씨티은행
  • 0031대구은행
  • 0032부산은행
  • 0039경남은행
  • 0034광주은행
  • 0037전북은행
  • 0035제주은행
  • 0071우체국
  • 0045새마을금고
  • 0048신협
  • 0007수협
accountName str 100 계좌 별칭
accountType str 2 계좌 유형
└ "법인" / "개인" 중 반환
state int 1 계좌 상태
└ 0 : (준비중) / 1 : (사용) / 2 : (정지) 중 반환
regDT str 14 팝빌에 계좌를 등록한 일시 (형식 : yyyyMMddHHmmss)
contractDT str 14 정액제 서비스 시작일시 (형식 : yyyyMMddHHmmss)
useEndDate str 8 정액제 서비스 종료일 (형식 : yyyyMMdd)
baseDate int 2 자동연장 결제일
└ 5 / 15 / 25 중 반환
contractState int 1 정액제 서비스 상태
└ 1 : (사용) / 2 : (해지) 중 반환
closeRequestYN Boolean - 정액제 서비스 해지신청 여부
└ true : (신청) / false : (미신청) 중 반환
useRestrictYN Boolean - 정액제 서비스 사용제한 여부
└ true : (제한) / false : (미제한) 중 반환
closeOnExpired Boolean - 정액제 서비스 만료시 해지 여부
└ true : (해지) / false : (미해지) 중 반환
unPaidYN Boolean - 미수금 보유 여부
└ true : (보유) / false : (미보유) 중 반환
memo str 200 메모
└ 계좌 등록시 입력한 메모 값

EasyFinBankAccountForm

순번 변수명 타입 길이 필수 비고
BankCode str 4 Y 기관코드
  • 0011농협
  • 0004국민은행
  • 0020우리은행
  • 0088신한은행
  • 0003기업은행
  • 0081하나은행
  • 0023SC은행
  • 0002산업은행
  • 0027씨티은행
  • 0031대구은행
  • 0032부산은행
  • 0039경남은행
  • 0034광주은행
  • 0037전북은행
  • 0035제주은행
  • 0071우체국
  • 0045새마을금고
  • 0048신협
  • 0007수협
AccountNumber str 30 Y 계좌번호
AccountPWD str 6 Y 계좌 비밀번호
AccountType str 2 Y 계좌 유형
└ "법인" / "개인" 중 택 1
IdentityNumber str 20 Y 예금주 식별정보
{AccountType} 값이 "법인" 인 경우
└ 사업자번호 입력 (10자)
{AccountType} 값이 "개인" 인 경우
└ 생년월일 입력 (6자 - 형식 : YYMMDD)
※ '-' 제외하고 입력
AccountName str 100 N 계좌 별칭
BankID str 200 조건부 인터넷뱅킹 아이디
└ 계좌가 국민은행일 경우 필수
FastID str 50 조건부 조회전용 계정 아이디
└ 계좌가 대구은행, 신협, 신한은행일 경우 필수
FastPWD str 50 조건부 조회전용 계정 비밀번호
└ 계좌가 대구은행, 신협, 신한은행일 경우 필수
UsePeriod int 2 N 정액제 이용할 개월수, 1~12 입력 가능
※ 미입력시 기본값 1개월처리
※ 파트너 포인트를 사용할 경우 입력값에 관계 없이 1개월 처리
Memo str 200 N 메모

EasyFinBankJobState

순번 변수명 타입 길이 비고
jobID str 18 작업아이디
└ [RequestJob - 수집 요청]의 반환 값
jobState str 1 수집 작업의 진행 상태 : "0" / "1" / "2" / "3" 중 반환
└ "0" : 접수
└ "1" : 대기
└ "2" : 진행
└ "3" : 완료
startDate str 8 시작일자
└ [RequestJob - 수집 요청] 사용시 입력한 SDate 값 (형식 : yyyyMMdd)
endDate str 8 종료일자
└ [RequestJob - 수집 요청] 사용시 입력한 EDate 값 (형식 : yyyyMMdd)
errorCode int - 수집 결과코드 : 1 또는 오류코드 반환
└ 1 : 수집성공
errorReason str - 오류메시지
└ 수집실패시 반환되는 사유
jobStartDT str 14 작업 시작일시 (형식 : yyyyMMddHHmmss)
jobEndDT str 14 작업 종료일시 (형식 : yyyyMMddHHmmss)
regDT str 14 수집 요청일시 (형식 : yyyyMMddHHmmss)

EasyFinBankSearchResult

순번 변수명 타입 길이 비고
code int - API 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
total int - 총 검색결과 건수
perPage int - 페이지 당 목록 개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
lastScrapDT str 14 최종 조회일시 (형식 : yyyyMMddHHmmss)
balance str 20 현재 잔액
list List<EasyFinBankSearchDetail> 거래내역 조회 목록
└ 최대 1000건

EasyFinBankSearchDetail

순번 변수명 타입 길이 비고
tid str 32 거래내역 아이디
└ 거래 내역에 대한 팝빌이 부여한 고유 식별값
trdate str 8 거래일자 (형식 : yyyyMMdd)
trserial int - 거래일련번호
└ 거래일자별 거래 내역 순번
trdt str 14 거래일시 (형식 : yyyyMMddHHmmss)
accIn str 20 입금액
accOut str 20 출금액
balance str 20 잔액
remark1 str 500 비고 1
└ 받는분 계좌번호

※ 기업은행 계좌에서 발생, 출금 발생 시 받는 분의 계좌번호
remark2 str 500 비고 2
└ 거래구분
remark3 str 500 비고 3
└ 적요
remark4 str 500 비고 4
└ 적요
regDT str 14 등록일시 (형식 : yyyyMMddHHmmss)
memo str 100 메모
└ [SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값

EasyFinBankSummary

순번 변수명 타입 길이 비고
count int - 수집 결과 건수
cntAccIn int - 입금거래 건수
cntAccOut int - 출금거래 건수
totalAccIn int - 입금액 합계
totalAccOut int - 출금액 합계

FlatRateState

순번 변수명 타입 길이 비고
referenceID str 18 계좌아이디
└ 팝빌이 계좌를 식별하는 값
contractDT str 14 정액제 서비스 시작일시 (형식 : yyyyMMddHHmmss)
useEndDate str 8 정액제 서비스 종료일자 (형식 : yyyyMMdd)
baseDate Short 2 자동연장 결제일
└ 5 / 15 / 25 중 반환
state Short 1 정액제 서비스 상태
└ 1 : (사용) / 2 : (해지) 중 반환
closeRequestYN Boolean - 정액제 서비스 해지신청 여부
└ true : (신청) / false : (미신청) 중 반환
useRestrictYN Boolean - 정액제 서비스 사용제한 여부
└ true : (제한) / false : (미제한) 중 반환
closeOnExpired Boolean - 정액제 서비스 만료시 해지 여부
└ true : (해지) / false : (미해지) 중 반환
unPaidYN Boolean - 미수금 보유 여부
└ true : (보유) / false : (미보유) 중 반환

UseHistoryResult

순번변수명타입길이비고
code int - API 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
list List<UseHistory> 사용내역

UseHistory

순번변수명타입길이비고
itemCode str 3 서비스 코드
  • 110세금계산서
  • 111홈택스연동(세금)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
  • 140현금영수증
  • 141홈택스연동(현금)
  • 150문자(SMS)
  • 151문자(LMS)
  • 152문자(MMS)
  • 153알림톡
  • 154친구톡(텍스트)
  • 155친구톡(이미지)
  • 160팩스(일반망)
  • 161팩스(지능망)
  • 170휴폐업조회
  • 171기업정보조회
  • 180계좌조회
  • 182계좌성명조회
  • 183계좌실명조회
txType str 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
txPoint str 18 증감 포인트
balance str 18 잔여포인트
txDT str 14 포인트 증감 일시 (형식 : yyyyMMddHHmmss)
userID str 50 담당자 아이디
userName str 100 담당자명

PaymentHistoryResult

순번변수명타입길이비고
code int - API 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
list List<PaymentHistory> 결제내역

PaymentHistory

순번변수명타입길이비고
productType str 3 결제 내용 : "포인트" / "정액제" / "미수금" 중 반환
productName str 30 결제 상품명
settleType str 7 결제유형 : "무통장" / "신용카드" / "실시간계좌이체" 중 반환
settlerName str 100 담당자명
settlerEmail str 100 담당자메일
settleCost str 18 결제금액
settlePoint str 18 충전포인트
settleState int 1 결제상태 : 1 / 2 / 3 / 4 / 5 중 반환
└ 1 : 대기
└ 2 : 승인
└ 3 : 실패
└ 4,5 : 취소
regDT str 14 등록일시 (형식 : yyyyMMddHHmmss)
stateDT str 14 상태일시 (형식 : yyyyMMddHHmmss)

RefundHistoryResult

순번변수명타입길이비고
code int - API 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
list List<RefundHistory> 환불내역

RefundHistory

순번변수명타입길이비고
reqDT str 14 신청일시 (형식 : yyyyMMddHHmmss)
requestPoint str 18 환불 신청포인트
accountBank str 10 환불계좌 은행명
accountNum str 50 환불계좌번호
accountName str 70 환불계좌 예금주명
state int 1 상태
└ 1 : 접수대기
└ 2 : 심사중
└ 3 : 입금대기
└ 4 : 환불완료
└ 5 : 취소
reason str 200 환불사유

RefundForm

순번변수명타입길이필수비고
ContactName str 100 Y 담당자명
tel str 20 Y 담당자 연락처
RequestPoint str 18 Y 환불 신청 포인트
AccountBank str 10 Y 은행명
AccountNum str 50 Y 계좌번호
AccountName str 70 Y 예금주명
Reason str 200 N 환불사유

PaymentForm

순번변수명타입길이필수비고
settlerName str 100 N 담당자명
settlerEmail str 100 N 담당자 이메일
notifyHP str 20 N 담당자 휴대폰
└ 무통장 입금 승인 알림톡이 전송될 번호
paymentName str 70 Y 입금자명
settleCost str 18 Y 결제금액

PaymentResponse

순번변수명타입길이비고
code int - 응답코드
message str - 응답메시지
settleCode str 18 정산코드

ChargeInfo

순번 변수명 타입 길이 비고
unitCost str - 요금
chargeMethod str 3 과금유형 : "연동" / "파트너" 중 반환
rateSystem str 3 "정액제" / "종량제" 반환

JoinForm

순번 변수명 타입 길이 필수 비고
ID str 50 Y 아이디
└ 6자 이상 50자 이하
Password str 20 Y 비밀번호
└ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
LinkID str 20 Y 파트너 링크아이디
└ 연동신청시 팝빌에서 발급받은 링크아이디
CorpNum str 10 Y 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
CEOName str 100 Y 대표자 성명
CorpName str 200 Y 회사명
Addr str 300 Y 사업장 주소
BizType str 100 Y 업태
BizClass str 100 Y 종목
ContactName str 100 Y 담당자 성명
ContactEmail str 100 Y 담당자 이메일
ContactTEL str 20 Y 담당자 휴대폰

CorpInfo

순번 변수명 타입 길이 필수 비고
ceoname str 100 Y 대표자 성명
corpName str 200 Y 회사명
addr str 300 Y 주소
bizType str 100 Y 업태
bizClass str 100 Y 종목

ContactInfo

순번 변수명 타입 길이 필수 비고
id str 50 Y 아이디
└ 6자 이상 50자 이하
Password str 20 조건부 비밀번호
└ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
personName str 100 Y 담당자 성명
tel str 20 Y 담당자 휴대폰
email str 100 Y 담당자 이메일
regDT str 14 X 등록일시 (형식 : yyyyMMddHHmmss)
searchRole int 1 N 담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한
└ 2 : 읽기권한
└ 3 : 회사권한
mgrYN Boolean - X 관리자 여부 : true / false 중 반환
└ true : 관리자
└ false : 담당자
└ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state int 1 X 계정상태 : 1 반환
└ 1 : 사용중

RefundResponse

순번 변수명 타입 길이 비고
code int - API 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
refundCode str 18 환불코드