결제취소 확인
일정 시간동안 결제취소 완료 노티를 수신하지 못할 경우 사용하는 API 입니다.
요청
요청 URL
POST https://{API 도메인}/api/trades/wechatpay/find
Content-type: application/json; charset=utf-8
참고
API 멱등성 지원 대상 (API 멱등성 참조)
주의사항
최종 결제취소 확인이 완료되기까지 시간이 걸리므로 timeout을 30초로 설정해야 합니다.
파라미터
| 필드명 | 타입 | 길이 | 필수여부 | 설명 |
|---|---|---|---|---|
| mallId | String | 8Byte | ✅ | KICC에서 부여한 상점ID |
| shopTransactionId | String | 60Byte | ✅ | 상점 거래고유번호 (API 멱등성 키) |
| pgCno | String | 60Byte | ✅ | 결제승인 거래고유번호(거래생성 응답으로 받은 값) |
| cancelPgCno | String | 60Byte | ✅ | 결제취소 거래고유번호(결제취소 접수 시 응답으로 받은 값) |
요청 예시
{
"mallId": "{상점ID}",
"shopTransactionId": "{API 멱등성 키}",
"pgCno": "{결제승인 거래고유번호}",
"cancelPgCno": "{결제취소 거래고유번호}"
}
응답
파라미터
| 필드명 | 타입 | 길이 | 설명 |
|---|---|---|---|
| resCd | String | 4Byte | 응답코드 |
| resMsg | String | 1000Byte | 응답메시지 |
| shopTransactionId | String | 60Byte | 요청 시 전송한 값 그대로 사용 |
| mallId | String | 8Byte | KICC에서 부여한 상점ID |
| pgCno | String | 60Byte | 결제승인 거래고유번호 |
| cancelPgCno | String | 60Byte | 결제취소 거래고유번호 |
| transactionDate | String | 14Byte | 거래일시(yyyyMMddHHmmss) |
| cancelStatus | String | 4Byte | 거래 상태 승인: “TS01”, 전체취소: “TS02”, 부분취소: “TS06”, 망취소: “TS12” |
| resDetailMsg | String | 1024Byte | 오류 시 위쳇에서 내려주는 상세 메시지(URL encoding) |
| amountInfo | Object | 결제 금액 정보 (아래 amountInfo 참조) |
amountInfo(결제금액 정보)
| 필드명 | 타입 | 길이 | 설명 |
|---|---|---|---|
| currency | String | 2Byte | 통화코드 |
| totAmount | Number | 총 결제금액 |
응답 예시
{
"resCd": "0000",
"resMsg": "정상처리",
"shopTransactionId": "{API 멱등성 키}",
"mallId": "{상점ID}",
"pgCno": "{결제승인 거래고유번호}",
"cancelPgCno": "{결제취소 거래고유번호}",
"transactionDate": "20230312000512",
"cancelStatus": "TS02",
"amountInfo": {
"currency": "KRW",
"totAmount": 1000
}
}