회원(UserKey) 조회하기
1. UserKey 조회 API Flow
2. 설명 (Description)
- 페이유에 가입된 회원의 key(UserKey) 값을 조회할 목적으로 사용되는 API입니다.
- 가맹점에서는 자체적으로 관리하는 ID 값을 MallUserID 필드에 입력하여 요청하면, MID, MallUserID와 매칭되는 회원의 Key 값을 응답받을 수 있습니다.
- 회원의 고유 식별 값으로 가맹점에서는 자체 ID와 페이유 UserKey를 매핑하여 자체적으로 관리해야 합니다.
3. 요청 (Request)
3.1. HTTP Request
- Method:
POST - URL:
https://payu-api.nicepay.co.kr/api/inquery_userkey.do - Content-Type:
application/x-www-form-urlencoded - Encoding:
EUC-KR
3.2. 요청 파라미터
| 필드명 | 크기(byte) | 필수 | 설명 |
|---|---|---|---|
| MID | 10 | O | 가맹점 아이디 |
| MallUserID | 20 | O | 가맹점 고객 아이디 |
| EdiDate | 14 | O | 요청 전문 생성 일시(YYYYMMDDHHMISS) |
| ReqType | 2 | O | 요청 타입 (40: MallUserID 파라미터 검증, 42: MallUserID 및 회원정보 검증) |
| Moid | 64 | O | 가맹점 주문번호 (고유한 값으로 설정, 나이스페이 가공 없음) |
| SignData | 500 | O | 위변조 검증 데이터, 생성규칙: hex(sha256(MID + MallUserID + EdiDate + ReqType + Moid + MerchantKey)) |
| UserName | 30 | 고객 이름 ReqType이 42인 경우에만 필수 | |
| UserTelNo | 12 | 고객 전화번호 (숫자만 입력) ReqType이 42인 경우에만 필수 | |
| UserBirthDt | 8 | 고객 생년월일 (YYYYMMDD) ReqType이 42인 경우에만 필수 | |
| CharSet | 10 | 인증 응답 인코딩 (euc-kr(default) / utf-8) |
4. 응답 (Response)
4.1. 응답 파라미터
PG사의 기능 추가 및 서비스 개선에 따라 응답 필드는 사전 고지 없이 추가될 수 있습니다.
가맹점에서는 아래 표에 기재되지 않은 응답 필드가 추가될 수 있음을 고려하여 연동해야 하며, 추가 필드로 인해 파싱 오류 또는 결과 처리 오류가 발생하지 않도록 구현해야 합니다.
| 필드명 | 크기(byte) | 설명 |
|---|---|---|
| ResultCode | 4 | 결과코드 (0000: 성공, 이외 실패) |
| ResultMsg | 100 | 결과 메세지 |
| TID | 30 | 거래 아이디, 나이스페이에서 요청 트랜잭션을 처리한 고유한 식별값 |
| MID | 10 | 가맹점 아이디 |
| MallUserID | 1 | 가맹점 고객 아이디 (요청한 MallUserID 그대로 응답) |
| ReqType | 2 | 요청 타입 |
| Moid | 64 | 가맹점 주문번호 |
| UserKey | 30 | 회원 등록 시 발급된 사용자 Key |
| Signature | 500 | 위변조 검증 데이터, 생성규칙: hex(sha256(MID + ReqType + Moid + MerchantKey)) |
5. 예시
아래 예시는 테스트 시 이해를 돕기 위해 임의로 만든 데이터로 요청 및 응답 규격을 확인하기 위한 용도입니다.
예시 데이터를 실제 API 요청에 사용하지 않도록 주의해주세요.
5.1. 요청 예시
POST /api/inquery_userkey.do HTTP/1.1
Host: payu-api.nicepay.co.kr
Content-Type: application/x-www-form-urlencoded
MID=payutest0m&MallUserID=payuTEST&ReqType=40&Moid=test&CharSet=utf-8&EdiDate=20260814110212&SignData=47bf8c8095cfd5215014969741806918f039d58ef9093a96da375d6cd5b51a34
5.2. 응답 예시
{
"ReqType": "40",
"UserKey": "PAYTKN816bdce64a149f2af7e90603a57446716af2b0a9f34e1427352c5405f2a6acf0",
"Signature": "0bb453744ef80b82b4334063b378da4f71ff95fb1223ef3e1f75a2642c5e5622",
"ResultMsg": "정상 처리되었습니다.",
"MID": "payutest0m",
"Moid": "test",
"ResultCode": "0000",
"TID": "payutest0m00012608141114173326",
"MallUserID": "payuTEST"
}