API Reference 예금주조회 ASP 포인트 관리
2.1. GetUnitCost - 조회 단가 확인
- 예금주 조회시 과금되는 포인트 단가를 확인합니다.
Function GetUnitCost(CorpNum, ServiceType, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
ServiceType |
String |
2 |
Y |
서비스 유형 : "성명" / "실명" 중 택 1 |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
String - 예금주 조회단가
Throws
Err
2.2. GetChargeInfo - 과금정보 확인
- 팝빌 예금주조회 API 서비스 과금정보를 확인합니다.
Function GetChargeInfo(CorpNum, UserID, ServiceType)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
|
ServiceType |
String |
2 |
Y |
서비스 유형 : "성명" / "실명" 중 택 1 |
Return
ChargeInfo
Throws
Err
2.3. GetBalance - 연동회원 잔여포인트 확인
Function GetBalance(CorpNum)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
Return
String - 연동회원 잔여포인트
Throws
Err
2.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
Err
2.5. PaymentRequest - 연동회원 무통장 입금신청
- 연동회원 포인트 충전을 위해 무통장입금을 신청합니다.
Function paymentRequest(CorpNum, PaymentForm, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
PaymentForm |
PaymentForm |
- |
Y |
입금신청 객체정보 |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
PaymentResponse
Throws
Err
2.6. GetSettleResult - 연동회원 무통장 입금신청 정보확인
- 연동회원 포인트 무통장 입금신청내역 1건을 확인합니다.
Function getSettleResult(CorpNum, SettleCode, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
SettleCode |
String |
18 |
Y |
정산코드
└ 팝빌에서 임의 부여하는 값으로 [PaymentRequest - 연동회원 무통장 입금신청] 호출시 반환되는 값
|
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
PaymentHistory
Throws
Err
2.7. GetPaymentHistory - 연동회원 포인트 결제내역 확인
Function GetPaymentHistory(CorpNum, SDate, EDate, Page, PerPage, UserID)
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
Err
2.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
Err
2.9. GetUseHistory - 연동회원 포인트 사용내역 확인
Function getUseHistory(CorpNum, SDate, EDate, Page, PerPage, Order, UserID)
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
Err
2.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
Err
2.11. Refund - 연동회원 포인트 환불신청
Function Refund(CorpNum, RefundForm, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
RefundForm |
RefundForm |
- |
Y |
환불신청 객체정보 |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
RefundResponse
Throws
Err
2.12. GetRefundHistory - 연동회원 포인트 환불내역 확인
Function GetRefundHistory(CorpNum, Page, PerPage, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
Page |
Integer |
- |
N |
목록 페이지번호 (기본값 1) |
|
PerPage |
Integer |
- |
N |
페이지당 표시할 목록 개수 (기본값 500, 최대 1,000) |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
RefundHistoryResult
Throws
Err
2.13. GetPartnerBalance - 파트너 잔여포인트 확인
Function GetPartnerBalance(CorpNum)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
Return
String - 파트너 잔여포인트
Throws
Err
2.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
Err
2.15. GetRefundInfo - 환불 신청 상태 조회
- 포인트 환불에 대한 상세정보 1건을 확인합니다.
Function GetRefundInfo(CorpNum, RefundCode, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
RefundCode |
String |
18 |
Y |
환불코드 |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
RefundHistory
Throws
Err
2.16. GetRefundableBalance - 환불 가능 포인트 조회
- 환불 가능한 포인트를 확인합니다. (보너스 포인트는 환불가능포인트에서 제외됩니다.)
Function GetRefundableBalance(CorpNum, UserID)
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
String |
10 |
Y |
팝빌회원 사업자번호 (하이픈 '-' 제외 10자리) |
|
UserID |
String |
50 |
N |
팝빌회원 아이디 |
Return
Double - 환불 가능 포인트
Throws
Err
