API Reference 홈택스연동 Ruby 포인트 관리
4.1. GetFlatRateState - 정액제 서비스 상태 확인
def getFlatRateState(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpnum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userid |
String |
50 |
N |
팝빌회원 아이디 |
Return
FlatRateState
Throws
PopbillException
4.3. GetChargeInfo - 과금정보 확인
- 팝빌 홈택스연동 API 서비스 과금정보를 확인합니다.
def getChargeInfo(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
ChargeInfo
Throws
PopbillException
4.4. GetBalance - 연동회원 잔여포인트 확인
def getBalance(corpNum)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
Return
Float - 연동회원 잔여포인트
Throws
PopbillException
4.5. GetChargeURL - 연동회원 포인트 충전 팝업 URL
- 연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getChargeURL(corpNum, userID)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
PopbillException
4.6. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL
- 연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPaymentURL(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
PopbillException
4.7. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL
- 연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getUseHistoryURL(corpNum, userID = "")
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
PopbillException
4.8. GetPartnerBalance - 파트너 잔여포인트 확인
def getPartnerBalance(corpNum)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
Return
Float - 파트너 잔여포인트
Throws
PopbillException
4.9. GetPartnerURL - 파트너 포인트충전 팝업 URL
- 파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPartnerURL(corpNum, togo)
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|
corpNum |
String |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
togo |
String |
4 |
Y |
고정값 : "CHRG" |
Return
String - 요청에 대한 응답 URL
Throws
PopbillException