거래조회 연동하기
1. 거래조회 API Flow
2. 설명 (Description)
- 원하는 거래 아이디(TID)의 승인/취소 여부를 확인할 수 있는 API입니다.
- 결제수단이 가상계좌인 TID의 경우 고객께서 가상계좌 발급 이후 입금까지 완료하여야 승인 상태로 분류됩니다.
- 가상계좌 발급 완료 후 입금하기 전 상태의 TID로 거래조회 API 요청 시
승인거래 없음으로 응답됩니다.
3. 요청 (Request)
3.1. HTTP Request
- Method:
POST - URL:
https://webapi.nicepay.co.kr/webapi/inquery/trans_status.jsp - Content-Type:
application/x-www-form-urlencoded - Encoding:
EUC-KR
3.2. 요청 파라미터
| 필드명 | 크기(byte) | 필수 | 설명 |
|---|---|---|---|
| TID | 30 | O | 거래 아이디 |
| MID | 10 | O | 가맹점 아이디 |
| EdiDate | 14 | O | 요청 전문 생성 일시(YYYYMMDDHHMISS) |
| SignData | 256 | O | 위변조 검증 데이터, 생성규칙: hex(sha256(TID + MID + EdiDate + MerchantKey)) |
| CharSet | 10 | 인증 응답 인코딩 (euc-kr(default) / utf-8) | |
| EdiType | 10 | 응답전문 유형 (JSON(default) / KV) *KV:Key=value |
4. 응답 (Response)
4.1. 응답 파라미터
PG사의 기능 추가 및 서비스 개선에 따라 응답 필드는 사전 고지 없이 추가될 수 있습니다.
가맹점에서는 아래 표에 기재되지 않은 응답 필드가 추가될 수 있음을 고려하여 연동해야 하며, 추가 필드로 인해 파싱 오류 또는 결과 처리 오류가 발생하지 않도록 구현해야 합니다.
| 필드명 | 크기(byte) | 설명 |
|---|---|---|
| ResultCode | 4 | 결과코드 (0000: 성공, 이외 실패) |
| ResultMsg | 100 | 결과 메세지 |
| TID | 30 | 거래 아이디 |
| Status | 1 | 거래 상태 (0: 승인, 1: 취소, 9: 거래 없음) |
| AuthCode | 30 | 승인번호 |
| AuthDate | 12 | 승인 일시 (YYMMDDHHMISS) |
5. 예시
아래 예시는 테스트 시 이해를 돕기 위해 임의로 만든 데이터로 요청 및 응답 규격을 확인하기 위한 용도입니다.
예시 데이터를 실제 API 요청에 사용하지 않도록 주의해주세요.
5.1. 요청 예시
POST /webapi/inquery/trans_status.jsp HTTP/1.1
Host: webapi.nicepay.co.kr
Content-Type: application/x-www-form-urlencoded
TID=nicepay00m01012604221921161308&MID=nicepay00m&EdiDate=20260422195520&SignData=571a10a067f817e2b4c62f898a686b9a2d68cf4b4ac5780c6b3c38a27ad405bf
5.2. 응답 예시
{
"ResultCode":"0000",
"ResultMsg":"정상 처리되었습니다.",
"TID":"nicepay00m01012604221921161308",
"Status":"0",
"AuthCode":"10913843",
"AuthDate":"260422192117"
}