Developer Portal

본문 바로가기
대 메뉴 바로가기

간편결제 승인취소

케이뱅크페이 결제승인취소

API 명 (URI)	/api/v1/payment/cancel
Method	POST
Content-Type

케이뱅크페이로 결제승인한 건을 취소요청합니다.

API 명 (URI)	/api/v1/payment/cancel
Method	POST
Content-Type

케이뱅크페이로 결제승인한 건을 취소요청합니다.

요청 메시지

구분	이름	설명	필수여부	항목유형	데이터유형	길이
Header	HMAC_SINGNATURE	HMAC 인증	Y	Field	String	400
Header	HMAC_TIMESTAMP	HMAC 요청시간	Y	Field	String	14
Body	CNCL_REQ_DT	취소요청일자	Y	Field	String	8
Body	APRVL_NBR	원거래 승인번호		Field	String	20
Body	ORG_APRVL_DT	원거래 승인일자		Field	String	8
Body	CNCL_REQ_TM	취소요청시간	Y	Field	String	6
Body	ALCO_ID	제휴사 식별자	Y	Field	String	15
Body	CNCL_AMT	취소금액	Y	Field	Number	12
Body	CNCL_DS_CD	취소 구분 코드	Y	Field	String	1
Body	ALCO_ORDN_NBR	제휴사 주문번호	Y	Field	String	40

구분	이름	설명	필수여부	항목유형	데이터유형	길이
Header	HMAC_SINGNATURE	HMAC 인증	Y	Field	String	400
Header	HMAC_TIMESTAMP	HMAC 요청시간	Y	Field	String	14
Body	CNCL_REQ_DT	취소요청일자	Y	Field	String	8
Body	APRVL_NBR	원거래 승인번호		Field	String	20
Body	ORG_APRVL_DT	원거래 승인일자		Field	String	8
Body	CNCL_REQ_TM	취소요청시간	Y	Field	String	6
Body	ALCO_ID	제휴사 식별자	Y	Field	String	15
Body	CNCL_AMT	취소금액	Y	Field	Number	12
Body	CNCL_DS_CD	취소 구분 코드	Y	Field	String	1
Body	ALCO_ORDN_NBR	제휴사 주문번호	Y	Field	String	40

요청 메시지 예제

Header

Content-Type: application/json

Body

{ "CNCL_REQ_DT": "20241114", "APRVL_NBR": "20241114", "ORG_APRVL_DT": "20241023", "CNCL_REQ_TM": "164050", "ALCO_ID": "AL2024011101001", "CNCL_AMT": 20000, "CNCL_DS_CD": "C", "ALCO_ORDN_NBR": "103045678" }

응답 메시지

구분	이름	설명	필수여부	항목유형	데이터유형	길이
Body	ALCO_ID	제휴사 식별자	Y	Field	String	15
Body	CNCL_REQ_DT	취소요청일자	Y	Field	String	8
Body	CNCL_REQ_TM	취소요청시간	Y	Field	String	6
Body	ALCO_ORDN_NBR	원거래 주문번호	Y	Field	String	40
Body	ORG_APRVL_DT	원거래 승인일자	Y	Field	String	8
Body	CNCL_AMT	취소금액	Y	Field	Number	12
Body	APRVL_NBR	원거래 승인번호		Field	String	20
Body	EXCL_CNCL_DSCD	정산취소구분코드		Field	String	1
Body	RSLT_CD	결과코드	Y	Field	String	4
Body	RSLT_MSG	결과메시지	Y	Field	String	100

구분	이름	설명	필수여부	항목유형	데이터유형	길이
Body	ALCO_ID	제휴사 식별자	Y	Field	String	15
Body	CNCL_REQ_DT	취소요청일자	Y	Field	String	8
Body	CNCL_REQ_TM	취소요청시간	Y	Field	String	6
Body	ALCO_ORDN_NBR	원거래 주문번호	Y	Field	String	40
Body	ORG_APRVL_DT	원거래 승인일자	Y	Field	String	8
Body	CNCL_AMT	취소금액	Y	Field	Number	12
Body	APRVL_NBR	원거래 승인번호		Field	String	20
Body	EXCL_CNCL_DSCD	정산취소구분코드		Field	String	1
Body	RSLT_CD	결과코드	Y	Field	String	4
Body	RSLT_MSG	결과메시지	Y	Field	String	100

응답 메시지 예제

Body

{ "ALCO_ID": "AL2024011101001", "CNCL_REQ_DT": "20241023", "CNCL_REQ_TM": "103045", "ALCO_ORDN_NBR": "20241023103035eADOrCtNWN", "ORG_APRVL_DT": "20241023", "CNCL_AMT": 20000, "APRVL_NBR": "2024102311111", "EXCL_CNCL_DSCD": "C", "RSLT_CD": "0000", "RSLT_MSG": "처리성공" }

테스트

API 이용 신청