1. 포인트 관리
1.1. GetUnitCost - 전송 단가 확인
- 카카오톡 전송시 과금되는 포인트 단가를 확인합니다.
Single GetUnitCost(String CorpNum, KakaoType msgType)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| msgType | KakaoType | - | Y |
카카오톡 유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
|
Return
Single - 카카오톡 전송단가
Throws
1.2. GetChargeInfo - 과금정보 확인
- 팝빌 카카오톡 API 서비스 과금정보를 확인합니다.
ChargeInfo GetChargeInfo(String CorpNum, MessageType msgType, String UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| msgType | KakaoType | - | Y |
카카오톡 유형 (택 1)
ATS알림톡
FTS친구톡(텍스트)
FMS친구톡(이미지)
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.3. GetBalance - 연동회원 잔여포인트 확인
- 연동회원의 잔여포인트를 확인합니다.
Double GetBalance(String CorpNum)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
Double - 연동회원 잔여포인트
Throws
1.4. GetChargeURL - 연동회원 포인트 충전 팝업 URL
- 연동회원 포인트를 충전하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 800px / height = 700px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
String GetChargeURL(String CorpNum, String UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
1.5. GetUseHistory - 연동회원 포인트 사용내역 확인
- 연동회원의 포인트 사용내역을 확인합니다.
UseHistoryResult getUseHistory(String CorpNum, String SDate, String EDate, int? Page, int? PerPage, String Order, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SDate | String | 8 | Y |
검색 시작일자
형식 : yyyyMMdd
|
|
| EDate | String | 8 | Y |
검색 종료일자
형식 : yyyyMMdd
|
|
| Page | int? | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | int? | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| Order | String | 1 | N |
거래일자를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.6. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL
- 연동회원 포인트 사용내역 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
String GetUseHistoryURL(String CorpNum, String UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
1.7. PaymentRequest - 연동회원 무통장 입금신청
- 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
PaymentResponse paymentRequest(String CorpNum, PaymentForm PaymentForm, String UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| PaymentForm | PaymentForm | - | Y | 입금신청 객체정보 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.8. GetSettleResult - 연동회원 무통장 입금신청 정보확인
- 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
PaymentHistory getSettleResult(String CorpNum, String SettleCode, String UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SettleCode | String | 18 | Y |
정산코드
팝빌에서 임의 할당하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.9. GetPaymentHistory - 연동회원 포인트 결제내역 확인
- 연동회원의 포인트 결제내역을 확인합니다.
PaymentHistoryResult getPaymentHistory(String CorpNum, String SDate, String EDate, int? Page = null, int? PerPage = null, String UserID = null)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| SDate | String | 8 | Y |
검색 시작일자
형식 : yyyyMMdd
|
|
| EDate | String | 8 | Y |
검색 종료일자
형식 : yyyyMMdd
|
|
| Page | int? | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | int? | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.10. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL
- 연동회원 포인트 결제내역 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,200px (최소 800px) / height = 600px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
String GetPaymentURL(String CorpNum, String UserID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
1.11. Refund - 연동회원 포인트 환불신청
- 연동회원 포인트를 환불 신청합니다.
RefundResponse refund(String CorpNum, RefundForm RefundForm, String UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RefundForm | RefundForm | - | Y | 환불신청 객체정보 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.12. GetRefundHistory - 연동회원 포인트 환불내역 확인
- 연동회원의 포인트 환불신청내역을 확인합니다.
RefundHistoryResult getRefundHistory(String CorpNum, int? Page, int? PerPage, String UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| Page | int? | - | N |
목록 페이지번호
기본값 : 1
|
|
| PerPage | int? | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.13. GetRefundInfo - 환불 신청 상태 조회
- 포인트 환불에 대한 상세정보 1건을 확인합니다.
RefundHistory GetRefundInfo(String CorpNum, String RefundCode, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RefundCode | String | 18 | Y | 환불코드 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
1.14. GetRefundableBalance - 환불 가능 포인트 조회
- 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불 가능 포인트에서 제외됩니다.)
Double GetRefundableBalance(String CorpNum, String UserID) throws PopbillExceptionParameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
Return
Double - 환불 가능 포인트
Throws
1.15. GetPartnerBalance - 파트너 잔여포인트 확인
- 파트너의 잔여포인트를 확인합니다.
Double GetPartnerBalance(String CorpNum)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
Return
Double - 파트너 잔여포인트
Throws
1.16. GetPartnerURL - 파트너 포인트 충전 팝업 URL
- 파트너 포인트를 충전하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 800px / height = 700px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
String GetPartnerURL(String CorpNum, String TOGO)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| TOGO | String | 4 | Y | 고정값 : "CHRG" |
Return
String - 요청에 대한 응답 URL