POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

AccountCheckInfo

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

DepositorCheckInfo

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

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 사업자번호
└ 하이픈 '-' 제외 10자리 숫자값
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 종목

Contact

순번 변수명 타입 길이 필수 비고
id String 50 Y 아이디
└ 6자 이상 50자 이하
Password String 20 조건부 비밀번호
└ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 연락처
email String 100 Y 담당자 이메일
regDT String 14 X 등록일시 (형식 : yyyyMMddHHmmss)
searchRole int? 1 N 담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한
└ 2 : 읽기권한
└ 3 : 회사권한
mgrYN bool? - X 관리자 여부 : true / false 중 반환
└ true : 관리자
└ false : 담당자
└ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state String - X 계정상태 : "1" 반환
└ "1" : 사용중

UseHistoryResult

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

UseHistory

순번변수명타입길이비고
itemCode String 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 String 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
txPoint String 18 증감 포인트
balance String 18 잔여포인트
txDT String 14 포인트 증감 일시 (형식 : yyyyMMddHHmmss)
userID String 50 담당자 아이디
userName String 100 담당자명

PaymentHistoryResult

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

PaymentHistory

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

RefundHistoryResult

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

RefundHistory

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

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 환불사유

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 정산코드

RefundResponse

순번 변수명 타입 길이 비고
code long - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
refundCode String 18 환불코드