개발자센터

결제 관련 API

결제 건과 관련된 기능을 제공합니다.
포트원 거래고유번호로 결제수단별 금액 상세정보를 확인합니다.(현재, PAYCO결제수단에 한해 제공되고 있습니다. 타 PG사의 경우 파라메터 검증 등 검토/협의 단계에 있습니다.
포트원 거래고유번호로 결제내역을 확인합니다
여러 개의 포트원 거래고유번호 또는 고객사 주문번호로 결제내역을 한 번에 조회합니다.(최대 100개)
(예시) /payments?imp_uid[]=imp_448280090638&imp_uid[]=imp_448280090639&merchant_uid[]=merchant_143434085216
고객사지정 고유번호로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 정렬 기준에 따라 가장 첫 번째 해당되는 건을 반환합니다. (모든 내역에 대한 조회가 필요하시면 GET 결제 복수조회(고객사 주문번호 중복 포함) API를 사용해주세요.)

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.
고객사지정 고유번호 및 상태기준으로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 존재하는 모든 거래가 조회됩니다.

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.
미결제/결제완료/결제취소/결제실패 상태 별로 검색할 수 있습니다.(20건씩 최신순 페이징)

검색기간은 최대 90일까지이며 to파라메터의 기본값은 현재 unix timestamp이고 from파라메터의 기본값은 to파라메터 기준으로 90일 전입니다. 때문에, from/to 파라메터가 없이 호출되면 현재 시점 기준으로 최근 90일 구간에 대한 데이터를 검색하게 됩니다.
from, to 파라메터를 지정하여 90일 단위로 과거 데이터 조회는 가능합니다.
승인된 결제를 취소합니다.
신용카드/실시간계좌이체/휴대폰소액결제의 경우 즉시 취소처리가 이뤄지게 되며, 가상계좌와 휴대폰소액결제 익월 환불(KCP)의 경우는 환불받으실 계좌정보를 같이 전달해주시면 환불정보가 PG사에 등록되어 익영업일에 처리됩니다. (가상계좌 환불, 휴대폰소액결제 익월 환불(KCP)의 경우 관련 특약계약 필요)

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
MultiplePaymentsResponse: { code, message, response }
PagedPaymentAnnotation: { total, previous, next, ... }
PaymentAnnotation: { imp_uid, merchant_uid, pay_method, ... }
PaymentBalanceAnnotation: { tax_free, supply, vat, ... }
PaymentBalanceHistoriesAnnotation: { cash_receipt, primary, secondary, ... }
PaymentBalanceResponse: { code, message, response }
PaymentBalanceResponseAnnotation: { amount, cash_receipt, primary, ... }
PaymentCancelAnnotation: { pg_tid, amount, cancelled_at, ... }
PaymentListResponse: { code, message, response }
PaymentResponse: { code, message, response }
ResponseAnnotation: { code, message }
VbankDepositAnnotation: { pg_tid, amount, depositor_name, ... }