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 은행 기관코드
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 은행 기관코드
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 - 출금액 합계