신개념 결제 플랫폼, KONA PLATE

API 문서

전체 API

서비스

회원 관리
계좌 관리
계좌 인증
선불 카드 관리
체크 카드 관리
계좌 충전
계좌 자동 충전
계좌 환불
시스템 충전(예치금)
시스템 환불(예치금)
신용카드 충전
편의점 충전/출금
예치금 관리
결제
거래내역
포인트 관리
스탬프 관리
마일리지 관리
카드로 송금
ATM 출금
선불카드 선물하기
돈 옮기기
현금영수증
가맹점 관리
신용카드 자동충전
관리자 페이지용 기능

신용카드 충전 취소 요청동기

버전: v1

POST

/api/v1/recharges/online-payment/cancel

신용카드 충전 취소를 요청하여 취소 가능여부와 신용카드 취소 거래에 필요한 정보를 받습니다. 6.1. 거래내역 확인 을 통해 충전 거래 내역 중, rcgType 이 "03(신용카드)" 일 경우, 본 API를 호출하여 충전 취소할 수 있습니다.

요청 헤더

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

필수

길이 : 16

클라이언트 요청 시간

형식 : YYYYMMDDHH24MISS

X-KM-Time-Zone

string

필수

길이 : 3

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

요청 파라미터

암호화 처리|

더 자세한 정보는

가이드라인

을 참조하세요.

dcvv

string

필수

길이 : 3

DCVV

임시 토큰 생성 API 를 통해 응답 받은 dcvv 정보를 입력 데이터로 사용해야 한다.

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

회원 ID

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

sequenceId

string

필수

최소 : 1 , 최대 : 20

거래 관리번호

요청에 대해 응답을 받지 못했을 경우, 해당 관리번호로 결과를 확인하기 위한 입력 값으로 사용됩니다.

해당 번호는 제휴사에서 포멧을 정해서 unique한 값으로 입력해야 합니다.

cancelReason

string

옵션

최소 : 1 , 최대 : 256

취소 사유

oneTimeToken

string

필수

길이 : 16

임시 카드 번호

임시 토큰 생성 API 를 통해 응답 받은 oneTimeToken 정보를 입력 데이터로 사용해야 한다.

transactionId

string

조건부

길이 : 20

취소할 신용카드 충전 요청 거래 번호

transactionId, nrNumber 둘 중 하나는 필수값

nrNumber

string

조건부

길이 : 18

거래 고유 번호

transactionId, nrNumber 둘 중 하나는 필수값

응답 헤더

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

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

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

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

응답 파라미터

isPending

boolean

필수

충전 거래 대기 여부

(충전취소) 거래 과정에서 네트워크 불안 등의 원인으로 PG로부터 정상 응답을 받지 못하는 경우 해당 값을 "true"로 응답합니다.

이와 같은 거래는 은행 또는 PG의 네트워크 상황에 따라 다소 시간이 걸릴 수 있으며, 지속적으로 PG에 해당 출금 이체의 성공 여부를 체크합니다.

성공할 경우, 카드 충전취소 거래를 완료하며 실패할 경우 충전취소실패로 처리합니다.

요청 당일에 한하여 5분단위로 계속 확인 합니다.

응답 코드

Detailed classification and addition of error for unseccessful withfrawal

200

에러 코드

000_000

메시지

Success.

설명

성공

400

에러 코드

000_002

메시지

Invalid input parameter. userId

설명

입력 파라미터 오류

400

에러 코드

000_003

메시지

Missing required values. sequenceId

설명

필수 파라미터가 누락되었습니다.

400

에러 코드

007_036

메시지

TransactionId or nrNumber is required.

설명

TransactionId 과 nrNumber 값이 모두 없는 경우.

400

에러 코드

007_037

메시지

Payment denied.

설명

승인 거부됨.

400

에러 코드

007_030

메시지

Cancellation not possible for this transaction.

설명

충전 취소가 불가능한 거래.

400

에러 코드

007_022

메시지

Invalid one time token.

설명

충전 취소가 불가능한 거래.

400

에러 코드

007_038

메시지

Payment delayed.

설명

코나카드의 승인서버 또는 PG로 부터 취소 거래 지연인 경우 발생.

400

에러 코드

007_039

메시지

Payment failed.

설명

KCP로 부터 거래가 실패한 경우 발생

테스트 데이터

200 - 성공 테스트

400 - 입력 파라미터 오류.

400 - 필수 파라미터가 누락되었습니다.

400 - TransactionId 과 nrNumber 값이 모두 없는 경우.

400 - 승인 거부됨.

400 - 충전 취소가 불가능한 거래.

400 - 코나카드의 승인서버 또는 PG로 부터 취소 거래 지연인 경우 발생.

400 - KCP로 부터 거래가 실패한 경우 발생

Loading ...

Request

Response

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

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