POPBill Developers
API Reference

4. 포인트 관리

4.1. GetUnitCost - 전송 단가 확인

  • 팩스 전송시 과금되는 포인트 단가를 확인합니다.
function GetUnitCost($CorpNum, $ReceiveNumType = null)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
ReceiveNumType String 2 N 수신번호 유형 : "일반" / "지능" 중 택 1
└ 일반망 : 지능망을 제외한 번호
└ 지능망 : 030*, 050*, 070*, 080*, 대표번호
Return

String - 팩스 전송단가

Throws

PopbillException

4.2. GetChargeInfo - 과금정보 확인

  • 팝빌 팩스 API 서비스 과금정보를 확인합니다.
function GetChargeInfo ($CorpNum, $UserID = null, $ReceiveNumType = null)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
UserID String 50 N 팝빌회원 아이디
ReceiveNumType String 2 N 수신번호 유형 : "일반" / "지능" 중 택 1
└ 일반망 : 지능망을 제외한 번호
└ 지능망 : 030*, 050*, 070*, 080*, 대표번호
Return

ChargeInfo

Throws

PopbillException

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

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

String - 연동회원 잔여포인트

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

PaymentResponse

Throws

PopbillException

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

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

PaymentHistory

Throws

PopbillException

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

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

PaymentHistoryResult

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

UseHistoryResult

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

RefundResponse

Throws

PopbillException

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

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

RefundHistoryResult

Throws

PopbillException

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

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

String - 파트너 잔여포인트

Throws

PopbillException

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

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

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

RefundHistory

Throws

PopbillException

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

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

String - 환불 가능 포인트

Throws

PopbillException