Konaplate logo

API 문서

전체 API

서비스


PG를 통한 은행 계좌 등록비동기

버전: v1


버전: v1

POST

/api/v1/bankaccounts/ars/register

PG를 통해 회원의 계좌를 등록 처리합니다. 계좌를 등록하거나 이미 등록된 계좌를 신규 계좌로 변경을 처리 합니다. ARS 인증 회원이 ARS 의 안내에 따라 모바일 화면에 나타난 인증 코드를 정확히 입력하는지 검증한다. ARS 인증의 음성 파일은 녹취되며, 출금이체 동의 자료로 사용된다 계좌 등록 회원이 카드에 잔액을 충전하기 위해서는 출금 계좌를 등록해야 합니다. 이를 위해서 다음의 2단계를 진행하게 됩니다. 1. 계좌 예금주 실명 검증 2. ARS 인증 계좌가 등록되며 계좌를 통해 선불 카드를 충전할 수 있습니다. PG는 ARS 인증코드를 회원으로부터 입력 받아 인증코드를 검증(ARS 인증) 후, 응답코드를 코어시스템에 전달하고, 계좌 등록 정보를 PG에 요청합니다. ARS 인증이 유효할 경우 응답("000") 후, 회원의 휴대 전화번호로 ARS 인증 전화 호출 및 출금이체 계좌 등록을 진행합니다.(비동기)

요청 헤더


X-KM-User-AspId

string

필수

길이 : 15

ASP ID

  • 서비스 사업자에게 부여한 ID입니다.
  • ID는 계약 시 제공됩니다.

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

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

X-KM-Access-Key

string

조건부

길이 : 40

프로젝트에서 생성된 Access Key

  • Callback API 인 경우는 제외합니다.

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

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

X-KM-Tran-Token

string

필수

길이 : 66

공통 Header 정보 - X-KM-Tran-Token

X-KM-Tran-Time

string

필수

길이 : 14

클라이언트 요청 시간

  • 형식 : YYYYMMDDHHMMSS

X-KM-Time-Zone

string

필수

길이 : 3

시간대 정보 (UTC, KST, ...)

요청 파라미터

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

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

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

bankAccount

string

필수

최소 : 1 , 최대 : 20

은행 계좌번호

bankCode

string

필수

길이 : 3

은행 코드

Bank name Code   Bank name Code
신한은행 088 KB국민은행 004
우리은행 020 하나은행 081
IBK기업은행 003 산업은행 002
NH농협은행 011 지역농축협 012
SC은행 023 카카오뱅크 090
우체국 071 새마을금고 045
수협은행 007 신협 048
부산은행 032 경남은행 039
광주은행 034 전북은행 037
제주은행 035 대구은행 031
산림조합 064 케이뱅크 089
저축은행 050 토스뱅크 092
씨티은행 027 삼성증권 240
한화투자 269 신한투자 278
교보증권 261    

 

bankName

string

필수

최소 : 1 , 최대 : 10

은행 이름

userName

string

필수

최소 : 1 , 최대 : 100

회원 이름

birthDate

string

필수

길이 : 8

회원 생년월일
- 형식 : yyyyMMdd

userType

string

옵션

최소 : 1 , 최대 : 8

계좌 입력 타입
- 기본값 : NORMAL
- NORMAL : 회원이 은행 계좌를 앱에서 직접 입력할 경우 입니다
- EXTERNAL : 회원이 은행 계좌를 제3의 제휴사의 앱에서 입력할 경우 입니다.

creationType

string

옵션

최소 : 1 , 최대 : 30

계좌 개설 타입
- 기본값 : FACE
- NON_FACE : (비대면) 회원이 코나앱에서 개설한 은행 계좌를 등록하는 경우 입니다.
- FACE : (대면) 회원이 코나앱에서 개설하지 않은 은행 계좌를 등록하는 경우 입니다.

langCode

string

옵션

최소 : 1 , 최대 : 3

ARS 인증 음성언어 코드
- 기본값 : ko

언어코드
- ko : 한국어
- en :영어
- fil : 필리핀어
- id :인도네시아어
- km : 캄보디아어
- ne : 네팔어
- vi : 베트남어
- ru : 러시아어
- mn : 몽골어
- bn : 방글라데시어
- si : 스리랑카어
- uz : 우즈베키스탄어
- ja : 일본어
- zh : 중국어

응답 헤더


X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

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

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

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

응답 파라미터


bankAccRegNo

string

필수

최소 : 1 , 최대 : 22

계좌 등록 처리번호

ARS 전화 인증 후, 계좌 등록 여부를 확인하기 위한 입력 값으로 사용됩니다.

응답 코드

Detailed classification and addition of error for unseccessful withfrawal


200

에러 코드

000_000

메시지

Success.

설명

회원의 ARS 인증 후, 은행 계좌 등록이 정상 처리되었습니다.


400

에러 코드

002_013

메시지

Ars auth and bank account register is still in progress.

설명

등록 과정이 진행 중입니다. ARS 인증 및 계좌 등록 과정이 진행 중인 상태에서 같은 회원 ID로 중복 요청할 경우 발생됩니다. ARS 인증 후, 동일 회원의 계좌 등록 과정은 동시에 2개 이상 진행될 수 없습니다.

테스트 데이터

200 - 성공 테스트


200 - 성공 테스트
200 - 성공 테스트 - OPTIONAL parameter 없이 요청
400 - 동일 회원 ID로 등록 과정이 진행 중입니다.
Loading ...

Request

Loading...

Response

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


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