POPBill Developers
API Reference

A. 객체정보

Response

순번변수명타입길이설명
code int - API 처리에 대한 응답코드
1성공
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 bool - 정액제 서비스 해지신청 여부
True신청
False미신청
useRestrictYN bool - 정액제 서비스 사용제한 여부
True사용제한
False사용
closeOnExpired bool - 정액제 서비스 해지 구분
True일반해지 (정액제 서비스 만료일 해지)
False중도해지 (요청 즉시 해지)
unPaidYN bool - 미수금 보유 여부
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 4 Y 계좌 비밀번호
AccountType str 2 Y 계좌 유형
법인
개인
IdentityNumber str 20 Y 예금주 식별정보 ('-' 제외)
- {AccountType}="법인" 경우 사업자번호
- {AccountType}="개인" 경우 생년월일 (형식 : yyMMdd)
AccountName str 100 N 계좌 별칭
BankID str 200 조건부 인터넷뱅킹 아이디
FastID str 50 조건부 조회전용 계정 아이디
FastPWD str 50 조건부 조회전용 계정 비밀번호
UsePeriod int 2 N 정액제 이용할 개월수
  • 11개월 : 기본값
  • 22개월
  • 33개월
  • 44개월
  • 55개월
  • 66개월
  • 77개월
  • 88개월
  • 99개월
  • 1010개월
  • 1111개월
  • 1212개월
파트너 포인트 사용시 입력값에 관계 없이 기본값 적용
Memo str 200 N 메모

EasyFinBankJobState

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

EasyFinBankSearchResult

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

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
- {BankCode}="0003"(기업은행) 경우 받는분 계좌번호
- {BankCode}="0004"(국민은행) 경우 내통장 표시내용
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 int 2 자동연장 결제일
5
15
25
state int 1 정액제 서비스 상태
1사용 또는 사용제한
2해지
closeRequestYN bool - 정액제 서비스 해지신청 여부
True신청
False미신청
useRestrictYN bool - 정액제 서비스 사용제한 여부
True사용제한
False사용
closeOnExpired bool - 정액제 서비스 해지 구분
True일반해지 (정액제 서비스 만료일 해지)
False중도해지 (요청 즉시 해지)
unPaidYN bool - 미수금 보유 여부
True보유
False미보유

UseHistoryResult

순번변수명타입길이설명
code int - API 처리에 대한 응답코드
1성공
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 처리에 대한 응답코드
1성공
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실패
  • 45취소
regDT str 14 등록일시
형식 : yyyyMMddHHmmss
stateDT str 14 상태일시
형식 : yyyyMMddHHmmss

RefundHistoryResult

순번변수명타입길이설명
code int - API 처리에 대한 응답코드
1성공
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 사업자번호 ('-' 제외)
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자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName str 100 Y 담당자 성명
tel str 20 Y 담당자 휴대폰
email str 100 Y 담당자 이메일
searchRole int 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번변수명타입길이설명
id str 50 아이디
personName str 100 담당자 성명
tel str 20 담당자 휴대폰
email str 100 담당자 이메일
regDT str 14 등록일시
형식 : yyyyMMddHHmmss
searchRole int 1 담당자 권한
1개인권한
2읽기권한
3회사권한
mgrYN bool - 관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state int 1 계정상태
1사용중

RefundResponse

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