4. 포인트 관리
4.1. GetFlatRateState - 정액제 서비스 상태 확인
- 홈택스연동 정액제 서비스 상태를 확인합니다.
def getFlatRateState(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.2. GetFlatRatePopUpURL - 정액제 서비스 신청 팝업 URL
- 홈택스연동 정액제 서비스 신청 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getFlatRatePopUpURL(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
str - 요청에 대한 응답 URL
Throws
4.3. GetChargeInfo - 과금정보 확인
- 팝빌 홈택스연동 API 서비스 과금정보를 확인합니다.
def getChargeInfo(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.4. GetBalance - 연동회원 잔여포인트 확인
- 연동회원의 잔여포인트를 확인합니다.
def getBalance(CorpNum):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
float - 연동회원 잔여포인트
Throws
4.5. GetChargeURL - 연동회원 포인트 충전 팝업 URL
- 연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getChargeURL(CorpNum, UserID):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
str - 요청에 대한 응답 URL
Throws
4.6. PaymentRequest - 연동회원 무통장 입금신청
- 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
def PaymentRequest(CorpNum, PaymentForm, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
PaymentForm | PaymentForm | - | Y | 입금신청 객체정보 | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.7. GetSettleResult - 연동회원 무통장 입금신청 정보확인
- 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
def getSettleResult(CorpNum, SettleCode, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
SettleCode | str | 18 | Y |
정산코드
팝빌에서 임의 할당하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
|
|
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.8. GetPaymentHistory - 연동회원 포인트 결제내역 확인
- 연동회원의 포인트 결제내역을 확인합니다.
def GetPaymentHistory(CorpNum, SDate, EDate, Page=None, PerPage=None, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
SDate | str | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
EDate | str | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
Page | int | - | N |
목록 페이지번호
기본값 : 1
|
|
PerPage | int | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.9. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL
- 연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPaymentURL(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
str - 요청에 대한 응답 URL
Throws
4.10. GetUseHistory - 연동회원 포인트 사용내역 확인
- 연동회원의 포인트 사용내역을 확인합니다.
def getUseHistory(CorpNum, SDate, EDate, Page=None, PerPage=None, Order=None, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
SDate | str | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
EDate | str | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
Page | int | - | N |
목록 페이지번호
기본값 : 1
|
|
PerPage | int | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
Order | str | 1 | N |
거래일자를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.11. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL
- 연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getUseHistoryURL(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
str - 요청에 대한 응답 URL
Throws
4.12. Refund - 연동회원 포인트 환불신청
- 연동회원 포인트를 환불 신청합니다.
def refund(CorpNum, RefundForm, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
RefundForm | RefundForm | - | Y | 환불신청 객체정보 | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.13. GetRefundHistory - 연동회원 포인트 환불내역 확인
- 연동회원의 포인트 환불신청내역을 확인합니다.
def getRefundHistory(CorpNum, Page=None, PerPage=None, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
Page | int | - | N |
목록 페이지번호
기본값 : 1
|
|
PerPage | int | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.14. GetPartnerBalance - 파트너 잔여포인트 확인
- 파트너의 잔여포인트를 확인합니다.
def getPartnerBalance(CorpNum):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
float - 파트너 잔여포인트
Throws
4.15. GetPartnerURL - 파트너 포인트충전 팝업 URL
- 파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPartnerURL(CorpNum, TOGO):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
TOGO | str | 4 | Y | 고정값 : "CHRG" |
Return
str - 요청에 대한 응답 URL
Throws
4.16. GetRefundInfo - 환불 신청 상태 조회
- 포인트 환불에 대한 상세정보 1건을 확인합니다.
def GetRefundInfo(CorpNum, RefundCode, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
RefundCode | str | 18 | Y | 환불코드 | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
Throws
4.17. GetRefundableBalance - 환불 가능 포인트 조회
- 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
def GetRefundableBalance(CorpNum, UserID=None):
Parameters
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
CorpNum | str | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
UserID | str | 50 | N | 팝빌회원 아이디 |
Return
float - 환불 가능 포인트