Index

1. 계좌 관리

1.1. RegistBankAccount - 계좌 등록

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

def registBankAccount(CorpNum, AccountInfo, UserID=None):
유의사항

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

Parameters

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

Return

Response

Throws

PopbillException

1.2. UpdateBankAccount - 계좌정보 수정

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

def updateBankAccount(CorpNum, AccountInfo, UserID=None):

Parameters

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

Return

Response

Throws

PopbillException

1.3. GetBankAccountInfo - 계좌정보 확인

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

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode str 4 O 은행 식별코드
"0011" : (농협) / "0004" : (국민은행) / "0020" : (우리은행) / "0088" : (신한은행)
"0003" : (기업은행) / "0081" : (하나은행) / "0023" : (SC은행) / "0002" : (산업은행)
"0027" : (씨티은행) / "0031" : (대구은행) / "0032" : (부산은행) / "0039" : (경남은행)
"0034" : (광주은행) / "0037" : (전북은행) / "0035" : (제주은행) / "0071" : (우체국)
"0045" : (새마을금고) / "0048" : (신협) / "0007" : (수협) 중 택 1
3 AccountNumber str 30 O 계좌번호
4 UserID str 50 - 팝빌회원 아이디

Return

EasyFinBankAccount

Throws

PopbillException

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

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

def listBankAccount(CorpNum, UserID=None):

Parameters

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

Return

EasyFinBankAccount[ ]

Throws

PopbillException

1.5. GetBankAccountMgtURL - 계좌 관리 팝업 URL

ㆍ계좌 등록, 수정 및 삭제할 수 있는 계좌 관리 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getBankAccountMgtURL(CorpNum, UserID=None):

Parameters

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

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

1.6. CloseBankAccount - 정액제 해지요청

ㆍ계좌의 정액제 해지를 요청합니다.

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode str 4 O 은행 식별코드
"0011" : (농협) / "0004" : (국민은행) / "0020" : (우리은행) / "0088" : (신한은행)
"0003" : (기업은행) / "0081" : (하나은행) / "0023" : (SC은행) / "0002" : (산업은행)
"0027" : (씨티은행) / "0031" : (대구은행) / "0032" : (부산은행) / "0039" : (경남은행)
"0034" : (광주은행) / "0037" : (전북은행) / "0035" : (제주은행) / "0071" : (우체국)
"0045" : (새마을금고) / "0048" : (신협) / "0007" : (수협) 중 택 1
3 AccountNumber str 30 O 계좌번호
4 CloseType str 2 O "일반" / "중도" 중 택 1
└ 일반(일반해지) = 이용중인 정액제 기간 만료 후 해지
└ 중도(중도해지) = 해지 요청일 기준으로 정지되고 팝빌 담당자가 승인시 해지
※ 중도일 경우, 정액제 잔여기간은 일할로 계산되어 포인트 환불(무료 이용기간에 해지하면 전액 환불)
5 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

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

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

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode str 4 O 은행 식별코드
"0011" : (농협) / "0004" : (국민은행) / "0020" : (우리은행) / "0088" : (신한은행)
"0003" : (기업은행) / "0081" : (하나은행) / "0023" : (SC은행) / "0002" : (산업은행)
"0027" : (씨티은행) / "0031" : (대구은행) / "0032" : (부산은행) / "0039" : (경남은행)
"0034" : (광주은행) / "0037" : (전북은행) / "0035" : (제주은행) / "0071" : (우체국)
"0045" : (새마을금고) / "0048" : (신협) / "0007" : (수협) 중 택 1
3 AccountNumber str 30 O 계좌번호
4 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

2. 계좌 거래내역 수집

2.1. RequestJob - 수집 요청

ㆍ계좌 거래내역을 확인하기 위해 팝빌에 수집요청을 합니다. 조회기간은 당일 기준으로 90일 이내로만 지정 가능합니다.

def requestJob(CorpNum, BankCode, AccountNumber, SDate, EDate, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode str 4 O 은행 식별코드
"0011" : (농협) / "0004" : (국민은행) / "0020" : (우리은행) / "0088" : (신한은행)
"0003" : (기업은행) / "0081" : (하나은행) / "0023" : (SC은행) / "0002" : (산업은행)
"0027" : (씨티은행) / "0031" : (대구은행) / "0032" : (부산은행) / "0039" : (경남은행)
"0034" : (광주은행) / "0037" : (전북은행) / "0035" : (제주은행) / "0071" : (우체국)
"0045" : (새마을금고) / "0048" : (신협) / "0007" : (수협) 중 택 1
3 AccountNumber str 30 O 계좌번호
4 SDate str 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
5 EDate str 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
6 UserID str 50 - 팝빌회원 아이디

Return

str - 요청에 대한 작업아이디(JobID)

Throws

PopbillException

2.2. GetJobState - 수집 상태 확인

[2.1 RequestJob - 수집 요청]를 통해 반환 받은 작업아이디의 상태를 확인합니다.

[3.1 Search – 거래 내역 조회] 또는 [3.2 Summary – 거래 요약 정보 조회]를 사용하기 전에 수집 작업의 진행 상태, 수집 작업의 성공 여부를 확인해야 합니다.

※ 작업 상태(jobState) = 3(완료), 수집 결과 코드(errorCode) = 1(수집성공)이면 거래 내역 조회 또는 거래 요약 정보 조회를 해야합니다.

def getJobState(CorpNum, JobID, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID str 18 O 작업아이디(JobID)
[2.1 RequestJob - 수집 요청]의 반환값
3 UserID str 50 - 팝빌회원 아이디

Return

EasyFinBankJobState

Throws

PopbillException

2.3. ListActiveJob - 수집 상태 목록 확인

[2.1 RequestJob - 수집 요청]를 통해 반환 받은 작업아이디의 목록을 확인합니다. 반환 받은 작업아이디는 함수 호출 시점부터 1시간 동안 유효합니다.

def listActiveJob(CorpNum, UserID=None):

Parameters

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

Return

EasyFinBankJobState[ ]

Throws

PopbillException

3. 계좌 거래내역 조회

3.1. Search - 거래 내역 조회

[1.2 GetJobState – 수집 상태 확인]를 통해 상태 정보가 확인된 작업아이디를 활용하여 계좌 거래 내역을 조회합니다.

def search(CorpNum, JobID, TradeType, SearchString, Page, PerPage, Order, UserID=None):

ㆍ페이지 정보(Page, PerPage, Order) 항목을 사용하여 거래내역 조회 목록 페이징 기능을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID str 18 O 작업아이디(JobID)
[2.1 RequestJob - 수집 요청]의 반환값
3 TradeType list - - [배열] 거래유형: "I" / "O" 중 선택 (다중선택 가능)
└ I = 입금, O = 출금
※ 미입력시 전체조회
4 SearchString str - - "입·출금액" / "메모" / "비고" 중 검색하고자 하는 값 입력
└ 메모 = [3.3 SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값, 비고 = EasyFinBankSearchDetail의 remark1, remark2, remark3 값
※ 미입력시 전체조회
5 Page int - O 목록 페이지번호
6 Perpage int - O 페이지당 표시할 목록 개수 (최대 1,000)
7 Order str - - 거래일자를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
8 UserID str 50 - 팝빌회원 아이디

Return

EasyFinBankSearchResult

Throws

PopbillException

3.2. Summary - 거래내역 요약정보 조회

[2.2 GetJobState – 수집 상태 확인]를 통해 상태 정보가 확인된 작업아이디를 활용하여 계좌 거래내역의 요약 정보를 조회합니다.

※ 요약 정보는 입·출 금액 합계, 입·출 거래 건수를 가리킵니다.

def summary(CorpNum, JobID, TradeType, SearchString, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID str 18 O 작업아이디(JobID)
[2.1 RequestJob - 수집 요청]의 반환값
3 TradeType list - - [배열] 거래유형: "I" / "O" 중 선택 (다중선택 가능)
└ I = 입금, O = 출금
※ 미입력시 전체조회
4 SearchString str - - "입·출금액" / "메모" / "비고" 중 검색하고자 하는 값 입력
└ 메모 = [3.3 SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값, 비고 =EasyFinBankSearchDetail의 remark1, remark2, remark3 값
※ 미입력시 전체조회
5 UserID str 50 - 팝빌회원 아이디

Return

EasyFinBankSummary

Throws

PopbillException

3.3. SaveMemo - 거래내역 메모저장

ㆍ한 건의 거래 내역에 메모를 저장합니다.

def saveMemo(CorpNum, TID, Memo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TID str 32 O 메모를 저장할 거래내역 아이디
[3.1 Search - 거래 내역 조회]의 반환 값 'EasyFinBankSearchDetail'의 'tid'를 통해 확인 가능
3 Memo str 100 O 거래 내역에 저장할 메모
4 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

4. 정액제 신청 / 포인트 관리

4.1. GetFlatRatePopUpURL - 정액제 서비스 신청 팝업 URL

ㆍ계좌조회 정액제 서비스 신청 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 이 시간 초과후에는 URL을 사용해도 정상적인 페이지에 접근할 수 없습니다.

def getFlatRatePopUpURL(CorpNum, UserID=None):

Parameters

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

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

4.2. GetFlatRateState - 정액제 서비스 상태 확인

ㆍ계좌조회 정액제 서비스 상태를 확인합니다.

def getFlatRateState(CorpNum, BankCode, AccountNumber, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode str 4 O 은행 식별코드
"0011" : (농협) / "0004" : (국민은행) / "0020" : (우리은행) / "0088" : (신한은행)
"0003" : (기업은행) / "0081" : (하나은행) / "0023" : (SC은행) / "0002" : (산업은행)
"0027" : (씨티은행) / "0031" : (대구은행) / "0032" : (부산은행) / "0039" : (경남은행)
"0034" : (광주은행) / "0037" : (전북은행) / "0035" : (제주은행) / "0071" : (우체국)
"0045" : (새마을금고) / "0048" : (신협) / "0007" : (수협) 중 택 1
3 AccountNumber str 30 O 은행 계좌번호(하이픈 '-' 제외)
4 UserID str 50 - 팝빌회원 아이디

Return

FlatRateState

Throws

PopbillException

4.3. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

def getBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 연동회원 잔여포인트

Throws

PopbillException

4.4. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getChargeURL(CorpNum, UserID):

Parameters

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

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

4.5. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

def getPartnerBalance(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 파트너 잔여포인트

Throws

PopbillException

4.6. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getPartnerURL(CorpNum, TOGO):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO str - O "CHRG" 입력

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

4.7. GetChargeInfo - 과금정보 확인

ㆍ팝빌 계좌조회 API 서비스 과금정보를 확인합니다.

def getChargeInfo(CorpNum, UserID=None):

Parameters

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

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

5.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

def checkIsMember(CorpNum):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Response

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

def checkID(checkID):

Parameters

순번 변수명 타입 길이 필수 설명
1 CheckID str 20 O 중복여부를 확인할 아이디

Return

Response - code : 0 (미사용중) / code : 1 (사용중)

Throws

PopbillException

5.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

def joinMember(JoinInfo):

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo JoinForm - O 연동회원 객체정보

Return

Response

Throws

PopbillException

5.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

def getAccessURL(CorpNum, UserID):

Parameters

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

Return

str - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

def getCorpInfo(CorpNum, UserID=None):

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

def updateCorpInfo(CorpNum, CorpInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo CorpInfo - O 회사 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

def registContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

def listContact(CorpNum, UserID=None):

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

5.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

def updateContact(CorpNum, ContactInfo, UserID=None):

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum str 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID str 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

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

A.3. EasyFinBankAccount

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

A.4. BankAccountInfo

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

A.5. EasyFinBankJobState

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

A.6. EasyFinBankSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 int - API 처리에 대한 응답코드
2 message 요청에 대한 응답메시지 str - API 처리에 대한 응답 메시지
3 total 총 검색결과 건수 int -
4 perPage 페이지 당 목록 개수 int -
5 pageNum 페이지 번호 int -
6 pageCount 페이지 개수 int -
7 lastScrapDT 최종 조회일시 str 14 형식 : yyyyMMddHHmmss
8 list 거래내역 조회 목록 EasyFinBankSearchDetail[ ] [딕셔너리] 최대 1000건

A.7. EasyFinBankSearchDetail

순번 변수명 항목명 타입 길이 비고
1 tid 거래내역 아이디 str 32 거래 내역에 대한 팝빌이 부여한 고유 식별값
2 trdate 거래일자 str 8 형식 : yyyyMMdd
3 trserial 거래일련번호 int - 거래일자별 거래 내역 순번
4 trdt 거래일시 str 14 형식 : yyyyMMddHHmmss
5 accIn 입금액 str 20
6 accOut 출금액 str 20
7 balance 잔액 str 20
8 remark1 비고 1 str 500 적요
9 remark2 비고 2 str 500 거래점
10 remark3 비고 3 str 500 거래구분
11 remark4 비고 4 str 500
12 regDT 등록일시 str 14 형식 : yyyyMMddHHmmss
13 memo 메모 str 100 [3.3 SaveMemo – 거래내역 메모저장]을 사용하여 저장한 값

A.8. EasyFinBankSummary

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

A.9. FlatRateState

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

A.10. ChargeInfo

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

A.11. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 str 50 O 6자 이상 50자 미만
2 PWD 비밀번호 str 20 O 6자 이상 20자 미만
3 LinkID 파트너 링크아이디 str 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 str 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 str 100 O
6 CorpName 상호 str 200 O
7 Addr 사업장 주소 str 300 O
8 BizType 업태 str 100 O
9 BizClass 종목 str 100 O
10 ContactName 담당자 성명 str 100 O
11 ContactEmail 담당자 이메일 str 100 O
12 ContactTEL 담당자 연락처 str 20 O
13 ContactHP 담당자 휴대폰번호 str 20 -
14 ContactFAX 담당자 팩스번호 str 20 -

A.12. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 str 100 O
2 corpName 상호 str 200 O
3 addr 주소 str 300 O
4 bizType 업태 str 100 O
5 bizClass 종목 str 100 O

A.13. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 str 50 O 6자 이상 50자 미만
2 pwd 비밀번호 str 20 담당자 추가시 필수, 6자 이상 20자 미만
3 personName 담당자 성명 str 100 O
4 tel 담당자 연락처 str 20 O
5 hp 담당자 휴대폰번호 str 20 -
6 fax 담당자 팩스번호 str 20 -
7 email 담당자 이메일 str 100 O
8 regDT 등록일시 str 14 X
9 searchAllAllowYN 담당자 조회권한 설정 bool - - True : (회사권한) / False : (개인권한) 중 반환
※ 미입력시 기본값 False 처리
10 mgrYN 관리자 여부 bool - X True : (관리자) / False : (일반사용자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 상태 int 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환