정액제 신청 / 포인트 관리

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

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

function flatratestate getflatratestate(string corpnum, string bankcode, string accountnumber, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	bankcode	string	4	Y	은행 기관코드 → [참고] 조회 가능한 금융기관
3	accountnumber	string	30	Y	은행 계좌번호(하이픈 '-' 제외)
4	userid	string	50	N	팝빌회원 아이디

응답

FlatRateState

순번	변수명	타입	길이	설명
1	referenceID	string	18	계좌아이디 → 팝빌이 계좌를 식별하는 값
2	contractDT	string	14	정액제 서비스 시작일시 → 형식 : yyyyMMddHHmmss
3	useEndDate	string	8	정액제 서비스 만료일자 → 형식 : yyyyMMdd
4	baseDate	integer	2	자동연장 결제일 5 15 25
5	state	integer	1	정액제 서비스 상태 1 사용 또는 사용제한 2 해지
6	closeRequestYN	boolean	-	정액제 서비스 해지신청 여부 true 신청 false 미신청
7	useRestrictYN	boolean	-	정액제 서비스 사용제한 여부 true 사용제한 false 사용
8	closeOnExpired	boolean	-	정액제 서비스 해지 구분 true 일반해지 (정액제 서비스 만료일 해지) false 중도해지 (요청 즉시 해지)
9	unPaidYN	boolean	-	미수금 보유 여부 true 보유 false 미보유

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

2. GetFlatRatePopUpURL - 정액제 신청 팝업 URL

미리보기

정액제를 신청하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getflatratepopupurl(string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

3. GetChargeInfo - 과금정보 확인

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

function chargeinfo getchargeinfo(string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

ChargeInfo

순번	변수명	타입	길이	설명
1	unitCost	string	-	요금
2	chargeMethod	string	3	과금유형 연동 파트너
3	rateSystem	string	3	요금제도 정액제 종량제

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

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

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

function double getbalance(string corpnum) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)

응답

double - 연동회원 잔여포인트

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

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

미리보기

연동회원 포인트를 충전하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getChargeURL(string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

6. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL

미리보기

연동회원 포인트 결제내역 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getpaymenturl (string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

7. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL

미리보기

연동회원 포인트 사용내역 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getusehistoryurl (string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

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

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

function double getpartnerbalance(string corpnum) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)

응답

double - 파트너 잔여포인트

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

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

미리보기

파트너 포인트를 충전하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 800px / height = 700px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getpartnerurl(string corpnum, string togo) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	togo	string	4	Y	고정값 : "CHRG"

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지