PortOne REST API

현금영수증 관련 API

포트원 결제건 및 외부 결제 건의 현금영수증 관리와 관련된 기능을 제공합니다.

발급내역 단건 조회 API

포트원을 통해 발행된 현금영수증 상세정보를 조회하는 API입니다.

현금영수증 단건발급 API

포트원을 통해 발생된 현금성 거래(가상계좌, 계좌이체)의 포트원 거래고유번호(imp_uid)를 기준으로 현금영수증이 발급 됩니다.
imp_uid 거래를 처리하는데 사용된 PG설정값을 그대로 활용합니다.
(ex. KCP 거래건이면 KCP를 통해 현금영수증 발행 API처리)
현금영수증 발급 금액은 현금성 거래의 금액으로 자동 적용됩니다. 부분취소된 거래인 경우 남은 잔액으로 발급됩니다.

지원되는 PG사

KG 이니시스
NHN KCP
나이스페이먼츠
KICC
헥토파이낸셜(구 세틀뱅크)
키움페이(구 다우, 페이조아)
토스페이먼츠 - 신모듈
KSNET
스마트로 - 신모듈
(신) 나이스페이
웰컴페이먼츠

포트원 발급분 취소 API

delete/receipts/{imp_uid}

포트원을 통해 발급한 현금영수증 발급거래를 취소합니다
포트원과 별개로 거래된 현금영수증 취소는 DELETE 외부 발급분 취소 API를 이용해주세요.

지원되는 PG사

KG 이니시스
NHN KCP
헥토파이낸셜(구 세틀뱅크)
나이스페이먼츠
키움페이(구 다우, 페이조아)
토스페이먼츠 - 신모듈
(신) 나이스페이
KSNET
스마트로 - 신모듈
웰컴페이먼츠

외부 발급내역 단건 조회 API

get/receipts/external/{merchant_uid}

포트원 API를 통해 현금영수증만 발행된 건의 상세정보를 조회하는 API입니다. (포트원과 별개로 결제된 현금거래건)

현금영수증 발급(외부) API

post/receipts/external/{merchant_uid}

포트원과 별개로 거래된 일반 현금결제에 대해, 포트원 내에 설정된 PG사로 현금영수증 발행 요청하는 API입니다.

지원되는 PG사

KG이니시스
NHN KCP
나이스페이먼츠
KICC
헥토파이낸셜(구 세틀뱅크)
토스페이먼츠 - 신모듈
KSNET
스마트로 - 신모듈
(신) 나이스페이
웰컴페이먼츠

외부 발급분 취소 API

delete/receipts/external/{merchant_uid}

포트원과 별개로 거래된 일반 현금결제에 대해, 포트원 내에 설정된 PG사로 포트원 API를 이용해 현금영수증 발행취소하는 API입니다.

지원되는 PG사

KG이니시스
NHN KCP
헥토파이낸셜(구 세틀뱅크)
나이스페이먼츠
토스페이먼츠 - 신모듈
KSNET
스마트로 - 신모듈
(신) 나이스페이
웰컴페이먼츠

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다

ExternalReceiptAnnotation: { merchant_uid, receipt_tid, apply_num, ... }

ExternalReceiptResponse: { code, message, response }

ReceiptAnnotation: { imp_uid, receipt_tid, apply_num, ... }

ReceiptResponse: { code, message, response }

ResponseAnnotation: { code, message }