POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

EasyFinBankAccount

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

EasyFinBankAccountForm

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

EasyFinBankJobState

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

EasyFinBankSearchResult

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

EasyFinBankSearchDetail

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

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

EasyFinBankSummary

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

EasyFinBankFlatRate

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

ChargeInfo

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

JoinForm

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

CorpInfo

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

Contact

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