| Doc. No. | A7S8V1 | ||
|---|---|---|---|
| API Title | 결제 > One-Time Token을 이용한 결제 거래의 취소 요청 | ||
| API Description | 일회용 Token을 이용한 결제의 결제취소를 요청하는 API 입니다. 원거래의 응답데이터로 전달한 실제카드번호와 nrNumber를 요청데이터로 받아 결제취소데이터를 구성합니다. |
||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v1/payment/cancel/no-hce |
| Data Encryption | Request : YES / Response : NO | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| cardNo | STRING | 16 | MANDATORY | 카드번호 - 현재 활성화 되어있는 카드번호를 사용해야 합니다. - 결제 후 카드 재발급을 받은 상태에서의 결제취소는 재발급 받은 카드번호를 사용해야 합니다. |
||
| amount | NUMBER | 0~999999999999 | MANDATORY | 원거래 승인금액 | ||
| nrNumber | STRING | 18 | MANDATORY | 거래 고유번호 - Network Reference Number |
||
| merchantId | STRING | 15 | MANDATORY | 결제요청하는 가맹점ID | ||
| channel | STRING | 1~20 | MANDATORY | 서비스 구분 코드 - 서비스를 구분하는 코드 입니다. - 예; OPENAPI, KONA, JADU, PINO, HEALTH |
||
| trSubStatus | STRING | 3 | OPTIONAL | 정산유형 - "S01" : 직가맹정산 - "M01" : 대표가맹점정산 |
||
| subList | ARRAY | OPTIONAL | 하위가맹점 목록 | |||
| └ subMerchantId | STRING | 15 | MANDATORY | 하위가맹점 아이디 | ||
| └ subAmt | NUMBER | 0~999999999999 | MANDATORY | 하위가맹점 결제금액 | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| balance | NUMBER | 0~999999999999 | MANDATORY | 카드 잔액 | ||
| approvalTime | STRING | 17 | MANDATORY | 서버 취소승인시간 - 형식 : yyyyMMddHHmmssSSS |
||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||
| 400 | 006_007 | Invalid amount. | 잘못 된 거래 금액입니다.(잔액 부족) |
| 400 | 006_010 | Over limit of the store. | 사용자 혹은 가맹점에서 결제할 수 있는 최대 금액 초과입니다. |
| 400 | 006_011 | Expired card. | 만료된 카드입니다. |
| 400 | 006_021 | Request for duplicated transaction. | 이미 취소된 거래입니다. |
| 400 | 006_022 | System Error. | 시스템 실패입니다. |
| 400 | 006_027 | Invalid merchant. | 유효하지 않은 가맹점 입니다.
- 원거래 가맹점정보와 다른 경우 |
| 400 | 006_030 | No original transaction. | 원거래 정보가 없습니다. |