POPBill Developers
API Reference

6. 포인트 관리

6.1. GetUnitCost - 전송 단가 확인

  • 카카오톡 전송시 과금되는 포인트 단가를 확인합니다.
kakaoService.getUnitCost(CorpNum, KakaoType, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
KakaoType KakaoType - Y 카카오톡 전송유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

string - 카카오톡 전송단가

Throws

PopbillException

6.2. GetChargeInfo - 과금정보 확인

  • 팝빌 카카오톡 API 서비스 과금정보를 확인합니다.
kakaoService.getChargeInfo(CorpNum, KakaoType, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
KakaoType KakaoType - Y 카카오톡 전송유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

ChargeInfo

Throws

PopbillException

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

  • 연동회원의 잔여포인트를 확인합니다.
kakaoService.getBalance(CorpNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

string - 연동회원 잔여포인트

Throws

PopbillException

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

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

string - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
kakaoService.getBalance(CorpNum, PaymentForm, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
PaymentForm PaymentForm - Y 입금신청 객체정보
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

PaymentResponse

Throws

PopbillException

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

  • 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
kakaoService.getSettleResult(CorpNum, SettleCode, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
SettleCode string 18 Y 정산코드
팝빌에서 임의 할당하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

PaymentHistory

Throws

PopbillException

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

  • 연동회원의 포인트 결제내역을 확인합니다.
kakaoService.GetPaymentHistory(CorpNum, SDate, EDate, Page, PerPage, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
SDate string 8 Y 조회 기간의 시작일자
형식 : yyyyMMdd
EDate string 8 Y 조회 기간의 종료일자
형식 : yyyyMMdd
Page number - N 목록 페이지번호
기본값 : 1
PerPage number - N 페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

PaymentHistoryResult

Throws

PopbillException

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

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

string - 요청에 대한 응답 URL

Throws

PopbillException

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

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

UseHistoryResult

Throws

PopbillException

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

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

string - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 연동회원 포인트를 환불 신청합니다.
kakaoService.refund(CorpNum, RefundForm, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
RefundForm RefundForm - Y 환불신청 객체정보
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

RefundResponse

Throws

PopbillException

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

  • 연동회원의 포인트 환불신청내역을 확인합니다.
kakaoService.getRefundHistory(CorpNum, Page, PerPage, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
Page number - N 목록 페이지번호
기본값 : 1
PerPage number - N 페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

RefundHistoryResult

Throws

PopbillException

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

  • 파트너의 잔여포인트를 확인합니다.
kakaoService.getPartnerBalance(CorpNum, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

string - 파트너 잔여포인트

Throws

PopbillException

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

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

string - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 포인트 환불에 대한 상세정보 1건을 확인합니다.
kakaoService.getRefundInfo(CorpNum, RefundCode, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
RefundCode String 18 Y 환불코드
UserID String 50 N 팝빌회원 아이디
success function - N 성공에 대한 콜백 함수
error function - N 실패에 대한 콜백 함수
Return

RefundHistory

Throws

PopbillException

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

  • 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
kakaoService.getRefundableBalance(CorpNum, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID String 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

string - 환불 가능 포인트

Throws

PopbillException