| Doc. No. | A7S7V1 | ||
|---|---|---|---|
| API Title | 결제 > One-Time Token을 이용한 결제 요청 | ||
| API Description | 일회용 Token을 이용한 결제 요청 API 입니다. 일회용 Token을 획득 후 해당 카드번호로 결제데이터를 만들어 처리합니다. 응답으로 받은 "nrNumber"는 결제 취소 시에 사용 됩니다. |
||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v1/payment/no-hce |
| Data Encryption | Request : NO / Response : YES | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| oneTimeToken | STRING | 16 | MANDATORY | 일회용 Token 일회용 Token 발급 요청 시 응답 받은 값입니다. |
||
| amount | NUMBER | 0~999999999999 | MANDATORY | 결제 요청금액 | ||
| merchantId | STRING | 15 | MANDATORY | 결제요청하는 가맹점ID | ||
| dcvv | STRING | 3 | MANDATORY | DCVV 일회용 Token 발급 요청 시 응답 받은 값입니다. |
||
| exceptAmount | NUMBER | 0~999999999999 | OPTIONAL | 소득공제 제외금액 - 1회용컵 보증금 처리 등에 사용됩니다. |
||
| channel | STRING | 1~20 | MANDATORY | 서비스 구분 코드 - 서비스를 구분하는 코드 입니다. - 예; OPENAPI, KONA, JADU, PINO, HEALTH |
||
| vat | NUMBER | 0~999999999999 | OPTIONAL | 부가세 | ||
| transactionId | STRING | 28 | MANDATORY | 클라이언트 거래고유키
모든 거래마다 고유해야 함니다. - 공백없는 문자 28자리 |
||
| isOnlyCheck | BOOLEAN | OPTIONAL | 결제가능여부 확인용도 - true : 실결제 전 결제가능여부 확인. 실제 결제에 반영되지는 않음 - false : 실결제 - 기본값 : false |
|||
| trSubStatus | STRING | 3 | OPTIONAL | 정산유형 - "S01" : 직가맹정산 - "M01" : 대표가맹점정산 |
||
| subList | ARRAY | OPTIONAL | 하위가맹점 목록 | |||
| └ subMerchantId | STRING | 15 | MANDATORY | 하위가맹점 아이디 | ||
| └ subAmt | NUMBER | 0~999999999999 | MANDATORY | 하위가맹점 결제금액 | ||
| rcgType | STRING | 2 | OPTIONAL | 충전지불타입 - 기본값 : null - 03 : 직불 결제 |
||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| cardNo | STRING | 16 | MANDATORY | 일회용 Token을 발급받기 위해 사용된 카드번호 | ||
| balance | NUMBER | 0~999999999999 | MANDATORY | 카드 잔액 | ||
| approvalCode | STRING | 6 | MANDATORY | 승인번호 | ||
| nrNumber | STRING | 18 | MANDATORY | 거래 고유번호 - Network Reference Number |
||
| approvalTime | STRING | 17 | MANDATORY | 결제 승인시간 - 형식 : yyyyMMddHHmmssSSS |
||
| trAmount | NUMBER | 0~999999999999 | MANDATORY | 결제 시 사용된 카드충전액 | ||
| userSavedPoint | NUMBER | 0~999999999999 | MANDATORY | 거래 시 적립된 유저포인트(비동기서비스 제외) | ||
| cardSavedPoint | NUMBER | 0~999999999999 | MANDATORY | 거래 시 적립된 카드포인트(비동기서비스 제외) | ||
| benefitTranList | ARRAY | MANDATORY | 혜택정보 - 거래시 사용된 혜택정보(쿠폰, 즉시할인, 추가적립) |
|||
| └ discountSubType | STRING | 2 | OPTIONAL | 혜택 타입 - 01 : 즉시할인 - 02 : 추가적립형포인트 - 05 : 할인형포인트 |
||
| └ settleRate | FLOAT | 0.0000000 ~ 999.9999999 | OPTIONAL | 할인율 | ||
| └ discountAmount | NUMBER | 0~999999999999 | OPTIONAL | 할인금액 | ||
| └ couponId | STRING | 15 | OPTIONAL | 쿠폰ID - 해당값이 있는 경우, 쿠폰에 의한 혜택 임 |
||
| complexTranList | ARRAY | OPTIONAL | 복합결제시 사용된 포인트 정보 | |||
| └ priority | NUMBER | 0~100 | OPTIONAL | 복합결제우선순위 | ||
| └ trAmount | NUMBER | 0~999999999999 | OPTIONAL | 사용된 금액 | ||
| └ policyType | STRING | 2 | OPTIONAL | 카드 포인트 정책 타입 - 00 : 유저(사용자) - 01 : 정책수당 - 02 : 인센티브 - 03 : 복지(급여성) - 04 : 복지(경비성) - 05 : 제휴 - 06 : 법인 - 07 : 기부 - 99 : 잔액 - null : 알 수 없음 |
||
| └ policyId | STRING | 15 | OPTIONAL | 포인트 정책 ID | ||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||
| 400 | 006_005 | The entered card cannot be transacted through the POS Entry Mode. | 입력 된 카드는 해당 POS Entry Mode(DE 22)를 통해 거래할 수 없습니다. |
| 400 | 006_006 | Invalid Transaction. | 카드 단말기 시간이 잘못 되었습니다. |
| 400 | 006_007 | Invalid amount. | 잘못 된 거래 금액입니다.(잔액 부족) |
| 400 | 006_008 | Invalid card number. | 잘못 된 카드 번호입니다. |
| 400 | 006_009 | Requeset format error. | 잘못 된 ISO-8583 형식입니다. |
| 400 | 006_010 | Over limit of the store. | 결제/충전/환불할 수 있는 금액을 초과한 요청입니다. |
| 400 | 006_011 | Expired card. | 만료된 카드입니다. |
| 400 | 006_012 | Transaction not permitted. | 거래를 할 수 있는 권한이 부족한 경우입니다.
- 결제취소의 경우, 취소할 원장거래가 존재하지 않음 |
| 400 | 006_013 | Transaction does not permitted to terminal. | 잘못 된 취급 기관 코드입니다. |
| 400 | 006_014 | Restricted card. | 사용제한 된 카드입니다. |
| 400 | 006_015 | Security Violation. | 잘못 된 ATC 입니다. |
| 400 | 006_016 | Exceeded number of PIN attempts. | PIN Try count 초과입니다. |
| 400 | 006_017 | Cryptographic Failure. | 크립토그램 검증 실패하였습니다. |
| 400 | 006_018 | Unacceptable PIN. | 잘못 된 PIN 입니다. |
| 400 | 006_021 | Request for duplicated transaction. | 중복 된 거래 요청입니다. |
| 400 | 006_022 | System error. | 시스템 실패입니다. |
| 400 | 006_027 | Invalid merchant. | 유효하지 않은 가맹점 입니다. |
| 400 | 006_028 | Expired one time token. | 만료된 일회용 Token 입니다. |
| 400 | 006_031 | Already used one time token. | 이미 사용된 일회용 Token 입니다. |