거래인증 등록
인증 화면 호출을 하기 위해 결제정보를 등록하면 인증창 호출 URL을 응답으로 받을 수 있습니다.
정보
- 본 API는 VAN 결제를 위해 제공되는 서비스 입니다.
- 온라인 비대면 결제는 VAN 결제 > 간편결제 가이드를 참조하세요.
요청
요청 URL
POST https://{API 도메인}/easycheck/auth/paymentAuthReg.do
Content-type: application/json; charset=euc-kr
참고
API 멱등성 지원 대상 (API 멱등성 참조)
파라미터
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| customerKey | String | 60Byte | ✅ | 간편결제 회원 고유키 |
| easypayVirtualNo | String | 60Byte | ✅ | 고객이 선택한 결제수단 가상번호 |
| payMethodTypeCode | String | 2Byte | ✅ | 고객이 선택한 결제수단 코드 (결제수단 코드 참고) |
| payMethodDetailCode | String | 3Byte | ✅ | 고객이 선택한 결제수단 상세코드 (결제수단 코드 참고) |
| shopTransactionId | String | 60Byte | ✅ | 제휴사 거래고유번호 (API 멱등성 키) |
| shopOrderNo | String | 40Byte | ✅ | 제휴사 주문번호 |
| currency | String | 2Byte | 통화코드(온라인일 경우 필수) 원화 : “00” | |
| returnUrl | String | 256Byte | ✅ | 인증 후 되돌아갈 제휴사 리턴URL 해당 리턴URL로 Redirect됨(HTTPS만 허용) |
| shopParameter | String | 4000Byte | 제휴사 예비필드(개인정보에 해당하는 데이터는 제외하여 전달해야 합니다.) |
요청 예시
{
"channelType": "ON",
"customerKey": "{간편결제 회원 고유키}",
"easypayVirtualNo": "{고객이 선택한 결제수단 가상번호}",
"payMethodTypeCode": "11",
"payMethodDetailCode": "026",
"shopTransactionId": "{API 멱등성 키}",
"shopOrderNo": "{제휴사 주문번호}",
"currency": "00",
"amount": 1000,
"goodsName": "예시 상품명",
"returnUrl": "{제휴사 리턴 URL}"
}
응답
파라미터
| 필드명 | 타입 | 길이 | 설명 |
|---|---|---|---|
| resCd | String | 4Byte | 결과코드(정상 : “0000”) |
| resMsg | String | 1000Byte | 결과 메시지 |
| shopTransactionId | String | 60Byte | 요청 시 전송한 값 그대로 사용 |
| authPageUrl | String | 256Byte | 인증창 호출 URL(URL Encoding 됨) |
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"shopTransactionId": "{API 멱등성 키}",
"authPageUrl": "{인증창 호출 URL}"
}