A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - | API 처리에 대한 응답코드 | |
| message | string | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - |
API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드 |
|
| message | string | - | API 처리 실패에 대한 오류메시지 |
CorpState
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| corpNum | string | 10 | 조회한 사업자번호 | |
| taxType | string | 2 |
사업자 과세유형 : null / "10" / "20" / "30" / "31" / "40" 중 반환
└ null : 미확인 └ "10" : 일반과세자 └ "20" : 면세과세자 └ "30" : 간이과세자 └ "31" : 간이과세자 세금계산서 발급사업자 └ "40" : 비영리법인 또는 국가기관, 고유번호가 부여된 단체 |
|
| typeDate | string | 10 | 과세유형 전환일자 (형식 : yyyy-MM-dd) | |
| state | string | 1 |
휴폐업상태 : null / "0" / "1" / "2" / "3" 중 반환
└ null : 미확인 └ "0" : 미등록 - 등록되지 않은 사업자번호 └ "1" : 사업중 └ "2" : 폐업 └ "3" : 휴업 |
|
| stateDate | string | 10 | 휴폐업일자 (형식 : yyyy-MM-dd) | |
| checkDate | string | 10 |
국세청 확인일자
└ 팝빌이 휴폐업 조회한 일자 (형식 : yyyy-MM-dd) |
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - | API 처리에 대한 응답코드 | |
| total | number | - | 총 검색결과 건수 | |
| perPage | number | - | 페이지당 검색개수 | |
| pageNum | number | - | 페이지 번호 | |
| pageCount | number | - | 페이지 개수 | |
| list | UseHistory[] | 사용내역 | ||
UseHistory
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| itemCode | string | 3 | 서비스 코드
|
|
| txType | string | 2 | 포인트 증감 유형
포인트 증가
포인트 감소
|
|
| txPoint | string | 18 | 증감 포인트 | |
| balance | string | 18 | 잔여포인트 | |
| txDT | string | 14 | 포인트 증감 일시 (형식 : yyyyMMddHHmmss) | |
| userID | string | 50 | 담당자 아이디 | |
| userName | string | 100 | 담당자명 |
PaymentHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - | API 처리에 대한 응답코드 | |
| total | number | - | 총 검색결과 건수 | |
| perPage | number | - | 페이지당 검색개수 | |
| pageNum | number | - | 페이지 번호 | |
| pageCount | number | - | 페이지 개수 | |
| 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 | number | 1 |
결제상태 : 1 / 2 / 3 / 4 / 5 중 반환
└ 1 : 대기 └ 2 : 승인 └ 3 : 실패 └ 4,5 : 취소 |
|
| regDT | string | 14 | 등록일시 (형식 : yyyyMMddHHmmss) | |
| stateDT | string | 14 | 상태일시 (형식 : yyyyMMddHHmmss) |
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - | API 처리에 대한 응답코드 | |
| total | number | - | 총 검색결과 건수 | |
| perPage | number | - | 페이지당 검색개수 | |
| pageNum | number | - | 페이지 번호 | |
| pageCount | number | - | 페이지 개수 | |
| list | RefundHistory[] | 환불내역 | ||
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| reqDT | string | 14 | 신청일시 (형식 : yyyyMMddHHmmss) | |
| requestPoint | string | 18 | 환불 신청포인트 | |
| accountBank | string | 10 | 환불계좌 은행명 | |
| accountNum | string | 50 | 환불계좌번호 | |
| accountName | string | 70 | 환불계좌 예금주명 | |
| state | number | 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 | number | - | 응답코드 | |
| message | string | - | 응답메시지 | |
| settleCode | string | 18 | 정산코드 |
ChargeInfo
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| unitCost | string | - | 조회단가 | |
| 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 | 종목 |
ContactInfo
| 순번 | 변수명 | 타입 | 길이 | 필수 | 비고 |
|---|---|---|---|---|---|
| id | string | 50 | Y |
아이디
└ 6자 이상 50자 이하 |
|
| Password | string | 20 | 조건부 |
비밀번호
└ 8자 이상 20자 이하 └ 영문, 숫자, 특수문자 조합 |
|
| personName | string | 100 | Y | 담당자 성명 | |
| tel | string | 20 | Y | 담당자 휴대폰 | |
| string | 100 | Y | 담당자 이메일 | ||
| regDT | string | 14 | X | 등록일시 (형식 : yyyyMMddHHmmss) | |
| searchRole | number | 1 | N |
담당자 권한 : 1 / 2 / 3 중 반환
└ 1 : 개인권한 └ 2 : 읽기권한 └ 3 : 회사권한 |
|
| mgrYN | boolean | - | X |
관리자 여부 : true / false 중 반환
└ true : 관리자 └ false : 담당자 └ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능 |
|
| state | number | 1 | X |
계정상태 : 1 반환
└ 1 : 사용중 |
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 비고 |
|---|---|---|---|---|
| code | number | - | API 처리에 대한 응답코드 | |
| message | string | - | API 처리에 대한 응답메시지 | |
| refundCode | string | 18 | 환불코드 |