결제 API

결제 요청
post

결제 요청 API

https://api.ciderpay.com/oapi/payment/request
  • approvalToken

    STRING

    결제 토큰

    판매점이 결제 토큰을 사용중 일 때 반드시 설정 되어야 결제가 진행됩니다.

  • memberID

    STRING 필수

    회원 아이디

    판매점 회원 아이디

  • price

    NUMBER 필수

    결제 금액

    1,000원 이상 부터 결제 가능합니다.

  • taxPrice

    NUMBER

    과세 금액

    과세로 설정할 금액을 입력합니다.

  • taxFreePrice

    NUMBER

    면세 금액

    면세로 설정할 금액을 입력합니다.

  • goodName

    STRING 필수

    상품명

    결제 상품명

  • mobile

    STRING 필수

    구매자 핸드폰 번호

    구매자 핸드폰 번호

  • customName

    STRING

    구매자명

  • customNo

    STRING

    구매자 고객 번호

  • email

    STRING

    구매자 E-mail

  • feedbackurl

    STRING

    피드백 URL

    결제 성공시 통지 받을 URL

  • returnurl

    STRING

    돌아가기 URL

    결제완료 후 이동할 링크 URL (매출전표 페이지에서 "확인"버튼 클릭시 이동)

  • returnmode

    STRING

    돌아가기 URL 처리

    결제완료 후 이동하는 처리 방식을 결정합니다.

    허용값 리스트
    영수증을 출력합니다.
    JUST 돌아가기 URL 로 바로 호출합니다. (영수증 URL 포함)
  • var1

    STRING

    임의 변수 1

    결제 통지시 함께 전송됩니다.

  • var2

    STRING

    임의 변수 2

    결제 통지시 함께 전송됩니다.

  • smsuse

    STRING

    SMS 발송 여부

    SMS 발송 여부를 설정할 수 있습니다.

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

    STRING

    결제 출처

  • sellerMemo

    STRING

    판매자 메모

  • success

    BOOLEAN 필수

    성공 여부

    결제 요청이 성공 했는지 여부

  • payUrl

    STRING 필수

    결제 가능한 URL

    결제 진행이 가능한 URL

  • payUniqueNo

    STRING 필수

    결제 고유 아이디

    결제 고유 아이디

  • errCode

    STRING

    에러 코드

  • message

    STRING

    에러 메시지

  • Feedback 결제 완료 피드백
    • memberID

      STRING 필수

      회원아이디

    • feedbackToken

      STRING 필수

      피드백 토큰

      결제 취소시 필요

    • goodName

      STRING 필수

      상품명

      상품명

    • price

      NUMBER 필수

      결제 금액

    • recvPhone

      STRING 필수

      고객 연락처

    • paymentState

      STRING 필수

      결제 상태

      현재 결제 상태를 표시

      허용값 리스트
      COMPLETE 결제 완료
      CANCEL 결제 취소
    • payType

      STRING 필수

      결제 수단

      허용값 리스트
      1 카드결제
      2 핸드폰결제
    • orderNo

      STRING 필수

      주문번호

    • approvalNo

      STRING 필수

      승인번호

    • ccname

      STRING 필수

      카드사명

    • var1

      STRING

      추가변수1

      결제 요청시 입력 했던 추가 변수 1

    • var2

      STRING

      추가변수2

      결제 요청시 입력 했던 추가 변수 2

    • cardNum

      STRING

      카드번호

      결제한 카드 번호

    • cardQuota

      STRING

      할부개월

      할부 개월

    • csturl

      STRING 필수

      영수증 URL

  • error 결제 실패 에러 코드
코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("price", "");	// 결제 금액
paramMap.put ("taxPrice", "");	// 과세 금액
paramMap.put ("taxFreePrice", "");	// 면세 금액
paramMap.put ("goodName", "");	// 상품명
paramMap.put ("mobile", "");	// 구매자 핸드폰 번호
paramMap.put ("customName", "");	// 구매자명
paramMap.put ("customNo", "");	// 구매자 고객 번호
paramMap.put ("email", "");	// 구매자 E-mail
paramMap.put ("feedbackurl", "");	// 피드백 URL
paramMap.put ("returnurl", "");	// 돌아가기 URL
paramMap.put ("returnmode", "");	// 돌아가기 URL 처리
paramMap.put ("var1", "");	// 임의 변수 1
paramMap.put ("var2", "");	// 임의 변수 2
paramMap.put ("smsuse", "Y");	// SMS 발송 여부
paramMap.put ("whereFrom", "");	// 결제 출처
paramMap.put ("sellerMemo", "");	// 판매자 메모

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/payment/request")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("approvalToken", "") // 결제 토큰
.body(paramMap)
.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/payment/request/cancel
  • memberID

    STRING 필수

    회원 아이디

    판매자 회원 아이디

  • payUniqueNo

    STRING 필수

    결제 고유 아이디

    결제 요청에서 리턴된 payUniqueNo 값

  • 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 ("memberID", "");	// 회원 아이디
paramMap.put ("payUniqueNo", "");	// 결제 고유 아이디

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/payment/request/cancel")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.body(paramMap)
.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/payment/cancel
  • memberID

    STRING 필수

    회원 아이디

    판매자 회원 아이디

  • orderNo

    STRING 필수

    주문 번호

    결제 주문 번호

  • token

    STRING 필수

    취소 토큰

    결제 피드백에 있는 feedbackToken 값

  • cancelMessage

    STRING

    취소 사유

    취소가 된 이유를 입력합니다.

  • success

    BOOLEAN 필수

    결제 취소 여부

    결제가 취소가 되면 true 를 리턴합니다.

  • errorMessage

    STRING

    에러 메시지

  • var1

    STRING

    실패시 추가 응답값

    결제 취소 실패시 취소 요청이 필요한 경우 "CANCEL_REQ" 로 설정됩니다.

  • errCode

    STRING 필수

    에러 코드

  • message

    STRING 필수

    에러 메시지

  • error 결제 취소시 에러
    • 2001

      ERROR_CANCEL_STATE

      취소 가능 상태 에러

    • 2002

      ERROR_CANCEL_TOKEN

      결제 토큰 에러

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("orderNo", "");	// 주문 번호
paramMap.put ("token", "");	// 취소 토큰
paramMap.put ("cancelMessage", "");	// 취소 사유

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/payment/cancel")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.body(paramMap)
.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/payment/cancelRequest
  • memberID

    STRING 필수

    회원 아이디

    판매자 회원 아이디

  • orderNo

    STRING 필수

    주문 번호

    결제 주문 번호

  • token

    STRING 필수

    취소 토큰

    결제 피드백에 있는 feedbackToken 값

  • cancelMessage

    STRING

    취소 사유

    취소가 된 이유를 입력합니다.

  • bankInName

    STRING

    입금자명

  • success

    BOOLEAN 필수

    결제 취소 여부

    결제가 취소가 되면 true 를 리턴합니다.

  • errorMessage

    STRING

    에러 메시지

  • errCode

    STRING 필수

    에러 코드

  • message

    STRING 필수

    에러 메시지

  • error 결제 취소시 에러
    • 2001

      ERROR_CANCEL_STATE

      취소 가능 상태 에러

    • 2002

      ERROR_CANCEL_TOKEN

      결제 토큰 에러

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("memberID", "");	// 회원 아이디
paramMap.put ("orderNo", "");	// 주문 번호
paramMap.put ("token", "");	// 취소 토큰
paramMap.put ("cancelMessage", "");	// 취소 사유
paramMap.put ("bankInName", "");	// 입금자명

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/payment/cancelRequest")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.body(paramMap)
.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/member/exist
  • memberID

    STRING 필수

    체크할 회원 아이디

    체크할 아이디를 입력해주세요

  • parentMemberID

    STRING 필수

    상위 아이디

    상위 계정 아이디를 입력해주세요 (대리점, 리셀러 등)

  • success

    BOOLEAN 필수

    성공여부

    만약 상위 아이디가 존재 하지 않으면 false

  • exist

    STRING 필수

    아이디 존재여부

    존재 시 Y 를 리턴합니다. 에러 발생시 E 를 리턴합니다

    허용값 리스트
    Y 아이디 존재
    N 존재 안함
    E 에러
코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://api.ciderpay.com/oapi/member/exist")
.header("accept", "application/json")
.queryString("memberID", "") // 체크할 회원 아이디
.queryString("parentMemberID", "") // 상위 아이디
.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/member/regist/seller/v2
  • resellerid

    STRING 필수

    리셀러 또는 대리점 아이디

    가입되는 회원이 속해 있을 상위 회원 아이디를 입력해주세요

  • seller_type

    STRING 필수

    판매자 타입

    가입하려는 판매점 타입

    허용값 리스트
    seller 판매점
    reseller 리셀러
    agent 대리점
  • userid

    STRING 필수

    사용자 아이디

    가입하려는 사용자 아이디 (영문 숫자 조합으로 입력)

  • userpwd

    STRING 필수

    패스워드

  • sellername

    STRING 필수

    판매점명

    서비스명 또는 개인이름 등

  • phone

    STRING 필수

    판매자 핸드폰

  • email

    STRING 필수

    판매자 E-mail

  • homepage

    STRING

    홈페이지 주소

  • bizkind

    STRING 필수

    서비스 형태

    허용값 리스트
    Blog사업자
    쇼핑몰사업자
    방문판매
    음식점(배달)
    A/S긴급출동
    운수업
    컨텐츠
    도소매
    유통
    병원
  • wherefrom

    STRING

    가입출처

  • zipcode

    STRING

    우편번호

  • addr1

    STRING

    주소1

  • addr2

    STRING

    상세 주소

  • usertype

    STRING 필수

    사용자타입

    허용값 리스트
    1 개인
    2 사업자
  • compbank

    STRING

    판매자 정산은행 이름

  • compbanknum

    STRING

    판매자 정산 은행 계좌번호

  • compbankname

    STRING

    판매자 정산 은행 예금주

  • compregno

    STRING

    사업자 번호

    usertype 이 사업자 인 경우 필수

  • compname

    STRING

    사업자 상호명

    usertype 이 사업자 인 경우 필수

  • biztype1

    STRING

    업태

    usertype 이 사업자 인 경우 필수

  • biztype2

    STRING

    업종

    usertype 이 사업자 인 경우 필수

  • comptel

    STRING

    매장 전화번호

    usertype 이 사업자 인 경우 입력

  • ceo_nm

    STRING

    대표자명

    usertype 이 사업자 인 경우 필수

  • corp_type

    STRING

    사업자 타입

    usertype 이 사업자 인 경우 필수

    허용값 리스트
    1 개인 사업자
    2 법인 사업자
  • username

    STRING

    이름

    usertype 이 개인인 경우 필수

  • success

    BOOLEAN 필수

    성공 여부

    성공 여부

  • memberID

    STRING 필수

    회원 아이디

    등록된 회원 아이디

  • errCode

    STRING 필수

    에러코드

  • message

    STRING 필수

    에러 메시지

  • error 회원 등록 오류
    • 1090

      ERRROR_REGIST_MEMBER

      이미 등록된 회원 오류

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/member/regist/seller/v2")
.header("accept", "application/json")
.field("resellerid", "") // 리셀러 또는 대리점 아이디
.field("seller_type", "") // 판매자 타입
.field("userid", "") // 사용자 아이디
.field("userpwd", "") // 패스워드
.field("sellername", "") // 판매점명
.field("phone", "") // 판매자 핸드폰
.field("email", "") // 판매자 E-mail
.field("homepage", "") // 홈페이지 주소
.field("bizkind", "") // 서비스 형태
.field("wherefrom", "") // 가입출처
.field("zipcode", "") // 우편번호
.field("addr1", "") // 주소1
.field("addr2", "") // 상세 주소
.field("usertype", "") // 사용자타입
.field("compbank", "") // 판매자 정산은행 이름
.field("compbanknum", "") // 판매자 정산 은행 계좌번호
.field("compbankname", "") // 판매자 정산 은행 예금주
.field("compregno", "") // 사업자 번호
.field("compname", "") // 사업자 상호명
.field("biztype1", "") // 업태
.field("biztype2", "") // 업종
.field("comptel", "") // 매장 전화번호
.field("ceo_nm", "") // 대표자명
.field("corp_type", "") // 사업자 타입
.field("username", "") // 이름
.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/cashst/publish/{memberID}
  • memberID

    STRING

    회원 아이디

  • goodName

    STRING 필수

    상품명

  • trCode

    STRING 필수

    발행용도

    허용값 리스트
    0 소득공제
    1 지출증빙
  • tradTime

    STRING 필수

    거래 일시

  • corpTaxType

    STRING 필수

    과세/면세

    허용값 리스트
    TG01 과세
    TG02 면세
  • idInfo

    STRING 필수

    발행 아이디 정보

  • totalPrice

    NUMBER 필수

    전체 금액

  • custIp

    STRING 필수

    고객 아이피

  • comment

    STRING

    비고

  • success

    BOOLEAN 필수

    성공 여부

    API 성공 여부

  • errorMessage

    STRING

    메시지

    API 응답 메시지

  • id

    STRING 필수

    현금영수증 아이디

    현금영수증 발행을 취소할 때 사용합니다.

  • goodName

    STRING 필수

    상품명

  • trCode

    STRING 필수

    발행용도

    허용값 리스트
    0 소득공제
    1 지출증빙
  • tradTime

    STRING 필수

    거래 일시

  • corpTaxType

    STRING 필수

    과세/면세

    허용값 리스트
    TG01 과세
    TG02 면세
  • totalPrice

    NUMBER 필수

    전체 금액

  • feedbackToken

    STRING 필수

    피드백 토큰

    현금영수증 발행을 취소할 때 사용합니다.

  • errCode

    STRING

    에러 코드

  • message

    STRING

    에러 메시지

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("goodName", "");	// 상품명
paramMap.put ("trCode", "");	// 발행용도
paramMap.put ("tradTime", "");	// 거래 일시
paramMap.put ("corpTaxType", "");	// 과세/면세
paramMap.put ("idInfo", "");	// 발행 아이디 정보
paramMap.put ("totalPrice", "");	// 전체 금액
paramMap.put ("custIp", "");	// 고객 아이피
paramMap.put ("comment", "");	// 비고

HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/cashst/publish/{memberID}")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.routeParam("memberID", "") // 회원 아이디 
.body(paramMap)
.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/cashst/cancel/{memberID}/{id}
  • feedbackToken

    STRING 필수

    피드백 토큰

  • memberID

    STRING

    회원 아이디

  • id

    STRING

    현금영수증 아이디

  • success

    BOOLEAN 필수

    성공 여부

    API 성공 여부

  • errorMessage

    STRING

    메시지

    API 응답 메시지

  • errCode

    STRING

    에러 코드

  • message

    STRING

    에러 메시지

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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


HttpResponse response = Unirest.post("https://api.ciderpay.com/oapi/cashst/cancel/{memberID}/{id}")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("feedbackToken", "") // 피드백 토큰
.routeParam("memberID", "") // 회원 아이디
.routeParam("id", "") // 현금영수증 아이디
.body(paramMap)
.asJson();

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