⌨️수납취소 API
편의점결제 발급/등록된 수납번호(barcode)를 말소처리합니다
수납번호(barcode)로 결제가 이뤄지지 않도록 말소처리하는 API입니다.
수납번호 취소
DELETE https://api.iamport.kr/cvs/{imp_uid}
고객에게 이미 발급/등록된 편의점결제 수납번호(barcode)가 아직 수납 전일 때, 재고소진 등에 상황에 따라 해당 수납번호(barcode)로 결제가 이뤄지지 않도록 말소처리하는 API입니다.
Path Parameters
imp_uid*
String
포트원 거래번호
편의접결제 수납번호(barcode) 발급/등록된 번호
code * integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message * string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
response (PaymentAnnotation, optional)
code * integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message * string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
imp_uid * string
포트원 결제 고유 UID
merchant_uid * string
주문번호
pay_method * string
결제수단 구분코드
channel * string
결제환경 구분코드
pc : (인증방식)PC결제
mobile:(인증방식)모바일결제
api:정기결제 또는 비인증 결제
pg_provider * string
PG사 구분코드
emb_pg_provider * string
허브형결제 PG사 구분코드
pg_tid * string
pg사 거래번호
pg_id * string
PG사 MID
escrow boolean
에스크로 결제여부
apply_num string
신용카드 승인번호
bank_code string
은행 표준코드(링크보기)
bank_name string
은행 명칭
card_code string
카드사 코드번호(금융결제원 표준코드번호 : 링크 )
card_name string
카드사명
card_quota integer
할부개월 수(0이면 일시불)
card_number string
마스킹 카드번호
card_type string
카드 구분코드
0 : 신용카드
1 : 체크카드
vbank_code string
가상계좌 은행 표준코드(하단이미지 참고)
vbank_name string
입금받을 가상계좌 은행명
vbank_holder string
입금받을 가상계좌 예금주
vbank_date string
입금받을 가상계좌 마감기한 (UNIX timestamp)
vbank_issued_at string
가상계좌 생성 시각 (UNIX timestamp)
name string
제품명
amount * integer
주문(결제)금액
cancel_amount integer
결제취소금액
currency string
통화구분코드
USD
KRW
EUR
buyer_name string
주문자명
buyer_email string
주문자 Email주소\
buyer_tel string
주문자 전화번호
buyer_addr string
주문자 주소
buyer_postcode string
주문자 우편번호
custom_data string
echo data
JSON string으로 전달
user_agent string
UserAgent
결제를 시작한 단말기 정
status * string
결제상태 구분코드
ready
paid
cancelled
failed
started_at * string
결제시작시점 (UNIX timestamp)
paid_at * string
결제완료시점 (UNIX timestamp)\
failed_at * string
결제실패시점 (UNIX timestamp)
cancelled_at * string
결제취소시점 (UNIX timestamp)
fail_reason string
결제실패 사유
cancel_reason string
결제취소 사유
receipt_url string
신용카드 매출전표 확인 URL
cash_receipt_issued boolean
현금영수증 자동발급 여부
customer_uid string
해당 결제처리에 사용된 customer_uid
customer_uid_usage string
customer_uid 사용 구분코드
issue : 빌링키 발급
payment : 결제
payment.scheduled : 예약결제
cancel_history (Array[PaymentCancelAnnotation], optional):
취소/부분취소 내역
pg_tid * string
PG사 승인취소번호
amount * integer
취소 금액
cancelled_at * string
결제취소된 시각 UNIX timestamp
reason * string
결제취소 사유
receipt_url * string
취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음
Swagger Test Link
Last updated