POPBill Developers
API Reference

2. 포인트 관리

2.1. GetUnitCost - 조회 단가 확인

  • 휴폐업 조회시 과금되는 포인트 단가를 확인합니다.
Single GetUnitCost(String CorpNum)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Return

Single - 휴폐업 조회단가

Throws

PopbillException

2.2. GetChargeInfo - 과금정보 확인

  • 팝빌 휴폐업조회 API 서비스 과금정보를 확인합니다.
ChargeInfo GetChargeInfo(String CorpNum, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

ChargeInfo

Throws

PopbillException

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

  • 연동회원의 잔여포인트를 확인합니다.
Double GetBalance(String CorpNum)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Return

Double - 연동회원 잔여포인트

Throws

PopbillException

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

  • 연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String GetChargeURL(String CorpNum, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String GetUseHistoryURL(String CorpNum, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 파트너의 잔여포인트를 확인합니다.
Double GetPartnerBalance(String CorpNum)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Return

Double - 파트너 잔여포인트

Throws

PopbillException

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

  • 파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String GetPartnerURL(String CorpNum, String TOGO)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
TOGO String 4 Y "CHRG" 입력
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

2.8. PaymentRequest - 연동회원 무통장 입금신청

  • 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
PaymentResponse paymentRequest(String CorpNum, PaymentForm PaymentForm, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
PaymentForm PaymentForm - Y 입금신청 객체정보
UserID String 50 N 팝빌회원 아이디
Return

PaymentResponse

Throws

PopbillException

2.9. GetSettleResult - 연동회원 무통장 입금신청 정보확인

  • 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
PaymentHistory getSettleResult(String CorpNum, String SettleCode, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
SettleCode String 18 Y 정산코드
└ 팝빌에서 임의 부여하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
UserID String 50 N 팝빌회원 아이디
Return

PaymentHistory

Throws

PopbillException

2.10. GetPaymentHistory - 연동회원 포인트 결제내역 확인

  • 연동회원의 포인트 결제내역을 확인합니다.
PaymentHistoryResult getPaymentHistory(String CorpNum, String SDate, String EDate, int? Page, int? PerPage, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
SDate String 8 Y 조회 기간의 시작일자 (형식 : yyyyMMdd)
EDate String 8 Y 조회 기간의 종료일자 (형식 : yyyyMMdd)
Page int? - N 목록 페이지번호 (기본값 1)
PerPage int? - N 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
UserID String 50 N 팝빌회원 아이디
Return

PaymentHistoryResult

Throws

PopbillException

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

  • 연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String GetPaymentURL(String CorpNum, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

2.12. GetUseHistory - 연동회원 포인트 사용내역 확인

  • 연동회원의 포인트 사용내역을 확인합니다.
UseHistoryResult getUseHistory(String CorpNum, String SDate, String EDate, int? Page, int? PerPage, String Order, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
SDate String 8 Y 조회 기간의 시작일자 (형식 : yyyyMMdd)
EDate String 8 Y 조회 기간의 종료일자 (형식 : yyyyMMdd)
Page int? - N 목록 페이지번호 (기본값 1)
PerPage int? - N 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
Order String 1 N 거래일자를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ "D" : 내림차순
└ "A" : 오름차순
※ 미입력시 기본값 "D" 처리
UserID String 50 N 팝빌회원 아이디
Return

UseHistoryResult

Throws

PopbillException

2.13. GetRefundInfo - 환불 신청 상태 조회

  • 포인트 환불에 대한 상세정보 1건을 확인합니다.
RefundHistory GetRefundInfo(String CorpNum, String RefundCode, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
RefundCode String 18 Y 환불코드
UserID String 50 N 팝빌회원 아이디
Return

RefundHistory

Throws

PopbillException

2.14. GetRefundableBalance - 환불 가능 포인트 조회

  • 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
Double GetRefundableBalance(String CorpNum, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

Double - 환불 가능 포인트

Throws

PopbillException

2.15. Refund - 연동회원 포인트 환불신청

  • 연동회원 포인트를 환불 신청합니다.
 RefundResponse refund(String CorpNum, RefundForm RefundForm, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
RefundForm RefundForm - Y 환불신청 객체정보
UserID String 50 N 팝빌회원 아이디
Return

RefundResponse

Throws

PopbillException

2.16. GetRefundHistory - 연동회원 포인트 환불내역 확인

  • 연동회원의 포인트 환불신청내역을 확인합니다.
 RefundHistoryResult getRefundHistory(String CorpNum, int? Page, int? PerPage, String UserID)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Page int? - N 목록 페이지번호 (기본값 1)
PerPage int? - N 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
UserID String 50 N 팝빌회원 아이디
Return

RefundHistoryResult

Throws

PopbillException