BaseService (Popbill API SDK 1.60.0 API)

All Known Subinterfaces:

AccountCheckService, BizInfoCheckService, CashbillService, CloseDownService, EasyFinBankService, FaxService, HTCashbillService, HTTaxinvoiceService, KakaoService, MessageService, StatementService, TaxinvoiceService

All Known Implementing Classes:

AccountCheckServiceImp, BaseServiceImp, BizInfoCheckServiceImp, CashbillServiceImp, CloseDownServiceImp, EasyFinBankServiceImp, FaxServiceImp, HTCashbillServiceImp, HTTaxinvoiceServiceImp, KakaoServiceImp, MessageServiceImp, StatementServiceImp, TaxinvoiceServiceImp
```
public interface BaseService
```
Popbill BaserService Interface.

Version:

1.0.0

Author:

KimSeongjun

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Response`	`checkID(String id)` 팝빌회원 아이디 중복체크
`Response`	`checkIsMember(String CorpNum, String LinkID)` 연동회원의 가입여부 확인.
`String`	`getAccessURL(String CorpNum, String UserID)` 팝빌 로그인 URL
`double`	`getBalance(String CorpNum)` 연동회원 잔여 포인트 확인.
`String`	`getChargeURL(String CorpNum, String UserID)` 연동회원 포인트충전 팝업 URL
`ContactInfo`	`getContactInfo(String CorpNum, String contactID)` 담당자 정보확인.
`ContactInfo`	`getContactInfo(String CorpNum, String contactID, String UserID)` 담당자 정보확인.
`CorpInfo`	`getCorpInfo(String CorpNum)` 회사정보 확인
`CorpInfo`	`getCorpInfo(String CorpNum, String UserID)` 회사정보 확인
`double`	`getPartnerBalance(String CorpNum)` 연동 파트너의 잔여포인트 확인
`String`	`getPartnerURL(String CorpNum, String TOGO)` 파트너 관리자 팝업 URL 요청
`PaymentHistoryResult`	`getPaymentHistory(String CorpNum, String SDate, String EDate, Integer Page, Integer PerPage)` 포인트 결제내역 확인.
`PaymentHistoryResult`	`getPaymentHistory(String CorpNum, String SDate, String EDate, Integer Page, Integer PerPage, String UserID)` 포인트 결제내역 확인.
`String`	`getPaymentURL(String CorpNum, String UserID)` 연동회원 포인트 결재내역 팝업 URL
`kr.co.linkhub.auth.MemberPointDetail`	`getPointInfo(String CorpNum)`
`String`	`getPopbillURL(String CorpNum, String TOGO)` 팝빌의 SSO 접근 URL 요청.
`String`	`getPopbillURL(String CorpNum, String UserID, String TOGO)` 팝빌의 SSO 접근 URL 요청.
`double`	`getRefundableBalance(String CorpNum)` 환불가능포인트 확인
`double`	`getRefundableBalance(String CorpNum, String UserID)` 환불가능포인트 확인
`RefundHistoryResult`	`getRefundHistory(String CorpNum, Integer Page, Integer PerPage)` 환분신청 내역 확인.
`RefundHistoryResult`	`getRefundHistory(String CorpNum, Integer Page, Integer PerPage, String UserID)` 환분신청 내역 확인.
`RefundHistory`	`getRefundInfo(String CorpNum, String RefundCode)` 환불신청 상태확인
`RefundHistory`	`getRefundInfo(String CorpNum, String RefundCode, String UserID)` 환불신청 상태확인
`PaymentHistory`	`getSettleResult(String CorpNum, String settleCode)` 무통장 입금신청 정보확인.
`PaymentHistory`	`getSettleResult(String CorpNum, String settleCode, String UserID)` 무통장 입금신청 정보확인.
`UseHistoryResult`	`getUseHistory(String CorpNum, String SDate, String EDate, Integer Page, Integer PerPage, String Order)` 포인트 사용내역 확인
`UseHistoryResult`	`getUseHistory(String CorpNum, String SDate, String EDate, Integer Page, Integer PerPage, String Order, String UserID)` 포인트 사용내역 확인
`String`	`getUseHistoryURL(String CorpNum, String UserID)` 연동회원 포인트 사용내역 팝업 URL
`Response`	`joinMember(JoinForm joinInfo)` 연동회원 가입요청.
`ContactInfo[]`	`listContact(String CorpNum)` 담당자 목록조회
`ContactInfo[]`	`listContact(String CorpNum, String UserID)` 담당자 목록조회
`PaymentResponse`	`paymentRequest(String CorpNum, PaymentForm paymentForm)` 무통장 입금신청.
`PaymentResponse`	`paymentRequest(String CorpNum, PaymentForm paymentForm, String UserID)` 무통장 입금신청.
`Response`	`quitMember(String CorpNum, String quitReason)` 회원탈퇴
`Response`	`quitMember(String CorpNum, String quitReason, String UserID)` 회원탈퇴
`RefundResponse`	`refund(String CorpNum, RefundForm refundForm)` 환불 신청.
`RefundResponse`	`refund(String CorpNum, RefundForm refundForm, String UserID)` 환불 신청.
`Response`	`registContact(String CorpNum, ContactInfo contactInfo)` 담당차 등록
`Response`	`registContact(String CorpNum, ContactInfo contactInfo, String UserID)` 담당차 등록
`Response`	`updateContact(String CorpNum, ContactInfo contactInfo, String UserID)` 담당자 정보수정
`Response`	`updateCorpInfo(String CorpNum, CorpInfo corpInfo)` 회사정보 수정
`Response`	`updateCorpInfo(String CorpNum, CorpInfo corpInfo, String UserID)` 회사정보 수정

Method Detail

getBalance
```
double getBalance(String CorpNum)
           throws PopbillException
```
연동회원 잔여 포인트 확인.

Parameters:

CorpNum - Member's CorpNum

Returns:

Member's RemainPoint

Throws:

PopbillException

getPointInfo

kr.co.linkhub.auth.MemberPointDetail getPointInfo(String CorpNum)
                                           throws PopbillException

Throws:: PopbillException

getPartnerBalance
```
double getPartnerBalance(String CorpNum)
                  throws PopbillException
```
연동 파트너의 잔여포인트 확인

Parameters:

CorpNum - Member's CorpNum

Returns:

Partner's RemainPoint

Throws:

PopbillException

joinMember
```
Response joinMember(JoinForm joinInfo)
             throws PopbillException
```
연동회원 가입요청.

Parameters:

joinInfo - Join Information. see JoinForm

Returns:

Response of Join Process.

Throws:

PopbillException

See Also:

JoinForm

getPopbillURL
```
String getPopbillURL(String CorpNum,
                     String TOGO)
              throws PopbillException
```
팝빌의 SSO 접근 URL 요청.

Parameters:

CorpNum - Member's CorpNum

TOGO - Word to wanna go.

Returns:

Popbill' url with token.

Throws:

PopbillException

getPopbillURL

String getPopbillURL(String CorpNum,
                     String UserID,
                     String TOGO)
              throws PopbillException

팝빌의 SSO 접근 URL 요청.

Parameters:: CorpNum - Member's CorpNum; UserID - UserID to login.; TOGO - Word to wanna go.
Returns:: Popbill' url with token.
Throws:: PopbillException

getPartnerURL
```
String getPartnerURL(String CorpNum,
                     String TOGO)
              throws PopbillException
```
파트너 관리자 팝업 URL 요청

Parameters:

CorpNum - 팝빌회원 사업자번호

TOGO - CHRG(포인트충전), LOGIN(로그인)

Returns:

파트너관리자 URL

Throws:

PopbillException

getUseHistory

UseHistoryResult getUseHistory(String CorpNum,
                               String SDate,
                               String EDate,
                               Integer Page,
                               Integer PerPage,
                               String Order)
                        throws PopbillException

포인트 사용내역 확인

Parameters:: CorpNum - 사업자번호; SDate - 조회 기간의 시작일자; EDate - 조회 기간의 종료일자; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000); Order - 거래일자를 기준으로 하는 목록 정렬 방향
Returns:
Throws:: PopbillException

getUseHistory

UseHistoryResult getUseHistory(String CorpNum,
                               String SDate,
                               String EDate,
                               Integer Page,
                               Integer PerPage,
                               String Order,
                               String UserID)
                        throws PopbillException

포인트 사용내역 확인

Parameters:: CorpNum - 사업자번호; SDate - 조회 기간의 시작일자; EDate - 조회 기간의 종료일자; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000); Order - 거래일자를 기준으로 하는 목록 정렬 방향; UserID - 팝빌회원 아이디
Returns:
Throws:: PopbillException

getPaymentHistory

PaymentHistoryResult getPaymentHistory(String CorpNum,
                                       String SDate,
                                       String EDate,
                                       Integer Page,
                                       Integer PerPage)
                                throws PopbillException

포인트 결제내역 확인.

Parameters:: CorpNum - 사업자번호; SDate - 조회 기간의 시작일자; EDate - 조회 기간의 종료일자; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000)
Returns:
Throws:: PopbillException

getPaymentHistory

PaymentHistoryResult getPaymentHistory(String CorpNum,
                                       String SDate,
                                       String EDate,
                                       Integer Page,
                                       Integer PerPage,
                                       String UserID)
                                throws PopbillException

포인트 결제내역 확인.

Parameters:: CorpNum - 사업자번호; SDate - 조회 기간의 시작일자; EDate - 조회 기간의 종료일자; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000); UserID - 팝빌회원 아이디
Returns:
Throws:: PopbillException

getRefundHistory

RefundHistoryResult getRefundHistory(String CorpNum,
                                     Integer Page,
                                     Integer PerPage)
                              throws PopbillException

환분신청 내역 확인.

Parameters:: CorpNum - 사업자번호; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000)
Returns:
Throws:: PopbillException

getRefundHistory

RefundHistoryResult getRefundHistory(String CorpNum,
                                     Integer Page,
                                     Integer PerPage,
                                     String UserID)
                              throws PopbillException

환분신청 내역 확인.

Parameters:: CorpNum - 사업자번호; Page - 목록 페이지번호 (기본값 1); PerPage - 페이지당 표시할 목록 개수 (기본값 500, 최대 1000); UserID - 팝빌회원 아이디
Returns:
Throws:: PopbillException

refund

RefundResponse refund(String CorpNum,
                      RefundForm refundForm)
               throws PopbillException

환불 신청.

Parameters:: CorpNum - 사업자번호; refundForm - 환불 신청 정보
Returns:: Response
Throws:: PopbillException

refund

RefundResponse refund(String CorpNum,
                      RefundForm refundForm,
                      String UserID)
               throws PopbillException

환불 신청.

Parameters:: CorpNum - 사업자번호; refundForm - 환불 신청 정보; UserID - 팝빌회원 아이디
Returns:: Response
Throws:: PopbillException

getRefundInfo

RefundHistory getRefundInfo(String CorpNum,
                            String RefundCode)
                     throws PopbillException

환불신청 상태확인

Parameters:: CorpNum - 사업자번호; RefundCode - 환불코드
Returns:: RefundHistory
Throws:: PopbillException

getRefundInfo

RefundHistory getRefundInfo(String CorpNum,
                            String RefundCode,
                            String UserID)
                     throws PopbillException

환불신청 상태확인

Parameters:: CorpNum - 사업자번호; RefundCode - 환불코드; UserID - 회원아이디
Returns:: RefundHistory
Throws:: PopbillException

paymentRequest

PaymentResponse paymentRequest(String CorpNum,
                               PaymentForm paymentForm)
                        throws PopbillException

무통장 입금신청.

Parameters:: CorpNum - 사업자번호; paymentForm - 무통장입금 신청 정보
Returns:: Payment
Throws:: PopbillException

paymentRequest

PaymentResponse paymentRequest(String CorpNum,
                               PaymentForm paymentForm,
                               String UserID)
                        throws PopbillException

무통장 입금신청.

Parameters:: CorpNum - 사업자번호; paymentForm - 무통장입금 신청 정보; UserID - 팝빌회원 아이디
Returns:: Payment
Throws:: PopbillException

getSettleResult

PaymentHistory getSettleResult(String CorpNum,
                               String settleCode)
                        throws PopbillException

무통장 입금신청 정보확인.

Parameters:: CorpNum - 사업자번호; settleCode - 정산코드
Returns:: SettleResult
Throws:: PopbillException

getSettleResult

PaymentHistory getSettleResult(String CorpNum,
                               String settleCode,
                               String UserID)
                        throws PopbillException

무통장 입금신청 정보확인.

Parameters:: CorpNum - 사업자번호; settleCode - 정산코드; UserID - 팝빌회원 아이디
Returns:: SettleResult
Throws:: PopbillException

checkIsMember
```
Response checkIsMember(String CorpNum,
                       String LinkID)
                throws PopbillException
```
연동회원의 가입여부 확인.

Parameters:

CorpNum - CorpNum to Check.

UserID - USerID to Check.

Returns:

CorpNum is Member or not.

Throws:

PopbillException

getContactInfo

ContactInfo getContactInfo(String CorpNum,
                           String contactID)
                    throws PopbillException

담당자 정보확인.

Parameters:: CorpNum - CorpNum to Check.; ContactID - ContactID to Check.
Returns:
Throws:: PopbillException

getContactInfo

ContactInfo getContactInfo(String CorpNum,
                           String contactID,
                           String UserID)
                    throws PopbillException

담당자 정보확인.

Parameters:: CorpNum - CorpNum to Check.; ContactID - ContactID to Check.; UserID - UserID to Check.
Returns:
Throws:: PopbillException

listContact
```
ContactInfo[] listContact(String CorpNum)
                   throws PopbillException
```
담당자 목록조회

Parameters:

CorpNum - Member's CorpNum

Returns:

Contact member list

Throws:

PopbillException

listContact

ContactInfo[] listContact(String CorpNum,
                          String UserID)
                   throws PopbillException

담당자 목록조회

Parameters:: CorpNum - Member's CorpNum; UserID - UserID to Check
Returns:: Contact member list
Throws:: PopbillException

updateContact

Response updateContact(String CorpNum,
                       ContactInfo contactInfo,
                       String UserID)
                throws PopbillException

담당자 정보수정

Parameters:: CorpNum - Member's CorpNum; ContactInfo - Contact's Information. see ContactInfo; UserID - UserID to Check
Returns:: Contact Info Update success or fail.
Throws:: PopbillException

registContact
```
Response registContact(String CorpNum,
                       ContactInfo contactInfo)
                throws PopbillException
```
담당차 등록

Parameters:

CorpNum - Member's CorpNum

ContactInfo - Contact's Infomation. see ContactInfo

Returns:

Response of RegistContact process.

Throws:

PopbillException

registContact

Response registContact(String CorpNum,
                       ContactInfo contactInfo,
                       String UserID)
                throws PopbillException

담당차 등록

Parameters:: CorpNum - Member's CorpNum; ContactInfo - Contact's Infomation. see ContactInfo; UserID - Member's UserID
Returns:: Response of RegistContact process.
Throws:: PopbillException

checkID
```
Response checkID(String id)
          throws PopbillException
```
팝빌회원 아이디 중복체크

Parameters:

id -

Returns:

Response of ID is using

Throws:

PopbillException

getCorpInfo
```
CorpInfo getCorpInfo(String CorpNum)
              throws PopbillException
```
회사정보 확인

Parameters:

CorpNum - Member's CorpNum

Returns:

CorpInfo. see CorpInfo

Throws:

PopbillException

getCorpInfo

CorpInfo getCorpInfo(String CorpNum,
                     String UserID)
              throws PopbillException

회사정보 확인

Parameters:: CorpNum - Member's CorpNum; UserID - Member's UserID
Returns:: CorpInfo. see CorpInfo
Throws:: PopbillException

updateCorpInfo
```
Response updateCorpInfo(String CorpNum,
                        CorpInfo corpInfo)
                 throws PopbillException
```
회사정보 수정

Parameters:

CorpNum - Member's CorpNum

corpInfo - CorpInfo. see CorpInfo

Returns:

CorpInfo's Information updating success or not.

Throws:

PopbillException

updateCorpInfo

Response updateCorpInfo(String CorpNum,
                        CorpInfo corpInfo,
                        String UserID)
                 throws PopbillException

회사정보 수정

Parameters:: CorpNum - Member's CorpNum; corpInfo - CorpInfo. see CorpInfo; UserID - Member's UserID
Returns:: CorpInfo's Information updating success or not.
Throws:: PopbillException

getAccessURL
```
String getAccessURL(String CorpNum,
                    String UserID)
             throws PopbillException
```
팝빌 로그인 URL

Parameters:

CorpNum - 연동회원 사업자번호

UserID - 연동회원 유저아이디

Returns:

팝빌 URL (AccessToken값 포함. Token값은 응답후 30초까지만 유효함)

Throws:

PopbillException

getChargeURL
```
String getChargeURL(String CorpNum,
                    String UserID)
             throws PopbillException
```
연동회원 포인트충전 팝업 URL

Parameters:

CorpNum - 연동회원 사업자번호

UserID - 연동회원 유저아이디

Returns:

팝빌 URL (AccessToken값 포함. Token값은 응답후 30초까지만 유효함)

Throws:

PopbillException

getPaymentURL
```
String getPaymentURL(String CorpNum,
                     String UserID)
              throws PopbillException
```
연동회원 포인트 결재내역 팝업 URL

Parameters:

CorpNum - 연동회원 사업자번호

UserID - 연동회원 유저아이디

Returns:

팝빌 URL (AccessToken값 포함. Token값은 응답후 30초까지만 유효함)

Throws:

PopbillException

getUseHistoryURL
```
String getUseHistoryURL(String CorpNum,
                        String UserID)
                 throws PopbillException
```
연동회원 포인트 사용내역 팝업 URL

Parameters:

CorpNum - 연동회원 사업자번호

UserID - 연동회원 유저아이디

Returns:

팝빌 URL (AccessToken값 포함. Token값은 응답후 30초까지만 유효함)

Throws:

PopbillException

quitMember

Response quitMember(String CorpNum,
                    String quitReason)
             throws PopbillException

회원탈퇴

Parameters:: CorpNum - 연동회원 사업자번호; quitReason - 탈퇴사유
Returns:
Throws:: PopbillException

quitMember

Response quitMember(String CorpNum,
                    String quitReason,
                    String UserID)
             throws PopbillException

회원탈퇴

Parameters:: CorpNum - 연동회원 사업자번호; quitReason - 탈퇴사유; UserID - 연동회원 아이디
Returns:
Throws:: PopbillException

getRefundableBalance
```
double getRefundableBalance(String CorpNum)
                     throws PopbillException
```
환불가능포인트 확인

Parameters:

CorpNum - 연동회원 사업자번호

Returns:

Throws:

PopbillException

getRefundableBalance

double getRefundableBalance(String CorpNum,
                            String UserID)
                     throws PopbillException

환불가능포인트 확인

Parameters:: CorpNum - 연동회원 사업자번호
Returns:
Throws:: PopbillException

Interface BaseService

Method Summary

Method Detail

getBalance

getPointInfo

getPartnerBalance

joinMember

getPopbillURL

getPopbillURL

getPartnerURL

getUseHistory

getUseHistory

getPaymentHistory

getPaymentHistory

getRefundHistory

getRefundHistory

refund

refund

getRefundInfo

getRefundInfo

paymentRequest

paymentRequest

getSettleResult

getSettleResult

checkIsMember

getContactInfo

getContactInfo

listContact

listContact

updateContact

registContact

registContact

checkID

getCorpInfo

getCorpInfo

updateCorpInfo

updateCorpInfo

getAccessURL

getChargeURL

getPaymentURL

getUseHistoryURL

quitMember

quitMember

getRefundableBalance

getRefundableBalance