Konaplate logo

API 문서

전체 API

서비스


회원 가입동기

버전: v1


버전: v1

POST

/api/v1/user/registration

제휴사의 회원을 KONA PLATE 플랫폼에 회원 가입 처리 합니다. (정회원)

요청 헤더


X-KM-User-AspId

string

필수

길이 : 15

서비스 ID

  • 제휴사에게 부여되는 제휴사 구분을 위한 서비스 ID입니다.

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

  • 형식 : yyMMddHHmiSS-xxxxxxx
  • xxxxxxx : 7자리, Hex String

X-KM-Access-Key

string

조건부

길이 : 40

프로젝트 액세스 키

  • 프로젝트 생성 시 부여되는 키 입니다.
  • Callback API 인 경우는 제외합니다.

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
  • 데이터 암호화 요청 시 필수 입력값입니다. (Data Encryption = Y)

X-KM-Tran-Token

string

필수

길이 : 66

데이터 무결성 확인 키
  • 프로젝트 생성 시 부여되는 키 입니다.
  • 데이터 무결성을 확인합니다.

 

X-KM-Tran-Time

string

필수

길이 : 14

클라이언트 요청 시간

  • 형식 : YYYYMMDDHHMMSS

X-KM-Time-Zone

string

필수

길이 : 3

시간대 정보
  • UTC, KST, ...

요청 파라미터

암호화 처리|
더 자세한 정보는
가이드라인
을 참조하세요.

ci

string

옵션

길이 : 88

CI, Connection Information

loginId

string

필수

최소 : 1 , 최대 : 80

회원 로그인 ID

loginPassword

string

필수

길이 : 6

회원 비밀번호

birthDate

string

필수

길이 : 8

회원 생년월일

nationality

string

필수

최소 : 6 , 최대 : 9

회원 국적

gender

string

필수

최소 : 4 , 최대 : 6

회원 성별

userName

string

필수

최소 : 1 , 최대 : 100

회원 이름

mobileNumber

string

조건부

최소 : 10 , 최대 : 20

회원 휴대 전화 번호

email

string

필수

최소 : 1 , 최대 : 80

회원 이메일

joinChannel

string

옵션

최소 : 1 , 최대 : 20

서비스 구분 코드 (OPENAPI)

addressInfo

object

옵션

회원 주소 정보

zipCode

string

필수

최소 : 5 , 최대 : 6

우편 번호

address

string

필수

최소 : 1 , 최대 : 255

주소

addressDetail

string

옵션

최소 : 1 , 최대 : 255

상세 주소

tcIdList

array of strings

옵션

회원 약관 동의 목록

추가 string

응답 헤더


X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

  • 형식 : yyMMddHHmiSS-xxxxxxx
  • xxxxxxx : 7자리, Hex String

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 프로젝트 생성 시 부여되는 ID입니다.
  • Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.

응답 파라미터

암호화 처리|
더 자세한 정보는
가이드라인
을 참조하세요.

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

회원 ID

- 회원가입 시 부여되는 회원의 고유 ID입니다.

basicCardInfo

object

옵션

회원 가입 시 발급되는 모바일 카드 기본정보


par

string

필수

길이 : 27

회원 가입시 발급된 모바일 카드 카드의 PAN(Primary Account Number)을 대체하는 번호

cardNo

string

필수

길이 : 16

회원 가입시 발급된 모바일 카드 카드 번호

expiryDate

string

필수

길이 : 6

회원 가입시 발급된 모바일 카드 카드 사용 유효기간 (Format : YYMMDD)

serviceId

string

필수

길이 : 15

카드 상품 ID

- 카드 상품에 부여한 고유 식별 값입니다.

응답 코드

Detailed classification and addition of error for unseccessful withfrawal


200

에러 코드

000_000

메시지

Success.

설명

성공


400

에러 코드

000_002

메시지

Invalid input value. loginId

설명

입력 파라미터 오류 - `loginId` 필수 정보가 빈 문자열인 경우


400

에러 코드

000_003

메시지

Missing required values. loginId

설명

필수값 누락 - `loginId` 필수 정보 요청 null 인 경우


400

에러 코드

000_015

메시지

The length of value does not match. birthDate (반드시 최소값 8과(와) 최대값 8 사이의 크기이어야 합니다.)

설명

필드 길이 오류 - `birthDate` 길이 8 자리 이하인 경우


400

에러 코드

001_001

메시지

User already exists with this loginId.

설명

기 사용 로그인 아이디 입력 오류


400

에러 코드

001_028

메시지

CI data already found for another user.

설명

기 가입 회원 오류


400

에러 코드

001_009

메시지

Terms and conditions data missing.

설명

필수 약관 동의 누락

테스트 데이터

200 - 성공 테스트


200 - 성공 테스트
400 - 입력 파라미터 오류 - `loginId` 필수 정보가 빈 문자열인 경우
400 - 필수값 누락 - `loginId` 필수 정보 요청 null 인 경우
400 - 필드 길이 오류 - `birthDate` 길이 8 자리 이하인 경우
400 - 기 사용 로그인 아이디 입력 오류
400 - 기 가입 회원 오류
400 - 필수 약관 동의 누락
Loading ...

Request

Loading...

Response

Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.


회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제계좌 1원 인증 요청계좌 1원 인증 코드 검증선불카드 발급 및 배송 신청카드 신청 취소선불카드 재발급(교체발급)만료 예정 선불카드 재발급 갱신카드 배송 상태 조회실물카드와 연결 가능한 모바일카드 신청 정보 조회실물카드 등록보유카드 조회미등록 카드 조회카드 상태 변경카드 폐기기명화 및 한도상향(개인)기명화 및 한도상향(법인)법인 기명화 여부 조회소득공제 신청카드 소득공제 신청 여부 조회카드 매핑 회원 조회카드 상품ID로 상품 정보 조회주카드 설정카드에 연결된 가상계좌 조회직불카드 발급 및 배송 신청카드 신청 취소카드 배송 상태 조회실물카드 등록보유카드 조회카드 상태 변경카드 한도 변경카드 폐기소득공제 신청카드 소득공제 신청 여부 조회주카드 설정일회용 토큰 발급계좌 충전계좌 충전취소충전 및 충전취소 결과 확인거래내역 확인기준 하한 및 월정액 자동 충전 활성화기준 하한 자동 충전 등록기준 하한 및 월정액 자동 충전 목록 조회기준 하한 자동 충전 수정월 정액 자동 충전 등록월 정액 자동 충전 수정기준 하한 및 월정액 자동 충전 등록 해제결제 시 자동 충전 등록결제 시 자동 충전 등록 해제결제 시 자동 충전 목록 조회일회용 토큰 발급환불 수수료 조회환불환불 결과 확인시스템 충전(예치금)시스템 충전 취소(예치금)시스템 환불(예치금)시스템 부분환불(예치금)신용카드 충전 거래 생성신용카드 충전 취소 요청편의점 충전/출금 요청예치금 내역 조회예치금 잔액 조회일회용 토큰 발급결제결제취소결제 망취소거래내역 확인포인트 거래내역 확인보유카드 조회포인트 사용예약 및 취소포인트 거래내역 확인관리자 포인트 지급관리자 포인트 환수스탬프카드 적립이력조회보유 스탬프카드 목록 조회보유 마일리지카드 목록 조회마일리지카드 적립이력조회카드로 송금 전송카드로 송금 수신카드로 송금 거절카드로 송금 취소ATM 출금용 일회용 Token 발급ATM 출금 예약ATM 출금 예약 취소ATM 출금 정보 조회선불카드 선물하기선불카드 선물하기 취소선불카드 선물하기 유효성 검증선불카드 선물하기 수락선불카드 선물하기 거절받은 카드/쿠폰 선물 목록 조회보낸 카드/쿠폰 선물 목록 조회카드 선물 수락 V2카드 선물하기 V2카드 잔액 이관잔액 이관 카드 정보 조회현금영수증 발행 요청현금영수증 발행 취소현금영수증 국세청 승인오류 요청현금영수증 식별 정보 등록현금영수증 식별 정보 조회현금영수증 식별 정보 삭제현금영수증 가맹점 등록현금영수증 가맹점 수정가맹점 그룹 생성가맹점 그룹 수정가맹점 그룹 조회가맹점 정보 조회가맹점 그룹 내 가맹점 추가가맹점 그룹 내 가맹점 삭제신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화신용카드 자동충전 목록 조회신용카드 자동충전 설정 해제신용카드 자동 충전 설정 변경카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)