개발자센터
V1
V2
파트너 정산 릴리즈 노트 기술 블로그

PortOne REST API - V1

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

V1 API hostname: api.iamport.kr


인증 관련 API

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

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

API 키와 API 시크릿 확인하기

  1. 관리자 콘솔 상점・계정 관리 화면 접속
  2. 내 식별코드・API Keys 버튼 클릭
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다
API 키와 API 시크릿은 관리자 콘솔 → 상점・계정 관리 메뉴 → 내 식별코드・API Keys 모달을 열어서 확인하실 수 있습니다

API 시크릿은 절대로 외부에 노출되어서는 안 되는 값입니다.
실제 구현에서 액세스 토큰 발급은 꼭 서버 사이드에서 해주세요.

액세스 토큰 발급 받기

access_token 발급 API post/users/getToken 호출

/users/getToken API를 호출해서 액세스 토큰을 발급받습니다
/users/getToken API를 호출해서 액세스 토큰을 발급받습니다

포트원 REST API 서버는 Google Public NTP의 시간과 동기화되고 있습니다.

하위 상점 연동을 할 경우 액세스 토큰을 발급받을 때 Agent 계정API 키API 시크릿을 사용해야 합니다.

Agency & Tier 란?

액세스 토큰 사용하기

발급받은 액세스 토큰은 다른 API를 호출할 때
Authorization 헤더에 Bearer <액세스 토큰> 형식의 값을 넣어주면 됩니다.

자세한 내용은 MDN - HTTP 인증 문서를 참고해주세요.

하위 상점 연동을 할 경우 포트원 API 호출시 Tier 헤더에 하위 상점 티어 코드를 입력해야 합니다.

Agency & Tier 란?

액세스 토큰 만료기한 연장

만료된 액세스 토큰으로 API를 호출하면 401 Unauthorized 응답을 받습니다.
액세스 토큰의 만료 기한은 발행시간부터 30분입니다.

  • 기존 액세스 토큰이 만료되기 전 access_token 발급 API post/users/getToken를 다시 호출했을 경우

    • 기존 액세스 토큰이 반환됩니다.
      만료 기한이 1분 안쪽으로 남았을 때 요청했다면 기존 액세스 토큰의 만료 기한이 5분 연장됩니다.
  • 기존 액세스 토큰이 만료된 다음 access_token 발급 API post/users/getToken를 다시 호출했을 경우

    • 새로운 액세스 토큰이 반환됩니다.

액세스 토큰의 재사용과 만료기한 5분 연장 동작방식은 다음과 같은 상황을 고려해서 설계되었습니다.

  • 한 고객사에서 여러 대의 웹서버가 동시에 경쟁적으로 REST API(/users/getToken)를 호출하는 상황
  • 한 고객사에서 여러 대의 웹서버가 시간 동기화 되어있지 않은 상황

결제 관련 API

결제 금액 사전 등록 관련 API

비인증 결제 관련 API

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

비 인증 결제(일회성) API

구매자로부터 별도의 인증과정을 거치지 않고, 카드정보만으로 결제를 진행하는 API입니다.

빌링키 저장 시, buyer_email, buyer_name 등의 정보는 customer 부가정보인 customer_email, customer_name 등으로 함께 저장됩니다.
빌링키 발급 API참조

Request

Body

merchant_uid: string
고객사 주문번호

고객사 거래 고유번호로 매 결제요청 시 고유값으로 요청해야 합니다.


currency?: string
결제통화 구분코드
(Optional)

통화 e.g.) KRW, USD, VND, ... Default: KRW


amount: number
결제금액

결제요청 할 금액


tax_free?: number
면세금액
(Optional)

amount 중 면세공급가액


vat_amount?: number
부가세
(Optional)

부가세를 지정할 수 있으며, tax_free=0, vat_amount=0으로 영세율로 결제 가능합니다. PG사와의 사전 협의 후 사용가능합니다. (기본값: null)


vat?: number
(Optional) (Deprecated)
Deprecated 되었습니다. tax_free 파라메터를 사용해주세요.
결제금액 중 부가세 금액(파라메터가 누락되면 10%로 자동 계산됨)

card_number: string
카드번호

카드번호(dddd-dddd-dddd-dddd) 기재 양식을 유의하세요.


expiry: string
카드 유효기간

카드 유효기간(YYYY-MM) 기재 양식을 유의하세요.


birth: string
생년월일 6자리

PG사별로 혹은 계약상황에 따라 필수값 여부가 상이합니다.

생년월일 기재가 필요없는 해외 PG사 결제 요청의 경우 000000으로 고정 기재하도 무방합니다.


pwd_2digit?: string
카드비밀번호 앞 2자리
(Optional)

PG사별로 혹은 계약상황에 따라 필수값 여부가 상이합니다.


cvc?: string
카드 인증번호
(Optional)

결제 요청할 카드의 인증번호 (카드 뒷면 3자리, AMEX의 경우 4자리)


customer_uid?: string
구매자의 결제 수단 식별 고유번호
(Optional)

빌링키와 매핑되며 고객사에서 채번하는 구매자의 결제 수단 식별 고유번호


pg?: string
PG 구분코드
(Optional)

결제 요청할 PG사 구분코드


name?: string
주문명
(Optional)

결제요청 할 결제건의 주문명


buyer_name?: string
구매자명
(Optional)

결제건의 구매자명


buyer_email?: string
주문자 E-mail 주소
(Optional)

결제건의 주문자 E-mail주소


buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호


buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소


buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호


card_quota?: integer
카드할부개월수
(Optional)

결제금액 50,000원 이상 한정으로 2 이상의 integer 할부개월수가 적용가능합니다.


interest_free_by_merchant?: boolean
고객사 부담 무이자 할부여부
(Optional)

카드할부처리할 때, 할부이자가 발생하는 경우(카드사 무이자 프로모션 제외) 부과되는 할부이자를 고객대신 고객사가 지불하는지에 대한 여부 (PG사와 사전 계약이 필요)


use_card_point?: boolean
카드포인트 사용여부
(Optional)

승인요청시 카드사 포인트 차감하며 결제승인처리할지 여부 flag. PG사 영업담당자와 계약 당시 사전 협의 필요


custom_data?: string
추가 정보
(Optional)

거래정보와 함께 저장할 추가 정보


notice_url?: string
Notification URL(Webhook URL)
(Optional)

결제성공 시 통지될 Notification URL(Webhook URL)


browser_ip?: string
브라우져 IP
(Optional)

구매자 브라우져(PC)의 IP


secure_3d_charge_id?: string
결제 ID
(Optional)

해외PG 전용 파라미터로 3D secure 인증 후 재결제시 PG사에서 부여한 결제 ID


secure_3d_token?: string
토큰
(Optional)

해외PG 전용 파라미터로 3D secure 인증 후 재결제시 PG사에서 부여한 토큰


product_type?: string
주문 상품구분
(Optional)

결제 요청할 판매 상품에 대한 구분 값

Response

200

정상 결제
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

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

결제건의 포트원 거래고유번호

merchant_uid: string
고객사 주문번호

결제건의 고객사 주문번호

pay_method?: string
결제수단 구분코드
(Optional)

결제건의 결제수단을 구분하는 코드

channel?: string
결제환경 구분코드
(Optional)

결제건을 생성한 환경을 구분하는 코드

pg_provider?: string
PG사 구분코드
(Optional)

결제건의 PG사 구분코드

emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)

허브형 결제인 경우 결제건의 허브형 결제 PG사를 구분하는 코드

pg_tid?: string
PG사 거래번호
(Optional)

결제건의 PG사 거래번호

pg_id?: string
PG사 상점아이디
(Optional)

결제건의 PG사 상점아이디

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)

결제건의 카드 발급사 코드번호 (금융결제원 표준코드 번호) - 카드 결제 건의 경우

발급사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_issuer_name?: string
카드 발급사명
(Optional)

결제한 카드의 발급사명 - 카드 결제 건의 경우

발급사 코드를 지원하는 pg사에 한해 제공됩니다.
card_publisher_code?: string
카드 발행사 코드
(Optional)

결제건의 카드 발행사 코드번호(금융결제원 표준코드번호) - 카드 결제 건의 경우

발행사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET사
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_publisher_name?: string
카드 발행사명
(Optional)

결제 한 카드의 발행사명 - (카드 결제 건의 경우)

발행사 코드를 지원하는 pg사에 한해 제공됩니다.
card_quota?: integer
할부개월 수
(Optional)

결제건의 할부개월 수(일시불은 0으로 표기) - 신용카드 결제 건의 경우

card_number?: string
카드번호
(Optional)

7~12번째 자리를 마스킹하는 것이 일반적이지만, PG사의 정책/설정에 따라 상이할 수 있습니다.

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

주의 : 해당 정보를 제공하지 않는 일부 PG사의 경우 null로 응답됩니다.(ex. 이니시스-빌링)

  • 0 : 신용카드
  • 1 : 체크카드
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)

결제건의 가상계좌 생성시각 UNIX timestamp - 가상계좌 결제 건의 경우

name?: string
제품명
(Optional)

결제건의 제품명

amount: number
결제금액

결제건의 결제금액

cancel_amount: number
취소금액

결제건의 누적 취소금액

currency: string
결제통화 구분코드

외환분호 e.g) KRW, USD, VND, ... Default: KRW

buyer_name?: string
주문자명
(Optional)

결제건의 주문자명

buyer_email?: string
주문자 Email주소
(Optional)

결제건의 주문자의 Email주소

buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호

buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소

buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호

custom_data?: string
추가정보
(Optional)

결제 요청시 고객사에서 전달한 추가정보 (JSON string으로 전달)

user_agent?: string
단말기의 UserAgent 문자열
(Optional)

구매자가 결제시 사용한 단말기의 UserAgent 문자열

status: string
결제상태

결제건의 결제상태

started_at?: integer
요청 시각
(Optional)

결제건의 결제요청 시각 UNIX timestamp

paid_at?: integer
결제 시각
(Optional)

결제상태가 결제완료(paid)가 아닌 경우 0으로 표시됩니다.

failed_at?: integer
실패시각
(Optional)

결제상태가 결제실패(failed)가 아닌경우 0으로 표시됩니다.

cancelled_at?: integer
취소시각
(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 0으로 표시됩니다.

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

결제상태가 결제실패(failed)가 아닐 경우 null로 표시됩니다.

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

결제상태가 결제취소(cancelled)가 아닐 경우 null로 표시됩니다.

receipt_url?: string
매출전표 URL
(Optional)

결제건의 매출전표 URL로 PG사 또는 결제 수단에 따라 매출전표가 없을 수 있습니다.

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)

결제처리에 사용된 구매자의 결제 수단 식별 고유번호의 사용 구분코드

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
N/A
post/subscribe/payments/again

비 인증 결제(빌링키) API

저장된 빌링키로 재결제를 하는 경우 사용됩니다. PG사 결제창, 비 인증 결제(일회성)API 또는 빌링키 발급 API로 등록된 빌링키가 있을 때 매칭되는 customer_uid로 재결제를 진행할 수 있습니다.

Request

Body

customer_uid: string
구매자의 결제 수단 식별 고유번호

빌링키와 매핑되며 고객사에서 채번하는 구매자의 결제 수단 식별 고유번호


merchant_uid: string
고객사 주문번호

결제 요청할 결제건의 고객사 거래 고유번호


currency?: string
결제 통화 코드
(Optional)

통화 e.g.) KRW, USD, VND, ... Default: KRW


amount: number
결제금액

결제 요청할 금액


tax_free?: number
면세금액
(Optional)

amount 중 면세공급가액


vat_amount?: number
부가세
(Optional)

부가세를 지정할 수 있으며, tax_free=0, vat_amount=0으로 영세율로 결제 가능합니다.(기본값: null)


vat?: number
(Optional) (Deprecated)
Deprecated 되었습니다. tax_free 파라메터를 사용해주세요.
결제금액 중 부가세 금액(파라메터가 누락되면 10%로 자동 계산됨)

name: string
제품명

결제 요청할 결제건의 제품명


buyer_name?: string
주문자명
(Optional)

결제건의 주문자명


buyer_email?: string
주문자 E-mail 주소
(Optional)

결제건의 주문자 E-mail주소


buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호


buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소


buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호


card_quota?: integer
카드 할부 개월수
(Optional)

결제건의 카드 할부 개월 수로 기본값은 **0(일시불)**입니다.


interest_free_by_merchant?: boolean
상점분담 무이자 할부여부
(Optional)

카드할부처리할 때, 할부이자가 발생하는 경우(카드사 무이자 프로모션 제외) 부과되는 할부이자를 고객대신 고객사가 지불하는지에 대한 여부 (PG사와 사전 계약이 필요)


use_card_point?: boolean
카드포인트 사용여부
(Optional)

승인요청시 카드사 포인트 차감하며 결제승인처리할지 여부 flag. PG사 영업담당자와 계약 당시 사전 협의 필요


custom_data?: string
빌링키 발급 시 같이 저장할 고객사 custom 데이터
(Optional)

거래정보와 함께 저장할 추가 정보


notice_url?: string
Notification URL(Webhook URL)
(Optional)

결제성공 시 통지될 Notification URL(Webhook URL)


browser_ip?: string
브라우저의 IP
(Optional)

구매자 브라우져(PC)의 IP


product_type?: string
주문 상품구분
(Optional)

결제 요청할 판매 상품에 대한 구분 값


product_count?: integer
결제 상품의 개수
(Optional)

결제 상품의 개수로 기본값은 1입니다.


cash_receipt_type?: string
현금영수증 발행대상 타입
(Optional)

현금영수증 발행대상의 구분 값


bypass?: string
bypass 데이터
(Optional)

전달 한 값은 가공 없이 그대로 PG사로 전달 됩니다. 각 PG사별 스펙은 PG사별 연동 문서 참고해주세요


추가 파라미터
(Optional)

비인증 결제 요청 시 추가 파라미터

Response

200

정상 결제
code?: integer
응답코드
(Optional)

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

message?: string
응답메세지
(Optional)

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

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

결제건의 포트원 거래고유번호

merchant_uid: string
고객사 주문번호

결제건의 고객사 주문번호

pay_method?: string
결제수단 구분코드
(Optional)

결제건의 결제수단을 구분하는 코드

channel?: string
결제환경 구분코드
(Optional)

결제건을 생성한 환경을 구분하는 코드

pg_provider?: string
PG사 구분코드
(Optional)

결제건의 PG사 구분코드

emb_pg_provider?: string
허브형결제 PG사 구분코드
(Optional)

허브형 결제인 경우 결제건의 허브형 결제 PG사를 구분하는 코드

pg_tid?: string
PG사 거래번호
(Optional)

결제건의 PG사 거래번호

pg_id?: string
PG사 상점아이디
(Optional)

결제건의 PG사 상점아이디

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)

결제건의 카드 발급사 코드번호 (금융결제원 표준코드 번호) - 카드 결제 건의 경우

발급사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_issuer_name?: string
카드 발급사명
(Optional)

결제한 카드의 발급사명 - 카드 결제 건의 경우

발급사 코드를 지원하는 pg사에 한해 제공됩니다.
card_publisher_code?: string
카드 발행사 코드
(Optional)

결제건의 카드 발행사 코드번호(금융결제원 표준코드번호) - 카드 결제 건의 경우

발행사 코드 지원 pg사
- (신) 토스페이먼츠
- KSNET사
- 페이팔 RT
- (신) 스마트로
- (신) 나이스페이먼츠
- 웰컴페이먼츠
- 토스페이먼츠 브랜드페이
- (신) 토스페이
card_publisher_name?: string
카드 발행사명
(Optional)

결제 한 카드의 발행사명 - (카드 결제 건의 경우)

발행사 코드를 지원하는 pg사에 한해 제공됩니다.
card_quota?: integer
할부개월 수
(Optional)

결제건의 할부개월 수(일시불은 0으로 표기) - 신용카드 결제 건의 경우

card_number?: string
카드번호
(Optional)

7~12번째 자리를 마스킹하는 것이 일반적이지만, PG사의 정책/설정에 따라 상이할 수 있습니다.

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

주의 : 해당 정보를 제공하지 않는 일부 PG사의 경우 null로 응답됩니다.(ex. 이니시스-빌링)

  • 0 : 신용카드
  • 1 : 체크카드
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)

결제건의 가상계좌 생성시각 UNIX timestamp - 가상계좌 결제 건의 경우

name?: string
제품명
(Optional)

결제건의 제품명

amount: number
결제금액

결제건의 결제금액

cancel_amount: number
취소금액

결제건의 누적 취소금액

currency: string
결제통화 구분코드

외환분호 e.g) KRW, USD, VND, ... Default: KRW

buyer_name?: string
주문자명
(Optional)

결제건의 주문자명

buyer_email?: string
주문자 Email주소
(Optional)

결제건의 주문자의 Email주소

buyer_tel?: string
주문자 전화번호
(Optional)

결제건의 주문자 전화번호

buyer_addr?: string
주문자 주소
(Optional)

결제건의 주문자 주소

buyer_postcode?: string
주문자 우편번호
(Optional)

결제건의 주문자 우편번호

custom_data?: string
추가정보
(Optional)

결제 요청시 고객사에서 전달한 추가정보 (JSON string으로 전달)

user_agent?: string
단말기의 UserAgent 문자열
(Optional)

구매자가 결제시 사용한 단말기의 UserAgent 문자열

status: string
결제상태

결제건의 결제상태

started_at?: integer
요청 시각
(Optional)

결제건의 결제요청 시각 UNIX timestamp

paid_at?: integer
결제 시각
(Optional)

결제상태가 결제완료(paid)가 아닌 경우 0으로 표시됩니다.

failed_at?: integer
실패시각
(Optional)

결제상태가 결제실패(failed)가 아닌경우 0으로 표시됩니다.

cancelled_at?: integer
취소시각
(Optional)

결제상태가 결제취소(cancelled)가 아닐 경우 0으로 표시됩니다.

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

결제상태가 결제실패(failed)가 아닐 경우 null로 표시됩니다.

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

결제상태가 결제취소(cancelled)가 아닐 경우 null로 표시됩니다.

receipt_url?: string
매출전표 URL
(Optional)

결제건의 매출전표 URL로 PG사 또는 결제 수단에 따라 매출전표가 없을 수 있습니다.

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)

결제처리에 사용된 구매자의 결제 수단 식별 고유번호의 사용 구분코드

401

인증 Token이 전달되지 않았거나 유효하지 않은 경우
try
Request
Request Sample
N/A

정기 결제 관련 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 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다