POPBill Developers
API Reference

4. 정액제 신청 / 포인트 관리

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

  • 계좌조회 정액제 서비스 상태를 확인합니다.
FlatRateState getFlatRateState(String CorpNum, String BankCode, String AccountNumber, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
BankCode String 4 Y 은행 기관코드
  • 0011농협
  • 0004국민은행
  • 0020우리은행
  • 0088신한은행
  • 0003기업은행
  • 0081하나은행
  • 0023SC은행
  • 0002산업은행
  • 0027씨티은행
  • 0031대구은행
  • 0032부산은행
  • 0039경남은행
  • 0034광주은행
  • 0037전북은행
  • 0035제주은행
  • 0071우체국
  • 0045새마을금고
  • 0048신협
  • 0007수협
AccountNumber String 30 Y 은행 계좌번호(하이픈 '-' 제외)
UserID String 50 N 팝빌회원 아이디
Return

FlatRateState

Throws

PopbillException

4.2. GetFlatRatePopUpURL - 정액제 서비스 신청 팝업 URL

  • 계좌조회 정액제 서비스 신청 페이지의 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
String getFlatRatePopUpURL(String CorpNum, String UserID) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.3. GetChargeInfo - 과금정보 확인

  • 팝빌 계좌조회 API 서비스 과금정보를 확인합니다.
ChargeInfo getChargeInfo(String CorpNum) throws PopbillException
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
Return

ChargeInfo

Throws

PopbillException

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

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

double - 연동회원 잔여포인트

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

PaymentResponse

Throws

PopbillException

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

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

PaymentHistory

Throws

PopbillException

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

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

PaymentHistoryResult

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

UseHistoryResult

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

RefundResponse

Throws

PopbillException

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

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

RefundHistoryResult

Throws

PopbillException

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

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

double - 파트너 잔여포인트

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

RefundHistory

Throws

PopbillException

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

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

double - 환불 가능 포인트

Throws

PopbillException