PortOne REST API - V1

결제완료된 정보, 결제취소, 상태별 결제목록 조회 등의 기능을 하는 REST API를 제공합니다.
비인증 결제, 정기 자동결제 등 부가기능을 위한 REST API도 제공합니다.

2024년 9월 1일부로 포트원 V1 API에 대해 일부 보안 규격이 지원 종료됩니다.
자세한 사항은TLS 지원 범위를 참고해주세요.

V1 API hostname: api.iamport.kr


인증 관련 API

포트원 API를 호출할 때는 액세스 토큰Authorization 헤더에 넣어주어야 합니다.
액세스 토큰은 access_token 발급 API post/users/getToken를 호출해서 발급받을 수 있습니다.

액세스 토큰 발급 API를 호출하려면 API 키API 시크릿을 인자로 넣어주어야 합니다.

결제 관련 API

get/payments/{imp_uid}/balance

결제 상세내역 조회 API

포트원 거래고유번호로 결제수단별 금액 상세정보를 확인합니다.(현재, PAYCO결제수단에 한해 제공되고 있습니다. 타 PG사의 경우 파라메터 검증 등 검토/협의 단계에 있습니다.

Request

Path

imp_uid: string
포트원 거래고유번호

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
amount: number
결제금액
PaymentBalance이력
(Optional)

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

유효하지 않은 imp_uid

405

허용되지 않는 HTTP METHOD

try
Request
Request Sample
N/A
get/payments/{imp_uid}

결제내역 단건조회 API

포트원 거래고유번호로 결제내역을 확인합니다

Request

Path

imp_uid: string
포트원 거래고유번호

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
response?: PaymentAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

유효하지 않은 imp_uid

try
Request
Request Sample
N/A
get/payments

결제내역 복수조회 API

여러 개의 포트원 거래고유번호 또는 고객사 주문번호로 결제내역을 한 번에 조회합니다.(최대 100개)
(예시) /payments?imp_uid[]=imp_448280090638&imp_uid[]=imp_448280090639&merchant_uid[]=merchant_143434085216

Request

Query

imp_uid[]?: string[]
포트원 거래고유번호
(Optional)

merchant_uid[]?: string[]
고객사 주문번호
(Optional)

Response

200

요청된 모든 imp_uid 에 대한 결제정보 응답완료

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

207

요청된 imp_uid 중 일부 거래 조회 실패(ex. 접근권한없음 또는 존재하지 않는 imp_uid)

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

해당되는 결제건을 찾지 못하였습니다.

try
Request
Request Sample
N/A
get/payments/find/{merchant_uid}/{payment_status}

결제 단건조회(고유 고객사 주문번호 조회) API

고객사지정 고유번호로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 정렬 기준에 따라 가장 첫 번째 해당되는 건을 반환합니다. (모든 내역에 대한 조회가 필요하시면 GET 결제 복수조회(고객사 주문번호 중복 포함) API를 사용해주세요.)

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.

Request

Path

merchant_uid: string
고객사 주문번호

payment_status?: string
거래상태 구분코드
(Optional)

Query

sorting?: string
정렬구분코드
(Optional)

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
response?: PaymentAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

거래건이 존재하지 않는 경우

try
Request
Request Sample
N/A
get/payments/findAll/{merchant_uid}/{payment_status}

결제 복수조회(고객사 주문번호 중복 포함) API

고객사지정 고유번호 및 상태기준으로 결제내역을 확인합니다
동일한 merchant_uid가 여러 건 존재하는 경우, 존재하는 모든 거래가 조회됩니다.

payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.

Request

Path

merchant_uid: string
고객사 주문번호

payment_status?: string
결제상태코드
(Optional)

Query

page?: integer
페이지번호
(Optional)

limit?: integer
페이지당 조회건수
(Optional)

sorting?: string
정렬기준
(Optional)

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
total: integer
전체 건수
previous: integer
이전 page숫자
next: integer
다음 page숫자
결제 상세정보 배열
(Optional)

400

merchant_uid누락, 올바르지 않은 status 등 파라메터가 잘못된 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

404

유효하지 않은 merchant_uid

try
Request
Request Sample
N/A
get/payments/status/{payment_status}

결제상태기준 복수조회 API

미결제/결제완료/결제취소/결제실패 상태 별로 검색할 수 있습니다.(20건씩 최신순 페이징)

검색기간은 최대 90일까지이며 to파라메터의 기본값은 현재 unix timestamp이고 from파라메터의 기본값은 to파라메터 기준으로 90일 전입니다. 때문에, from/to 파라메터가 없이 호출되면 현재 시점 기준으로 최근 90일 구간에 대한 데이터를 검색하게 됩니다.
from, to 파라메터를 지정하여 90일 단위로 과거 데이터 조회는 가능합니다.

Request

Path

payment_status: string
결제상태코드

Query

page?: integer
페이지번호
(Optional)

limit?: integer
페이지 당 조회건수
(Optional)

from?: integer
검색 시작 시각
(Optional)

to?: integer
검색 종료 시각
(Optional)

sorting?: string
정렬기준
(Optional)

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
(Optional)
total: integer
전체 건수
previous: integer
이전 page숫자
next: integer
다음 page숫자
결제 상세정보 배열
(Optional)

400

유효하지 않은 payment_status인 경우, 데이터 범위를 넘어선 page인 경우

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

try
Request
Request Sample
N/A
post/payments/cancel

결제취소 API

승인된 결제를 취소합니다.
신용카드/실시간계좌이체/휴대폰소액결제의 경우 즉시 취소처리가 이뤄지게 되며, 가상계좌와 휴대폰소액결제 익월 환불(KCP)의 경우는 환불받으실 계좌정보를 같이 전달해주시면 환불정보가 PG사에 등록되어 익영업일에 처리됩니다. (가상계좌 환불, 휴대폰소액결제 익월 환불(KCP)의 경우 관련 특약계약 필요)

Request

Body

imp_uid?: string
포트원 거래고유번호
(Optional)

merchant_uid?: string
고객사 주문번호
(Optional)

amount?: number
(부분)취소 요청금액
(Optional)

(부분)취소요청금액으로 누락하거나 0을 입력 시 전액취소를 요청합니다.


tax_free?: number
(부분)취소요청 금액 중 면세금액
(Optional)

(부분)취소요청금액 중 면세금액으로 누락되면 0원처리합니다.


vat_amount?: number
(부분)취소요청금액 중 부가세 금액
(Optional)

(부분)취소요청금액 중 부가세 금액으로 기본값은 null입니다.


checksum?: number
현재시점의 취소 가능한 잔액
(Optional)

취소 트랜잭션 수행 전, 현재시점의 취소 가능한 잔액


reason?: string
취소 사유
(Optional)

refund_holder?: string
환불계좌 예금주
(Optional)

refund_bank?: string
환금계좌 은행코드
(Optional)

환불받을 계좌의 은행코드


refund_account?: string
환불계좌 계좌번호
(Optional)

refund_tel?: string
환불계좌 예금주 연락처
(Optional)

extra?: array
추가 파라미터
(Optional)

Response

200

정상 조회

code?: integer
응답코드
(Optional)
message?: string
응답메세지
(Optional)
response?: PaymentAnnotation
(Optional)
imp_uid: string
포트원 거래고유번호
merchant_uid: string
고객사 주문번호
pay_method?: string
결제수단 구분코드
(Optional)
channel?: string
결제환경 구분코드
(Optional)
pg_provider?: string
PG사 구분코드
(Optional)
emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)
pg_tid?: string
PG사 거래번호
(Optional)
pg_id?: string
PG사 상점아이디
(Optional)
escrow?: boolean
에스크로결제 여부
(Optional)
apply_num?: string
승인번호
(Optional)
bank_code?: string
은행 표준코드
(Optional)
bank_name?: string
은행명
(Optional)
card_code?: string
카드사 코드번호
(Optional)
card_name?: string
카드사명
(Optional)
card_issuer_code?: string
카드 발급사 코드
(Optional)
card_issuer_name?: string
카드 발급사명
(Optional)
card_publisher_code?: string
카드 발행사 코드
(Optional)
card_publisher_name?: string
카드 발행사명
(Optional)
card_quota?: integer
할부개월 수
(Optional)
card_number?: string
카드번호
(Optional)

결제에 사용된 마스킹된 카드번호

card_type?: integer
카드 구분코드
(Optional)

결제건에 사용된 카드 구분코드

vbank_code?: string
가상계좌 은행 표준코드
(Optional)
vbank_name?: string
가상계좌 은행명
(Optional)
vbank_num?: string
가상계좌 계좌번호
(Optional)
vbank_holder?: string
가상계좌 예금주
(Optional)
vbank_date?: integer
가상계좌 입금기한
(Optional)
vbank_issued_at?: integer
가상계좌 생성시각
(Optional)
name?: string
제품명
(Optional)
amount: number
결제금액
cancel_amount: number
취소금액
currency: string
결제통화 구분코드
buyer_name?: string
주문자명
(Optional)
buyer_email?: string
주문자 Email주소
(Optional)
buyer_tel?: string
주문자 전화번호
(Optional)
buyer_addr?: string
주문자 주소
(Optional)
buyer_postcode?: string
주문자 우편번호
(Optional)
custom_data?: string
추가정보
(Optional)
user_agent?: string
단말기의 UserAgent 문자열
(Optional)
status: string
결제상태
started_at?: integer
요청 시각
(Optional)
paid_at?: integer
결제 시각
(Optional)

결제건의 결제완료 시각 UNIX timestamp

failed_at?: integer
실패시각
(Optional)

결제건의 결제실패시각 UNIX timestamp

cancelled_at?: integer
취소시각
(Optional)

결제건의 결제취소시각 UNIX timestamp

fail_reason?: string
결제실패 사유
(Optional)

결제건의 결제실패 사유

cancel_reason?: string
결제취소 사유
(Optional)

결제건의 결제취소 사유

receipt_url?: string
매출전표 URL
(Optional)
cancel_history?: PaymentCancelAnnotation[]
취소 내역
(Optional)
cancel_receipt_urls?: string[]
(Optional)

(Deprecated : cancel_history 사용 권장) 취소/부분취소 시 생성되는 취소 매출전표 확인 URL. 부분취소 횟수만큼 매출전표가 별도로 생성됨

cash_receipt_issued?: boolean
현금영수증 발급 여부
(Optional)
customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)
customer_uid_usage?: string
구매자의 결제 수단 식별 고유번호 사용 구분코드
(Optional)
promotion?: object
프로모션 정보
(Optional)

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우

try
Request
Request Sample
N/A

결제 금액 사전 등록 관련 API

비인증 결제 관련 API

별도 결제창 호출없이 결제를 진행할 수 있는 비인증 결제 기능을 제공합니다.

정기 결제 관련 API

빌링키 관련 API

가상계좌 관련 API

PG사 관련 API

PG사 별 추가로 지원하는 기능을 제공합니다.

카카오 관련 API

카카오페이에서 지원하는 기능을 제공합니다.

KCP 퀵페이 관련 API

KCP 퀵페이에서 지원하는 기능을 제공합니다.

네이버페이 관련 API

네이버페이에서 지원하는 기능을 제공합니다.

목차

(주문형-네이버페이) 네이버페이 주문환불 API
post/payments/{imp_uid}/naver/cancel
(주문형-네이버페이) 구매자의 환불요청 승인처리 API
post/payments/{imp_uid}/naver/approve-cancel
(주문형-네이버페이) 상품주문 발송처리 API
post/payments/{imp_uid}/naver/ship
(주문형-네이버페이) 교환승인된 상품 재발송처리 API
post/payments/{imp_uid}/naver/ship-exchanged
(주문형-네이버페이) 교환승인된 상품 수거완료처리 API
post/payments/{imp_uid}/naver/collect-exchanged
(주문형-네이버페이) 상품발주처리 API
post/payments/{imp_uid}/naver/place
(주문형-네이버페이) 상품반품요청 API
post/payments/{imp_uid}/naver/request-return
(주문형-네이버페이) 상품 반품승인 처리 API
post/payments/{imp_uid}/naver/approve-return
(주문형-네이버페이) 상품 반품거절 처리 API
post/payments/{imp_uid}/naver/reject-return
(주문형-네이버페이) 상품 반품보류 처리 API
post/payments/{imp_uid}/naver/withhold-return
(주문형-네이버페이) 반품보류상품 반품보류해제 처리 API
post/payments/{imp_uid}/naver/resolve-return
(결제형-네이버페이) 네이버페이 포인트 적립 API
post/payments/{imp_uid}/naver/point
(결제형-네이버페이) 에스크로 주문 확정 API
post/payments/{imp_uid}/naver/confirm
(주문형-네이버페이) 포트원 거래고유번호 기준 네이버페이 상품주문 조회 API
get/payments/{imp_uid}/naver/product-orders
(주문형-네이버페이) 네이버페이 상품주문번호로 상품주문 상세 조회 API
get/naver/product-orders/{product_order_id}
(주문형-네이버페이) 네이버페이 구매평 조회 API
get/naver/reviews
(결제형-네이버페이) 현금영수증 발급 가용액 조회 API
get/payments/{imp_uid}/naver/cash-amount

페이코 관련 API

페이코에서 지원하는 기능을 제공합니다.

페이먼트월 관련 API

페이먼트월에서 지원하는 기능을 제공합니다.

본인인증 관련 API

현금영수증 관련 API

에스크로 관련 API

고객사 정보 관련 API

고객사 정보를 관리하는 기능을 제공합니다.

고객사의 하위 상점 관련 API

하위 상점 관련 API

하위 상점과 관련된 기능을 제공합니다.

기타 API

부가적인 기능을 제공합니다.

베네피아 포인트 관련 API

베네피아 포인트(복지 포인트)와 관련된 기능을 제공합니다.

결제기관 관련 API

편의점 결제 관련 API

편의점 결제를 위한 수납 번호(barcode)와 관련된 기능을 제공합니다.

타입 정의

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