POPBill Developers
API Reference

A. 객체정보

Response

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지

Err

순번변수명타입길이설명
Number Long - API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
Description String - API 처리 실패에 대한 오류메시지

BizCheckInfo

순번변수명타입길이설명
corpNum String 10 사업자번호
companyRegNum String 13 법인등록번호
checkDT String 14 기업정보조회일시
형식 : yyyyMMddHHmmss
corpName String 256 상호
ceoname String 128 대표자명
corpCode Integer 3 기업형태코드
  • 100일반회사
  • 101신설회사
  • 102외감
  • 103피합병
  • 110거래소(상장)
  • 111거래소(관리)
  • 112코스닥(등록)
  • 113코스닥(관리)
  • 114코넥스
  • 200폐업
  • 201부도
  • 300휴업
  • 900미정의
  • 999기타
corpScaleCode Integer 2 기업규모코드
  • 10대기업
  • 11대기업(금융)
  • 20중견기업
  • 21중견기업(하)
  • 30중소기업
  • 90기타(비영리법인)
  • 99기타
personCorpCode Integer 2 개인/법인코드
1법인
2개인
99기타
headOfficeCode Integer 2 본점/지점코드
1본점
2지점
99기타
industryCode String 6 산업코드
한국표준산업분류(10차) 기준
establishDate String 8 설립일자
형식 : yyyyMMdd
establishCode Integer 2 설립코드
  • 1주식
  • 2합자
  • 3합명
  • 4유한
  • 5조합
  • 6정부투자기관
  • 7개인
  • 8학교
  • 9병원
  • 10단체 또는 협회
  • 11미정의
  • 99기타
workPlaceCode Integer 2 사업장코드
  • 10본사
  • 20공장
  • 30서울사무소
  • 31사무소
  • 32영업소
  • 33지점
  • 34출장소
  • 40연구소
  • 50건설공장
  • 60창고
  • 99기타
addrCode Integer 2
  • 1도로명
  • 2지번
  • 3입력(입수)
  • 99기타
zipCode String 6 우편번호
addr String 256 주소
addrDetail String 256 상세주소
enAddr String 256 영문주소
bizClass String 4096 업종
bizType String 4096 업태
result Integer 3 상태코드
resultMessage String 4096 상태메시지
closeDownState Integer 1
  • 0미등록
  • 1사업중
  • 2폐업
  • 3휴업
  • 9확인실패
closeDownStateDate String 8 휴폐업일자
형식 : yyyyMMdd
closeDownTaxType Integer 2 과세유형
null미등록
10일반과세자
20면세과세자
30간이과세자
31간이과세자 세금계산서 발급사업자
40비영리법인 또는 국가기관, 고유번호가 할당된 단체
99확인실패
closeDownTaxTypeDate String 8 과세유형 전환일자
형식 : yyyyMMdd

ChargeInfo

순번변수명타입길이설명
unitCost String 12 조회단가
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 사업자번호 ('-' 제외)
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 종목

ContactInfo - 입력부

순번변수명타입길이필수설명
id String 50 Y 아이디
6자 이상 50자 이하
password String 20 조건부 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole Integer 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

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

RefundHistory

순번변수명타입길이설명
reqDT String 14 신청일시
형식 : yyyyMMddHHmmss
requestPoint String 18 환불 신청포인트
accountBank String 10 환불계좌 은행명
accountNum String 50 환불계좌번호
accountName String 70 환불계좌 예금주명
state Integer 1 상태
  • 1 접수대기
  • 2 심사중
  • 3 입금대기
  • 4 환불완료
  • 5 취소
reason String 200 환불사유

RefundHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<RefundHistory> 환불내역

RefundForm

순번변수명타입길이필수설명
contactName String 100 Y 담당자명
tel String 20 Y 담당자 연락처
requestPoint String 18 Y 환불 신청 포인트
accountBank String 10 Y 은행명
accountNum String 50 Y 계좌번호
accountName String 70 Y 예금주명
reason String 200 N 환불사유

PaymentHistory

순번변수명타입길이설명
productType String 3 결제 내용
포인트
정액제
미수금
productName String 30 결제 상품명
settleType String 7 결제유형
무통장
신용카드
실시간계좌이체
settlerName String 100 담당자명
settlerEmail String 100 담당자메일
settleCost String 18 결제금액
settlePoint String 18 충전포인트
settleState Integer 1 결제상태
  • 1대기
  • 2승인
  • 3실패
  • 45취소
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
stateDT String 14 상태일시
형식 : yyyyMMddHHmmss

PaymentHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<PaymentHistory> 결제내역

UseHistoryResult

순번변수명타입길이설명
code Long - API 처리에 대한 응답코드
1성공
total Long - 총 검색결과 건수
perPage Long - 페이지당 목록 건수
pageNum Long - 페이지 번호
pageCount Long - 페이지 개수
list List<UseHistory> 사용내역

RefundResponse

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

PaymentForm

순번변수명타입길이필수설명
settlerName String 100 N 담당자명
settlerEmail String 100 N 담당자 이메일
notifyHP String 20 N 담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
paymentName String 70 Y 입금자명
settleCost String 18 Y 결제금액

PaymentResponse

순번변수명타입길이설명
code Long - 응답코드
message String - 응답메시지
settleCode String 18 정산코드