6. 포인트 관리
6.1. GetUnitCost - 전송 단가 확인
- 카카오톡 전송시 과금되는 포인트 단가를 확인합니다.
Function GetUnitCost(CorpNum, KType)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| KType | String | 3 | Y |
카카오톡 전송유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
|
Return
String - 카카오톡 전송단가
Throws
6.2. GetChargeInfo - 과금정보 확인
- 팝빌 카카오톡 API 서비스 과금정보를 확인합니다.
Function GetChargeInfo(CorpNum, KType, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| KType | String | 3 | Y |
카카오톡 전송유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.3. GetBalance - 연동회원 잔여포인트 확인
- 연동회원의 잔여포인트를 확인합니다.
Function GetBalance(CorpNum)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
String - 연동회원 잔여포인트
Throws
6.4. GetChargeURL - 연동회원 포인트 충전 팝업 URL
- 연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
Function GetChargeURL(CorpNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
6.5. PaymentRequest - 연동회원 무통장 입금신청
- 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
Function paymentRequest(CorpNum, PaymentForm, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| PaymentForm | PaymentForm | - | Y | 입금신청 객체정보 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.6. GetSettleResult - 연동회원 무통장 입금신청 정보확인
- 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
Function getSettleResult(CorpNum, SettleCode, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SettleCode | String | 18 | Y |
정산코드
팝빌에서 임의 할당하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.7. GetPaymentHistory - 연동회원 포인트 결제내역 확인
- 연동회원의 포인트 결제내역을 확인합니다.
Function GetPaymentHistory(CorpNum, SDate, EDate, Page, PerPage, UserID)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
Throws
6.8. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL
- 연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
Function GetPaymentURL(CorpNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
6.9. GetUseHistory - 연동회원 포인트 사용내역 확인
- 연동회원의 포인트 사용내역을 확인합니다.
Function getUseHistory(CorpNum, SDate, EDate, Page, PerPage, Order, UserID)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 |
거래일자를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.10. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL
- 연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
Function GetUseHistoryURL(CorpNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
6.11. Refund - 연동회원 포인트 환불신청
- 연동회원 포인트를 환불 신청합니다.
Function Refund(CorpNum, RefundForm, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RefundForm | RefundForm | - | Y | 환불신청 객체정보 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.12. GetRefundHistory - 연동회원 포인트 환불내역 확인
- 연동회원의 포인트 환불신청내역을 확인합니다.
Function GetRefundHistory(CorpNum, Page, PerPage, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| Page | Integer | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | Integer | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.13. GetPartnerBalance - 파트너 잔여포인트 확인
- 파트너의 잔여포인트를 확인합니다.
Function GetPartnerBalance(CorpNum)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
String - 파트너 잔여포인트
Throws
6.14. GetPartnerURL - 파트너 포인트충전 팝업 URL
- 파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
Function GetPartnerURL(CorpNum, TOGO)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| TOGO | String | 4 | Y | 고정값 : "CHRG" |
Return
String - 요청에 대한 응답 URL
Throws
6.15. GetRefundInfo - 환불 신청 상태 조회
- 포인트 환불에 대한 상세정보 1건을 확인합니다.
Function GetRefundInfo(CorpNum, RefundCode, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RefundCode | String | 18 | Y | 환불코드 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
6.16. GetRefundableBalance - 환불 가능 포인트 조회
- 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
Function GetRefundableBalance(CorpNum, UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Double - 환불 가능 포인트