정액제 신청 / 포인트 관리

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

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

Function GetFlatRateState(CorpNum As String, BankCode As String, AccountNumber As String, Optional UserID As String = "") As PBEasyFinBankFlatRate

요청

Parameters

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

응답

PBEasyFinBankFlatRate

순번	변수명	타입	길이	설명
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 미보유

예외

Err

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

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

미리보기

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

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

Function GetFlatRatePopUpURL(CorpNum As String, Optional UserID As String = "") As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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

3. GetChargeInfo - 과금정보 확인

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

Function GetChargeInfo(CorpNum As String, Optional UserID As String = "") As PBChargeInfo

요청

Parameters

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

응답

PBChargeInfo

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

예외

Err

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

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

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

Function GetBalance(CorpNum As String) As Double

요청

Parameters

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

응답

Double - 연동회원 잔여포인트

예외

Err

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

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

미리보기

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

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

Function GetChargeURL(CorpNum As String, UserID As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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

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

미리보기

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

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

Function GetPaymentURL(CorpNum As String, UserID As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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

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

미리보기

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

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

Function GetUseHistoryURL(CorpNum As String, UserID As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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

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

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

Function GetPartnerBalance(CorpNum As String) As Double

요청

Parameters

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

응답

Double - 파트너 잔여포인트

예외

Err

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

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

미리보기

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

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

Function GetPartnerURL(CorpNum As String, TOGO As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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