1. 계좌 관리

1.1. GetBankAccountMgtURL - 계좌 관리 팝업 URL

ㆍ은행 계좌 관리 팝업 URL을 반환합니다. 이 URL로 접근한 화면에서 계좌 등록, 수정 및 삭제가 가능합니다.

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

function GetBankAccountMgtURL($CorpNum, $UserID = null)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

1.2. ListBankAccount - 계좌 목록 확인

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

function ListBankAccount($CorpNum, $UserID = null)

Parameters

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

Return

EasyFinBankAccount[ ]

Throws

PopbillException

2. 계좌 거래내역 수집

2.1. RequestJob - 수집 요청

ㆍ 계좌 거래내역 조회하기 위해 수집을 요청합니다. 검색기간은 당일 기준으로 90일 이내로만 요청할 수 있습니다.

function RequestJob($CorpNum, $BankCode, $AccountNumber, $SDate, $EDate, $UserID = null)

Parameters

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

Return

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

Throws

PopbillException

2.2. GetJobState - 수집 상태 확인

ㆍ계좌 거래내역 수집요청(RequestJob)하여 받은 작업아이디(JobID)의 상태를 확인합니다. 계좌내역 수집 작업의 진행 상태(jobState), 수집 작업의 성공 여부(errorCode)등을 확인할 수 있습니다.

function GetJobState($CorpNum, $JobID, $UserID = null)

개발 유의사항
ㆍ수집 상태(jobState)가 3(완료)이고 수집 결과 코드(errorCode)가 1(수집성공)이면, 거래내역 조회(Search) 또는 거래내역 요약 정보 조회(Summary) 함수를 호출해 상세내역을 확인합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID String 18 O 수집 요청(RequestJob) 함수를 사용하여 반환 받은 작업아이디(JobID)
3 UserID String 50 - 팝빌회원 아이디

Return

EasyFinBankJobState

Throws

PopbillException

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

ㆍ계좌조회 내역 수집요청에 대한 상태 목록을 확인합니다.

function ListActiveJob($CorpNum, $UserID = null)

개발 유의사항
ㆍ반환 받은 작업아이디(JobID)는 수집 요청 시점 기준으로 1시간만 사용 가능합니다.

Parameters

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

Return

EasyFinBankJobState[ ]

Throws

PopbillException

3. 계좌 거래내역 조회

3.1. Search - 거래 내역 조회

ㆍ수집처리가 완료된 작업아이디(JobID)를 사용하여 거래내역 수집 결과를 조회합니다.

function Search($CorpNum, $JobID, $TradeType, $SearchString, $Page, $PerPage, $Order, $UserID = null)

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

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID String 18 O 수집 요청(RequestJob) 함수를 사용하여 반환 받은 작업아이디(JobID)
3 TradeType Array - - [배열] 거래유형 : I - 입금 / O - 출금
4 SearchString String - - 조회 검색어 - 입금/출금액, 거래내역의 메모, 적요 like 검색 가능
빈 문자열 입력시 전체 조회
5 Page Integer - O 페이지 번호
6 Perpage Integer - O 페이지 당 목록 개수
7 Order String - - 정렬방향 : D - 내림차순 / A - 오름차순
8 UserID String 50 - 팝빌회원 아이디

Return

EasyFinBankSearchResult

Throws

PopbillException

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

ㆍ거래내역 요약정보(입·출 금액 합계, 입·출 거래 건수)를 조회합니다.

function Summary($CorpNum, $JobID, $TradeType, $SearchString, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JobID String 18 O 수집 요청(RequestJob) 함수를 사용하여 반환 받은 작업아이디(JobID)
3 TradeType Array - - [배열] 거래유형 : I - 입금 / O - 출금
4 SearchString String - - 조회 검색어 - 입금/출금액, 거래내역의 메모, 적요 like 검색 가능
빈 문자열 입력시 전체 조회
5 UserID String 50 - 팝빌회원 아이디

Return

EasyFinBankSummaryResult

Throws

PopbillException

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

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

function SaveMemo($CorpNum, $TID, $Memo, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TID String 32 O 저장할 메모의 거래내역 아이디, 거래 내역 조회(Search)함수를 사용하여 확인 가능
3 Memo String 100 O 거래내역에 저장할 메모
4 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

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

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

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

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

function GetFlatRatePopUpURL($CorpNum, $UserID = null)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

function GetFlatRateState($CorpNum, $BankCode, $AccountNumber, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 BankCode String 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 String 30 O 은행 계좌번호(하이픈 '-' 제외)
4 UserID String 50 - 팝빌회원 아이디

Return

EasyFinBankFlatRate

Throws

PopbillException

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

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

function GetBalance($CorpNum)

Parameters

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

Return

String - 연동회원 잔여포인트

Throws

PopbillException

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

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

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

function GetChargeURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

function GetPartnerBalance($CorpNum)

Parameters

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

Return

String - 파트너 잔여포인트

Throws

PopbillException

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

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

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

function GetPartnerURL($CorpNum, $TOGO)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.7. GetChargeInfo - 과금정보 확인

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

function GetChargeInfo($CorpNum, $UserID = null)

Parameters

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

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

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

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

function CheckIsMember($CorpNum, $LinkID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

Response

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

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

function CheckID($ID)

Parameters

순번 변수명 타입 길이 필수 설명
1 ID String 10 O 중복여부 확인 할 아이디

Return

Response

Throws

PopbillException

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

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

function JoinMember($JoinForm)

Parameters

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

Return

Response

Throws

PopbillException

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

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

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

function GetAccessURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

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

function GetCorpInfo($CorpNum, $UserID = null)

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

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

function UpdateCorpInfo($CorpNum, $CorpInfo, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 등록

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

function RegistContact($CorpNum, $ContactInfo, $UserID = null)

Parameters

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

Return

Response

Throws

PopbillException

5.8. ListContact - 담당자 목록 확인

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

function ListContact($CorpNum, $UserID = null)

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

5.9. UpdateContact - 담당자 정보 수정

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

function UpdateContact($CorpNum, $ContactInfo, $UserID)

Parameters

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

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

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

A.2. PopbillException

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

A.3. EasyFinBankAccount

순번 변수명 항목명 타입 길이 비고
1 accountNumber 계좌번호 String 30 팝빌에 등록된 계좌번호
2 bankCode 은행코드 String 4 * 은행 식별코드
산업은행 - 0002 / 기업은행 - 0003 / 국민은행 - 0004
수협은행 - 0007 / 농협은행 - 0011 / 우리은행 - 0020
SC은행 - 0023 / 대구은행 - 0031 / 부산은행 - 0032
광주은행 - 0034 / 제주은행 - 0035 / 전북은행 - 0037
경남은행 - 0039 / 새마을금고 - 0045 / 신협은행 - 0048
우체국 - 0071 / KEB하나은행 - 0081 / 신한은행 - 0088
씨티은행 - 0027
3 accountName 계좌 별칭 String 100
4 accountType 계좌 유형 String - 법인 / 개인 중 반환
5 state 계좌 정액제 상태 Integer - 1 - 사용 / 2 - 정지 / 3 - 해지
6 regDT 등록일시 String 14 팝빌에 계좌 등록한 일시, 날짜형식(yyyyMMddHHmmss)
7 memo 메모 String 200 계좌에 저장된 메모

A.4. EasyFinBankJobState

순번 변수명 항목명 타입 길이 비고
1 jobID 작업아이디 String 18 수집 요청(RequestJob) 함수를 사용하여 반환 받은 작업아이디
2 jobState 수집상태 Integer - 수집 작업의 진행 상태 : 0 - 접수 / 1 - 대기 / 2 - 진행 / 3 - 완료
3 startDate 시작일자 String 8 날짜형식(yyyyMMdd)
4 endDate 종료일자 String 8 날짜형식(yyyyMMdd)
5 errorCode 오류코드 Integer - 수집 결과 코드 : 1 - 수집성공 / 기타 - 수집실패
6 errorReason 오류메시지 String -
7 jobStartDT 작업 시작일시 String 14 날짜형식(yyyyMMddHHmmss)
8 jobEndDT 작업 종료일시 String 14 날짜형식(yyyyMMddHHmmss)
9 regDT 수집 요청일시 String 14 날짜형식(yyyyMMddHHmmss)

A.5. EasyFinBankSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 요청에 대한 응답코드 Integer - API 처리에 대한 응답 상태코드
2 message 요청에 대한 응답메시지 String - API 처리에 대한 응답 메시지
3 total 총 검색결과 건수 Integer -
4 perPage 페이지 당 목록 개수 Integer -
5 pageNum 페이지 번호 Integer -
6 pageCount 페이지 개수 Integer -
7 list 거래내역 조회 목록 EasyFinBankSearchDetail[ ] 최대 1000건

A.6. EasyFinBankSearchDetail

순번 변수명 항목명 타입 길이 비고
1 tid 거래내역 아이디 String 32 거래내역 고유 식별키
2 trdate 거래일자 String 8 날짜형식(yyyyMMdd)
3 trserial 거래일련번호 Integer - 거래일자별 거래내역 순번
4 trdt 거래일시 String 14 날짜형식(yyyyMMddHHmmss)
5 accIn 입금액 String 20
6 accOut 출금액 String 20
7 balance 잔액 String 20
8 remark1 비고 1 String 500 적요
9 remark2 비고 2 String 500 거래점
10 remark3 비고 3 String 500 거래구분 / 메모
11 remark4 비고 4 String 500
12 regDT 등록일시 String 14 날짜형식(yyyyMMddHHmmss)
13 memo 메모 String 100

A.7. EasyFinBankSummaryResult

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

A.8. EasyFinBankFlatRate

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

A.9. ChargeInfo

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

A.10. JoinForm

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

A.11. CorpInfo

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

A.12. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 O 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처 String 20 O
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 -
9 searchAllAllowYN 담당자 조회권한 설정 Boolean - -

회사조회(true) : 모든 담당자의 전자문서 관리가능

개인조회(false) : 해당 담당자 계정으로 작성한 전자문서 관리가능(기본값)

10 mgrYN 관리자 여부 Boolean - - true - 관리자 / false - 사용자(기본값)
11 state 상태 Integer 1 - 0 – 승인대기 / 1 – 사용중