사이다페이 Developers

본문내용

회원 API

웹 로그인 키 생성

get

판매자 사이트에 로그인 할 수 있는 키를 생성합니다.

https://api.ciderpay.com/oapi/pmember/makeWebKey

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디

생성할 회원 아이디 (개발사 아이디의 하위 계정만 가능)

success

BOOLEAN 필수

성공 여부

API 성공 여부
message

STRING

메시지

API 응답 메시지
var1

STRING 필수

토큰값

웹 로그인이 가능한 토큰값

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/pmember/makeWebKey")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("memberID", "") // 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

하위 회원 결제 토큰 조회

get

개발사 상위로 지정된 하위 회원의 토큰값을 조회할 수 있는 API

https://api.ciderpay.com/oapi/pmember/childToken

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

조회할 회원 아이디

토큰을 조회할 회원 아이디

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

OBJECT 필수

토큰

API 성공시 회원의 토큰값
- approvalToken
  
  STRING 필수
  
  결제 토큰
  
  결제 토큰
- feedbackToken
  
  STRING 필수
  
  피드백 토큰
  
  결제 취소등에서 사용되는 토큰

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/pmember/childToken")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("memberID", "") // 조회할 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

하위 회원 패스워드 변경

post

개발사 상위로 지정된 하위 회원의 패스워드를 변경하는 API

https://api.ciderpay.com/oapi/pmember/changeMemberSubPasswd

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

하위 회원 아이디

패스워드를 변경할 하위 회원 아이디
newPasswd

STRING 필수

새 비밀번호

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/pmember/changeMemberSubPasswd")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.field("memberID", "") // 하위 회원 아이디
.field("newPasswd", "") // 새 비밀번호
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

영중소 조회

get

https://api.ciderpay.com/oapi/pmember/companyScale

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

bizNo

STRING 필수

사업자 번호

사업자 번호 (숫자만 입력)

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

var1

STRING 필수

영중소 레벨

허용값 리스트
0	영세
1	중소1
2	중소2
3	중소3
4	일반

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/pmember/companyScale")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("bizNo", "") // 사업자 번호
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

결제 링크 API

결제링크 등록

post

https://api.ciderpay.com/oapi/paymentLink

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 ID

판매점 회원 ID
paymentCompleteStr

STRING

결제완료 메시지

결제 완료 후, 구매자에게 보여줄 메시지
goodsName

STRING 필수

상품명
goodsPrice

NUMBER 필수

가격

1,000 ~ 99,999,999
useDiscount

BOOLEAN 필수

할인율 사용여부
discountPercent

NUMBER

할인율 퍼센트

할인율 사용 시, 필수로 입력
goodsUrl

STRING

상품 안내 URL
goodsDescription

STRING 필수

상품 설명

taxType

STRING 필수

과세/면세

허용값 리스트
TAX	과세
FREE	면세

usePayMemoToSeller

BOOLEAN

구매자 결제메모 사용여부

구매자가 결제 시, 메모를 입력할 수 있도록 허용
requiredPayMemo

BOOLEAN

구매자 결제메모 필수 여부

구매자가 결제 메모를 필수로 입력하도록 유도
payMemoPlaceholder

STRING

결제 메모 입력창의 placeholder 내용
usePriceInput

BOOLEAN

구매자 가격입력 허용 여부

구매자가 직접 가격을 입력하도록 허용
useBuyerName

BOOLEAN

구매자 이름 입력 여부

구매자가 이름을 입력할수 있도록 허용
useAddr

BOOLEAN

구매자 주소 입력 여부

구매자가 주소를 입력할 수 있도록 허용
stockInfo

OBJECT 필수

재고 정보
- use
  
  BOOLEAN 필수
  
  재고 사용 여부
- stockCnt
  
  NUMBER
  
  재고 수량
  
  재고 사용 시, 필수 입력
buyAmount

OBJECT 필수

구매 가능 수량 정보
- use
  
  BOOLEAN 필수
  
  구매 가능 수량 사용 여부
- minAmount
  
  NUMBER
  
  최소 구매 수량
  
  사용 시, 필수 입력
  최대 수량보다 작게 입력
- maxAmount
  
  STRING
  
  최대 구매 수량
  
  사용 시, 필수 입력
  최소 수량보다 크게 입력
deliveryPrice

OBJECT 필수

배송 요금 정보
- use
  
  BOOLEAN 필수
  
  사용 여부
- price
  
  NUMBER
  
  배송 요금
  
  배송 요금 사용 시, 필수 입력
- useFree
  
  BOOLEAN
  
  무료 배송 여부
  
  지정된 가격 이상 주문 시, 무료 배송 여부
- conditionalFreePrice
  
  NUMBER
  
  배송비 무료 기준 금액
  
  무료 배송 여부 사용 시, 필수 입력
imageFiles

ARRAY

이미지 리스트

등록할 상품 이미지 리스트 (Object Array)
- fileName
  
  STRING 필수
  
  파일명
- encodeBase64
  
  STRING 필수
  
  base64 string
  
  이미지 파일 데이터를 base64로 인코딩한 문자열
returnUrl

STRING

돌아가기 URL

결제 완료시 돌아가기 URL 을 설정합니다.
feedbackUrl

STRING

결제 완료시 피드백 받을 주소

결제 완료시 결제 정보에 대한 피드백 주소 입니다. 결제 요청 feedbackUrl 과 같은 용도 입니다.
var1

STRING

피드백 시 추가 변수 1

피드백 시 추가 변수 1
var2

STRING

피드백 시 추가 변수 2

피드백 시 추가 변수 2

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

STRING 필수

링크 URL

등록된 결제링크의 URL

errCode

STRING

에러 코드
message

STRING

에러 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 ID
paramMap.put ("paymentCompleteStr", "");	// 결제완료 메시지
paramMap.put ("goodsName", "");	// 상품명
paramMap.put ("goodsPrice", "");	// 가격
paramMap.put ("useDiscount", "");	// 할인율 사용여부
paramMap.put ("discountPercent", "");	// 할인율 퍼센트
paramMap.put ("goodsUrl", "");	// 상품 안내 URL
paramMap.put ("goodsDescription", "");	// 상품 설명
paramMap.put ("taxType", "");	// 과세/면세
paramMap.put ("usePayMemoToSeller", "");	// 구매자 결제메모 사용여부
paramMap.put ("requiredPayMemo", "");	// 구매자 결제메모 필수 여부
paramMap.put ("payMemoPlaceholder", "");	// 결제 메모 입력창의 placeholder 내용
paramMap.put ("usePriceInput", "");	// 구매자 가격입력 허용 여부
paramMap.put ("useBuyerName", "");	// 구매자 이름 입력 여부
paramMap.put ("useAddr", "");	// 구매자 주소 입력 여부
paramMap.put ("stockInfo", "");	// 재고 정보
paramMap.put ("buyAmount", "");	// 구매 가능 수량 정보
paramMap.put ("deliveryPrice", "");	// 배송 요금 정보
paramMap.put ("imageFiles", "");	// 이미지 리스트
paramMap.put ("returnUrl", "");	// 돌아가기 URL
paramMap.put ("feedbackUrl", "");	// 결제 완료시 피드백 받을 주소
paramMap.put ("var1", "");	// 피드백 시 추가 변수 1
paramMap.put ("var2", "");	// 피드백 시 추가 변수 2

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/paymentLinknull")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

결제링크 삭제

delete

링크 결제를 삭제합니다.

개발사 토큰이 링크 결제를 등록한 회원의 접근 권한이 있을 때만 삭제가 가능합니다

https://api.ciderpay.com/oapi/paymentLink/:id

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

id

STRING

링크 결제 아이디 (링크 결제 리스트 API 참조)

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.delete("https://api.ciderpay.com/oapi/paymentLink/:id")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("id", "") // 링크 결제 아이디 (링크 결제 리스트 API 참조)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

결제링크 조회

get

결제 링크 데이터를 조회 합니다.

https://api.ciderpay.com/oapi/paymentLink/list

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디

조회 하려는 회원 아이디

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

ARRAY 필수

결제 링크 항목
- id
  
  STRING 필수
  
  링크 아이디
- taxType
  
  STRING
  
  과세 타입
- usePayMemoToSeller
  
  BOOLEAN
  
  구매자 결제메모 표시 여부
- requiredPayMemo
  
  BOOLEAN
  
  구매자 결제메모 필수값 적용 여부
- payMemoPlaceholder
  
  STRING
  
  구매자 결제메모 placeHolder 문구
- usePriceInput
  
  BOOLEAN
  
  구매자 가격입력허용 여부
- useBuyerName
  
  BOOLEAN
  
  구매자 이름 요청 여부
- useAddr
  
  BOOLEAN
  
  구매자 주소 요청 여부
- paymentCompleteStr
  
  STRING
  
  결제완료 내용
- goodsInfos
  
  OBJECT
  
  상품 리스트
  - goodsName
    
    STRING
    
    상품명
  - goodsPrice
    
    NUMBER
    
    상품 가격
  - useDiscount
    
    BOOLEAN
    
    할인율 사용여부
  - discountPercent
    
    NUMBER
    
    할인율 퍼센트
  - goodsDescription
    
    STRING
    
    상품 설명
  - goodsUrl
    
    STRING
    
    상품 URL
  - useTax
    
    BOOLEAN
    
    과세 여부
  - useStock
    
    BOOLEAN
    
    재고 사용 여부
  - stockCnt
    
    NUMBER
    
    재고 수량
  - useAmount
    
    BOOLEAN
    
    구매 수량 사용여부
  - minAmount
    
    NUMBER
    
    최소 구매 수량
  - maxAmount
    
    NUMBER
    
    최대 구매 수량
  - useDelivery
    
    BOOLEAN
    
    배송요금 사용여부
  - deliPrice
    
    NUMBER
    
    배송 요금
  - useDeliFree
    
    BOOLEAN
    
    지정된 가격 이상 주문 시 무료 배송 여부
  - conditionalFreePrice
    
    NUMBER
    
    배송비 무료 기준 금액

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/paymentLink/list")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("memberID", "") // 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

상품 API

상품 등록

post

판매상품 등록 API

https://api.ciderpay.com/oapi/goods

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디
goodsName

STRING 필수

상품 이름
goodsPrice

NUMBER 필수

상품 가격
useTax

BOOLEAN 필수

과세 여부
imageFile

OBJECT

상품 이미지 파일
- fileName
  
  STRING
  
  파일명
- encodeBase64
  
  STRING
  
  인코딩된 파일
  
  base64로 인코딩된 파일 데이터

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

STRING 필수

상품 ID

등록된 상품 데이터 ID

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("goodsName", "");	// 상품 이름
paramMap.put ("goodsPrice", "");	// 상품 가격
paramMap.put ("useTax", "");	// 과세 여부
paramMap.put ("imageFile", "");	// 상품 이미지 파일

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/goods")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

상품 조회

get

판매상품 조회 API

https://api.ciderpay.com/oapi/goods/{id}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

id

STRING

상품 데이터 ID

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

OBJECT 필수

상품 데이터

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/goods/{id}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("id", "") // 상품 데이터 ID
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

상품 수정

put

판매상품 수정 API

https://api.ciderpay.com/oapi/goods/{id}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

id

STRING

상품 데이터의 id

goodsName

STRING

상품명
goodsPrice

NUMBER

상품가격
useTax

BOOLEAN 필수

과세여부
imageFile

OBJECT

이미지 파일
- fileName
  
  STRING
  
  파일명
- encodeBase64
  
  STRING
  
  인코딩된 파일
  
  base64로 인코딩된 파일 데이터

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("goodsName", "");	// 상품명
paramMap.put ("goodsPrice", "");	// 상품가격
paramMap.put ("useTax", "");	// 과세여부
paramMap.put ("imageFile", "");	// 이미지 파일

HttpResponse response = Unirest.put("https://api.ciderpay.com/oapi/goods/{id}")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("id", "") // 상품 데이터의 id
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

상품 삭제

delete

판매상품 삭제 API

https://api.ciderpay.com/oapi/goods/{id}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

id

STRING

상품 데이터 ID

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.delete("https://api.ciderpay.com/oapi/goods/{id}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("id", "") // 상품 데이터 ID
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

상품 페이징 리스트

get

https://api.ciderpay.com/oapi/goods/paging

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

page

NUMBER

페이지
size

NUMBER

페이지 당 데이터 개수
memberID

STRING

회원아이디 검색
memberIDLike

STRING

회원아이디 LIke 검색
goodsName

STRING

상품명 검색
goodsNameLike

STRING

상품명 Like 검색
goodsPrice

NUMBER

상품가격 검색
useTax

BOOLEAN

과세타입
startDate

STRING

등록날짜 검색 범위 시작날짜

yyyy-MM-dd
endDate

STRING

등록날짜 검색 범위 끝 날짜

yyyy-MM-dd

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

OBJECT 필수

페이징 데이터
- size
  
  NUMBER 필수
  
  페이지 당 데이터 개수
- number
  
  NUMBER 필수
  
  현재 페이지
- totalElements
  
  NUMBER 필수
  
  총 데이터 개수
- conent
  
  STRING 필수
  
  데이터 리스트

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/goods/paging")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("page", "") // 페이지
.queryString("size", "") // 페이지 당 데이터 개수
.queryString("memberID", "") // 회원아이디 검색
.queryString("memberIDLike", "") // 회원아이디 LIke 검색
.queryString("goodsName", "") // 상품명 검색
.queryString("goodsNameLike", "") // 상품명 Like 검색
.queryString("goodsPrice", "") // 상품가격 검색
.queryString("useTax", "") // 과세타입
.queryString("startDate", "") // 등록날짜 검색 범위 시작날짜
.queryString("endDate", "") // 등록날짜 검색 범위 끝 날짜
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

결제 API

결제 토큰 활성화

post

하위 판매점 결제 토큰 활성화 API

https://api.ciderpay.com/oapi/pv/payment/setPayTokenYn/{memberID}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

판매점 회원 아이디

payTokenYn

BOOLEAN 필수

토큰 활성화 여부

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
var1

STRING 필수

결제 토큰

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/pv/payment/setPayTokenYn/{memberID}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 판매점 회원 아이디
.field("payTokenYn", "") // 토큰 활성화 여부
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

부가세 조회 API

get

https://api.ciderpay.com/oapi/pv/payment/tax-doc

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 ID

부가세 자료 조회 해당 회원 ID
year

NUMBER 필수

년도

조회 년도

dateRangeType

STRING 필수

분기, 상/하반기

조회 분기 또는 상/하반기

허용값 리스트
Q1	1분기
Q2	2분기
Q3	3분기
Q4	4분기
HF	상반기
HS	하반기

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
data

OBJECT 필수

부가세 데이터
- dateTaxList
  
  ARRAY 필수
  
  날짜별 리스트
  
  매출월, 항목구분, 거래구분 별로 집계한 부가세 리스트
  - dateStr
    
    STRING 필수
    
    매출월
    
    yyyy년 mm월
  - payMethod
    
    STRING 필수
    
    항목구분
    
    신용카드, 휴대폰(휴대폰 결제 사용시에만), 현금영수증
  - payState
    
    STRING 필수
    
    거래구분
    
    승인, 취소, 합계
  - dataCnt
    
    NUMBER 필수
    
    거래건수
  - totalPrice
    
    NUMBER 필수
    
    거래금액
  - taxFreePrice
    
    NUMBER 필수
    
    면세
  - taxPriceSupply
    
    NUMBER 필수
    
    과세
  - scPrice
    
    NUMBER 필수
    
    봉사료
  - taxPriceVat
    
    NUMBER 필수
    
    부가세
- payMethodSumTaxList
  
  ARRAY 필수
  
  결제방법별 합계 리스트
  
  항목구분, 거래구분 별로 집계한 부가세 리스트
  - payMethod
    
    STRING 필수
    
    항목구분
    
    신용카드, 휴대폰(휴대폰 결제 사용시에만), 현금영수증
  - payState
    
    STRING 필수
    
    거래구분
    
    승인, 취소, 합계
  - dataCnt
    
    NUMBER 필수
    
    거래건수
  - totalPrice
    
    NUMBER 필수
    
    거래금액
  - taxFreePrice
    
    NUMBER 필수
    
    면세
  - taxPriceSupply
    
    NUMBER 필수
    
    과세
  - scPrice
    
    NUMBER 필수
    
    봉사료
  - taxPriceVat
    
    NUMBER 필수
    
    부가세
- totalSumTaxList
  
  ARRAY 필수
  
  총합계 리스트
  
  거래구분 별로 집계한 부가세 리스트
  - payState
    
    STRING 필수
    
    거래구분
    
    승인, 취소, 합계
  - dataCnt
    
    NUMBER 필수
    
    거래건수
  - totalPrice
    
    NUMBER 필수
    
    거래금액
  - taxFreePrice
    
    NUMBER 필수
    
    면세
  - taxPriceSupply
    
    NUMBER 필수
    
    과세
  - scPrice
    
    NUMBER 필수
    
    봉사료
  - taxPriceVat
    
    NUMBER 필수
    
    부가세

errCode

STRING 필수

에러 코드
message

STRING 필수

에러 메시지

error 공통 에러 코드
- 1001
  
  ERROR_REQUIRE_FIELD
  
  필수 필드 에러
- 1014
  
  ERROR_EXIST_DATA
  
  데이터 존재 오류
- 9999
  
  ERROR_SYSTEM
  
  시스템 오류

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/pv/payment/tax-doc")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.queryString("memberID", "") // 회원 ID
.queryString("year", "") // 년도
.queryString("dateRangeType", "") // 분기, 상/하반기
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

부가세 자료 메일 전송 API

post

https://api.ciderpay.com/oapi/pv/payment/tax-doc/mail

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 ID

부가세 자료 조회 해당 회원 ID
year

NUMBER 필수

년도

조회 년도

dateRangeType

STRING 필수

분기, 상/하반기

조회 분기 또는 상/하반기

허용값 리스트
Q1	1분기
Q2	2분기
Q3	3분기
Q4	4분기
HF	상반기
HS	하반기

email

STRING 필수

이메일

전송할 이메일 주소

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

errCode

STRING

에러 코드
message

STRING

에러 메시지

error 공통 에러 코드
- 1001
  
  ERROR_REQUIRE_FIELD
  
  필수 필드 에러
- 1014
  
  ERROR_EXIST_DATA
  
  데이터 존재 오류
- 9999
  
  ERROR_SYSTEM
  
  시스템 오류

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 ID
paramMap.put ("year", "");	// 년도
paramMap.put ("dateRangeType", "");	// 분기, 상/하반기
paramMap.put ("email", "");	// 이메일

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/pv/payment/tax-doc/mail")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

등록 결제 API

등록 결제 승인 요청

post

등록 결제를 위한 승인을 요청하는 API 입니다

https://api.ciderpay.com/oapi/manualPay/requestToken

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디
customName

STRING

고객 이름
customMobile

STRING 필수

고객 휴대폰
customEmail

STRING

고객 E-mail
customNo

STRING

고객 번호
goodName

STRING

서비스명
reason

STRING

결제 요청 상세 내용

selectAuthType

STRING

인증 타입 결정

허용값 리스트
AT_ONCE	즉시결제
CONFIRM	확인결제
PASSWORD	패스워드 결제
SELECT	구매자 선택

useLimitDate

BOOLEAN

결제 만료일 사용 여부
limitDate

NUMBER

만료일
feedbackUrl

STRING

피드백 URL
returnUrl

STRING

돌아가기 URL
errorUrl

STRING

에러 URL

승인 거절 등 기타 오류가 발생했을 때 이동하는 페이지
var1

STRING

임의 변수 1

피드백시 함께 전송
var2

STRING

임의 변수 2

피드백시 함께 전송
maxPaymentPrice

NUMBER

최대 결제 가능 금액
useExpectPrice

BOOLEAN

예상 금액 사용
expectPrice

NUMBER

예상 결제 금액
useExpectDate

BOOLEAN

예상 결제일 사용 여부

expectDateType

STRING

예상 결제일 날짜 타입

허용값 리스트
MONTH	매월
WEEK	매주

expectDateVal

NUMBER

예상 결제일

매월이라면 결제일

sendSms

STRING

SMS 발송 여부

허용값 리스트
Y	발송
N	발송안함

oneJustPayGoodName

STRING

최초 1회 결제 상품명

없으면 최초 1회 결제를 진행하지 않습니다.
oneJustPayPrice

NUMBER

최초 1회 결제 금액

없으면 최초 1회 결제를 진행하지 않습니다.
oneJustPayContent

STRING

최초 1회 결제 상품 내용
oneJustPayFeedback

STRING

최초 1회 결제 결과 Feedback
oneJustPayVar1

STRING

Feedback 추가 변수 1

최초 1회 결제 결과
oneJustPayVar2

STRING

Feedback 추가 변수 2

최초 1회 결제 결과

uiMode

STRING

등록창 UI 모드

허용값 리스트
	기본 반응형 UI
POS	PC 전용 UI

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
var1

STRING 필수

인증 요청 URL
var2

STRING 필수

인증 요청 번호

요청 취소시 사용

Feedback 승인 결과 피드백 승인 성공, 실패 피드백

cmd

STRING 필수

피드백 커맨드

허용값 리스트
mpMakeToken	토큰 발행
rejectMakeToken	요청 거절

memberID

STRING 필수

회원 아이디
var1

STRING

추가 변수 1
var2

STRING

추가 변수 2
mpToken

STRING

발행된 토큰

토큰 발행시만 전송
last4

STRING

카드번호 마지막 4자리

토큰 발행시만 전송

authType

STRING

인증 타입

토큰 발행시만 전송

허용값 리스트
AT_ONCE	즉시결제
CONFIRM	확인결제
PASSWORD	패스워드 결제

authType

STRING

인증 타입

토큰 발행시만 전송
customerNo

STRING

고객 번호
customerName

STRING

고객 이름
customerEmail

STRING

고객 E-mail
customerMobile

STRING

고객 핸드폰 번호

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("customName", "");	// 고객 이름
paramMap.put ("customMobile", "");	// 고객 휴대폰
paramMap.put ("customEmail", "");	// 고객 E-mail
paramMap.put ("customNo", "");	// 고객 번호
paramMap.put ("goodName", "");	// 서비스명
paramMap.put ("reason", "");	// 결제 요청 상세 내용
paramMap.put ("selectAuthType", "SELECT");	// 인증 타입 결정
paramMap.put ("useLimitDate", "false");	// 결제 만료일 사용 여부
paramMap.put ("limitDate", "");	// 만료일
paramMap.put ("feedbackUrl", "");	// 피드백 URL
paramMap.put ("returnUrl", "");	// 돌아가기 URL
paramMap.put ("errorUrl", "");	// 에러 URL
paramMap.put ("var1", "");	// 임의 변수 1
paramMap.put ("var2", "");	// 임의 변수 2
paramMap.put ("maxPaymentPrice", "");	// 최대 결제 가능 금액
paramMap.put ("useExpectPrice", "false");	// 예상 금액 사용
paramMap.put ("expectPrice", "");	// 예상 결제 금액
paramMap.put ("useExpectDate", "false");	// 예상 결제일 사용 여부
paramMap.put ("expectDateType", "");	// 예상 결제일 날짜 타입
paramMap.put ("expectDateVal", "");	// 예상 결제일
paramMap.put ("sendSms", "N");	// SMS 발송 여부
paramMap.put ("oneJustPayGoodName", "");	// 최초 1회 결제 상품명
paramMap.put ("oneJustPayPrice", "");	// 최초 1회 결제 금액
paramMap.put ("oneJustPayContent", "");	// 최초 1회 결제 상품 내용
paramMap.put ("oneJustPayFeedback", "");	// 최초 1회 결제 결과  Feedback
paramMap.put ("oneJustPayVar1", "");	// Feedback 추가 변수 1
paramMap.put ("oneJustPayVar2", "");	// Feedback 추가 변수 2
paramMap.put ("uiMode", "");	// 등록창 UI 모드

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/manualPay/requestToken")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

토큰 해지

delete

등록 결제 토큰 해지

https://api.ciderpay.com/oapi/manualPay/destroyMp/{memberID}/{mpToken}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

회원 아이디
mpToken

STRING

해지할 토큰

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.delete("https://api.ciderpay.com/oapi/manualPay/destroyMp/{memberID}/{mpToken}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 회원 아이디
.routeParam("mpToken", "") // 해지할 토큰
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

등록 승인 요청 취소

post

등록 승인 요청을 취소 합니다

https://api.ciderpay.com/oapi/manualPay/requestCancel/{memberID}/{payUniqueNo}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

회원 아이디
payUniqueNo

STRING

인증 요청 번호 (요청시 var2 로 리턴)

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/manualPay/requestCancel/{memberID}/{payUniqueNo}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 회원 아이디
.routeParam("payUniqueNo", "") // 인증 요청 번호 (요청시 var2 로 리턴)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

결제 요청 취소

post

https://api.ciderpay.com/oapi/manualPay/paymentRequestCancel/{memberID}/{mpToken}/{onePayUniqueNo}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

회원 아이디
mpToken

STRING

결제 요청 토큰
onePayUniqueNo

STRING

결제 요청 고유 번호 (결제 요청시 data.onePayUniqueNo 로 리턴)

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/manualPay/paymentRequestCancel/{memberID}/{mpToken}/{onePayUniqueNo}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 회원 아이디
.routeParam("mpToken", "") // 결제 요청 토큰
.routeParam("onePayUniqueNo", "") // 결제 요청 고유 번호 (결제 요청시 data.onePayUniqueNo 로 리턴)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

등록 결제 결제 요청

post

승인된 등록 결제에 결제를 요청합니다.

https://api.ciderpay.com/oapi/manualPay/doRequestPayment

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디
mpToken

STRING 필수

승인 토큰

등록 완료 시 전송된 승인 토큰
goodName

STRING 필수

상품명

상품명
price

NUMBER 필수

결제 요청 금액

결제 금액
content

STRING 필수

결제 상세 내용
payLimitDate

NUMBER

결제 만료 시간

결제가 유효한 시간
feedbackUrl

STRING

피드백 URL

결제 완료 시 통보하는 URL
returnUrl

STRING

돌아가기 URL

결제 화면에서 닫기 클릭시 이동되는 URL
var1

STRING

추가 변수 1

feedback 시 전송
var2

STRING

추가 변수 2

feedback 시 전송

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

data

OBJECT 필수

응답 데이터

onePayUniqueNo

STRING 필수

결제 요청 고유 번호

요청 취소시 필요

authType

STRING

인증 타입

결제 인증 타입

허용값 리스트
AT_ONCE	바로 결제
CONFIRM	확인 결제
PASSWORD	확인 결제 (패스워드)

goodName

STRING 필수

상품명

결제 요청시 전송된 상품명

paymentState

STRING 필수

결제 상태

결제 요청에 따른 결과 (바로 결제시 COMPLETE)

허용값 리스트
REQUEST	결제 요청
COMPLETE	결제 완료

cstUrl

STRING

영수증

paymentState 이 COMPLETE 인 경우에만 리턴
approvalNo

STRING

승인번호

paymentState 이 COMPLETE 인 경우에만 리턴
ccname

STRING

카드사명

paymentState 이 COMPLETE 인 경우에만 리턴
cardNum

STRING

카드 번호

paymentState 이 COMPLETE 인 경우에만 리턴

cardType

STRING

카드 종류

paymentState 이 COMPLETE 인 경우에만 리턴

허용값 리스트
01	개인
02	법인
03	개인_법인
99	기타

cardQuota

STRING

할부 개월수

paymentState 이 COMPLETE 인 경우에만 리턴
feedbackToken

STRING

결제취소시 필요토큰

paymentState 이 COMPLETE 인 경우에만 리턴
customerNo

STRING

고객 번호
customerName

STRING

고객 이름
customerEmail

STRING

고객 E-mail
customerMobile

STRING

고객 핸드폰
payUrl

STRING

결제 요청 URL

uiMode 가 POS 인 경우에만 리턴함

Feedback 결제 결과 피드백

cmd

STRING 필수

피드백 타입

피드백 상황

허용값 리스트
completeMpPayment	결제 완료
errorMpPayment	결제 에러

memberID

STRING 필수

회원 아이디

회원 아이디
var1

STRING

추가 변수 1

요청 시 넘긴 var1 값
var2

STRING

추가 변수 2

요청 시 넘긴 var2 값
price

NUMBER 필수

결제 금액

결제한 금액
mpToken

STRING

등록 결제 토큰
cstUrl

STRING

영수증

결제 완료 시 전송
approvalNo

STRING

승인번호

결제 완료 시 전송
ccname

STRING

카드사명

결제 완료 시 전송
cardNum

STRING

카드 번호

결제 완료 시 전송

cardType

STRING

카드 종류

결제 완료 시 전송

허용값 리스트
01	개인
02	법인
03	개인_법인
99	기타

cardQuota

STRING

할부 개월 수

결제 완료 시 전송
feedbackToken

STRING

결제 취소 토큰

결제 완료 시 전송
orderNo

STRING

결제 고유 번호

결제 완료 시 전송
customerNo

STRING

고객 번호
customerName

STRING

고객 이름
customerEmail

STRING

고객 E-mail
customerMobile

STRING

고객 핸드폰 번호

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("mpToken", "");	// 승인 토큰
paramMap.put ("goodName", "");	// 상품명
paramMap.put ("price", "");	// 결제 요청 금액
paramMap.put ("content", "");	// 결제 상세 내용
paramMap.put ("payLimitDate", "");	// 결제 만료 시간
paramMap.put ("feedbackUrl", "");	// 피드백 URL
paramMap.put ("returnUrl", "");	// 돌아가기 URL
paramMap.put ("var1", "");	// 추가 변수 1
paramMap.put ("var2", "");	// 추가 변수 2

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/manualPay/doRequestPayment")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기 결제 API

정기 결제 승인 요청

post

정기 결제를 위한 승인 요청 API

https://api.ciderpay.com/oapi/regularPay/request

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING 필수

회원 아이디
customName

STRING

고객 이름
customMobile

STRING 필수

고객 핸드폰
customEmail

STRING

고객 E-mail
customNo

STRING

고객 번호
goodName

STRING 필수

정기 결제 상품명
price

NUMBER 필수

정기 결제 금액
reason

STRING

정기 결제 요청 상세 내용
limitDateStr

STRING

만료일 (yyyy-MM-dd)

해당값이 없으면 기본 1년으로 정기결제가 생성됨
(정기결제가 년 주기면 필수)
returnUrl

STRING

승인 완료 시 돌아가기 URL
feedbackUrl

STRING

승인 완료 / 거절시 피드백 URL
var1

STRING

승인 완료 / 거절시 임의 변수 1

피드백시 함께 전송
var2

STRING

승인 완료 / 거절시 임의 변수 2

피드백시 함께 전송
payFeedbackUrl

STRING

정기 결제 완료 피드백 URL
payVar1

STRING

정기 결제 완료 임의 변수 1

피드백시 함께 전송
payVar2

STRING

정기 결제 완료 임의 변수 2

피드백시 함께 전송

periodDateType

STRING

정기 결제 주기

허용값 리스트
MONTH	매월
WEEK	매주
YEAR	매년

periodDateVal

STRING 필수

결제일

매월이라면 결제일
매년이라면 결제월
periodDateValSub

STRING

결제일 보조값

매년이라면 결제일 (매년의 경우 필수)
그외 사용 안함

firstBillingType

STRING

최초 결제 구분

허용값 리스트
NEXT_SCHEDULE	다음 일정부터 결제
MUST_FIRST_PAYMENT	승인과 동시에 결제

firstPrice

NUMBER

최초 결제 금액

firstBillingType 값이 MUST_FIRST_PAYMENT 경우에만 유효
해당 금액이 없다면 정기 결제 금액으로 최초 결제 진행

taxType

STRING

과세타입

허용값 리스트
TAX	과세
TAX_FREE	면세

add1

STRING

고객 추가 정보1
add2

STRING

고객 추가 정보2

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지
var1

STRING

인증 요청 URL
var2

STRING

인증 요청 번호

요청 취소시 사용

Feedback 정기 결제 승인 피드백 정기 결제 승인/거절시 피드백

cmd

STRING 필수

피드백 커맨드

정기 결제 승인 또는 정기 결제 거절

허용값 리스트
agreeRegularPayment	정기 결제 승인
rejectRegularPayment	정기 결제 거절

memberID

STRING 필수

회원 아이디
var1

STRING

추가 변수 1

승인 요청시 입력한 추가 변수 값
var2

STRING

추가 변수 2

승인 요청시 입력한 추가 변수 값
rpToken

STRING 필수

정기 결제 토큰
last4

STRING 필수

카드번호 마지막 4자리
customerNo

STRING

고객 번호
customerName

STRING

고객 이름
customerMobile

STRING

고객 핸드폰 번호

Feedback 정기 결제 피드백 정기 결제 실결제 피드백

cmd

STRING 필수

피드백 커맨드

정기 결제 완료 또는 정기 결제 에러

허용값 리스트
completeRpPayment	정기 결제 완료
errorRpPayment	정기 결제 에러

memberID

STRING 필수

회원 아이디
var1

STRING

추가 변수 1

승인 요청시 입력한 추가 변수 값
var2

STRING

추가 변수 2

승인 요청시 입력한 추가 변수 값
price

NUMBER 필수

결제 금액
rpToken

STRING 필수

발행된 토큰
csturl

STRING

영수증

결제 완료시 전송
approvalNo

STRING

승인번호

결제 완료시 전송
ccname

STRING

카드사명

결제 완료시 전송
cardNum

STRING

카드번호

결제 완료시 전송

cardType

STRING

카드 종류

결제 완료시 전송

허용값 리스트
01	개인
02	법인
99	기타

cardQuota

STRING

할부개월수

결제 완료시 전송
feedbackToken

STRING

결제취소시 필요토큰

paymentState 이 COMPLETE 인 경우에만 리턴
orderNo

STRING

결제 고유 주문번호

paymentState 이 COMPLETE 인 경우에만 리턴
customerNo

STRING

고객번호
customerName

STRING

고객 이름
customerEmail

STRING

고객 E-mail
customerMobile

STRING

고객 핸드폰 번호
turnSeq

NUMBER

결제 회차
errorMessage

STRING

에러 메시지

결제 실패시 전달

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("customName", "");	// 고객 이름
paramMap.put ("customMobile", "");	// 고객 핸드폰
paramMap.put ("customEmail", "");	// 고객 E-mail
paramMap.put ("customNo", "");	// 고객 번호
paramMap.put ("goodName", "");	// 정기 결제 상품명
paramMap.put ("price", "");	// 정기 결제 금액
paramMap.put ("reason", "");	// 정기 결제 요청 상세 내용
paramMap.put ("limitDateStr", "");	// 만료일 (yyyy-MM-dd)
paramMap.put ("returnUrl", "");	// 승인 완료 시 돌아가기 URL
paramMap.put ("feedbackUrl", "");	// 승인 완료 / 거절시 피드백 URL
paramMap.put ("var1", "");	// 승인 완료 / 거절시 임의 변수 1
paramMap.put ("var2", "");	// 승인 완료 / 거절시 임의 변수 2
paramMap.put ("payFeedbackUrl", "");	// 정기 결제 완료 피드백 URL
paramMap.put ("payVar1", "");	// 정기 결제 완료 임의 변수 1
paramMap.put ("payVar2", "");	// 정기 결제 완료 임의 변수 2
paramMap.put ("periodDateType", "");	// 정기 결제 주기
paramMap.put ("periodDateVal", "");	// 결제일
paramMap.put ("periodDateValSub", "");	// 결제일 보조값
paramMap.put ("firstBillingType", "NEXT_SCHEDULE");	// 최초 결제 구분
paramMap.put ("firstPrice", "");	// 최초 결제 금액
paramMap.put ("taxType", "");	// 과세타입
paramMap.put ("add1", "");	// 고객 추가 정보1
paramMap.put ("add2", "");	// 고객 추가 정보2

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/regularPay/request")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기 결제 토큰 해지

delete

https://api.ciderpay.com/oapi/regularPay/destroyMp/{memberID}/{rpToken}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

판매점 회원 아이디
rpToken

STRING

정기 결제 승인시 받은 토큰

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.delete("https://api.ciderpay.com/oapi/regularPay/destroyMp/{memberID}/{rpToken}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 판매점 회원 아이디
.routeParam("rpToken", "") // 정기 결제 승인시 받은 토큰
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기결제 금액 변경

post

정기결제 금액을 변경합니다.

https://api.ciderpay.com/oapi/regularPay/changePriceAct

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

rpToken

STRING 필수

토큰

정기 결제 승인시 받은 토큰
price

NUMBER 필수

변경 금액
memberID

STRING 필수

회원 아이디

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

errCode

STRING

에러 코드
message

STRING

에러 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/regularPay/changePriceAct")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.field("rpToken", "") // 토큰
.field("price", "") // 변경 금액
.field("memberID", "") // 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기결제 일시정지

post

정기결제를 일시정지합니다.

https://api.ciderpay.com/oapi/regularPay/pauseAct

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

rpToken

STRING 필수

토큰

정기 결제 승인시 받은 토큰
memberID

STRING 필수

회원 아이디

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

errCode

STRING

에러 코드
message

STRING

에러 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/regularPay/pauseAct")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.field("rpToken", "") // 토큰
.field("memberID", "") // 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기결제 일시정지 해제

post

정기결제를 일시정지를 해제합니다.

https://api.ciderpay.com/oapi/regularPay/unpauseAct

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

rpToken

STRING 필수

토큰

정기 결제 승인시 받은 토큰
memberID

STRING 필수

회원 아이디

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

errCode

STRING

에러 코드
message

STRING

에러 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/regularPay/unpauseAct")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.field("rpToken", "") // 토큰
.field("memberID", "") // 회원 아이디
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");

정기 결제 요청 취소

post

https://api.ciderpay.com/oapi/regularPay/requestCancel/{memberID}/{payUniqueNo}

devID

STRING 필수

개발사 아이디

부여받은 개발사 아이디를 설정해주세요
devToken

STRING 필수

개발사 토큰

부여받은 개발사 토큰을 설정해주세요

memberID

STRING

회원 아이디
payUniqueNo

STRING

인증 요청 번호 (요청시 var2 로 리턴)

success

BOOLEAN 필수

성공 여부

API 성공 여부
errorMessage

STRING

메시지

API 응답 메시지

errCode

STRING

에러 코드
message

STRING

에러 메시지

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/regularPay/requestCancel/{memberID}/{payUniqueNo}")
.header("accept", "application/json")
.header("devID", "") // 개발사 아이디
.header("devToken", "") // 개발사 토큰
.routeParam("memberID", "") // 회원 아이디
.routeParam("payUniqueNo", "") // 인증 요청 번호 (요청시 var2 로 리턴)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");