POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

AccountCheckInfo

순번 변수명 타입 길이 비고
result str 10 [CheckAccountInfo - 계좌성명조회] 함수 호출에 대한 결과 코드
[참고] 예금주조회 결과 코드 테이블
resultMessage str 2000 [CheckAccountInfo - 계좌성명조회] 함수 호출에 대한 결과 메시지
accountName str 200 예금주 성명
bankCode str 4 기관코드
accountNumber str 30 계좌번호
└ 8자리 이상 14자리 이하
checkDate str 13 확인일시
└ 타임스탬프 (단위 : ms)

DepositorCheckInfo

순번 변수명 타입 길이 비고
result str 10 [CheckDepositorInfo - 계좌실명조회] 함수 호출에 대한 결과 코드
[참고] 예금주조회 결과 코드 테이블
resultMessage str 2000 [CheckDepositorInfo - 계좌실명조회] 함수 호출에 대한 결과 메시지
accountName str 200 예금주 성명
bankCode str 4 기관코드
accountNumber str 30 계좌번호
└ 8자리 이상 14자리 이하
identityNumType str 1 등록번호 유형 : "P" / "B" 중 반환
└ "P" : 개인
└ "B" : 사업자
identityNum str 10 등록번호 {identityNumType} 값이 "B" 인 경우
└ 사업자번호 입력 (10자)
{identityNumType} 값이 "P" 인 경우
checkDate str 13 확인일시
└ 타임스탬프 (단위 : ms)

UseHistoryResult

순번변수명타입길이비고
code int - API 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
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 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
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 / 4 / 5 중 반환
└ 1 : 대기
└ 2 : 승인
└ 3 : 실패
└ 4,5 : 취소
regDT str 14 등록일시 (형식 : yyyyMMddHHmmss)
stateDT str 14 상태일시 (형식 : yyyyMMddHHmmss)

RefundHistoryResult

순번변수명타입길이비고
code int - API 처리에 대한 응답코드
total int - 총 검색결과 건수
perPage int - 페이지당 검색개수
pageNum int - 페이지 번호
pageCount int - 페이지 개수
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 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
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자 이하
영문, 숫자, 특수문자 조합
담당자 추가시 필수
personName str 100 Y 담당자 성명
tel str 20 Y 담당자 휴대폰
email str 100 Y 담당자 이메일
searchRole int 1 N 담당자 권한 (택 1)
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번 변수명 타입 길이 비고
id str 50 아이디
6자 이상 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 처리에 대한 응답코드
message str - API 처리에 대한 응답메시지
refundCode str 18 환불코드