개발자센터
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

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

정기 결제 관련 API

빌링키 관련 API

get/subscribe/customers

빌링키 정보 복수조회 API

여러 개의 빌링키를 한 번에 조회하는 API입니다.

등록된 카드마다 1개의 customer_uid가 매핑되므로, 가맹점 시스템 내에 1명의 고객이 여러 장의 카드를 등록할 수 있는 경우 여러 개의 customer_uid를 가지게 됩니다.
해당 고객이 등록해놓은 카드정보 목록을 한 번에 조회하는데 사용하면 편리합니다.

예시) /subscribe/customers?customer_uid[]=hong_1234_a&customer_uid[]=hong_1234_b

Request

Query

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

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

Response

200

요청된 모든 customer_uid 에 대한 빌키정보 응답완료
code?: integer
응답코드
(Optional)

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

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

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

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

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

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: 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_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

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

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

207

요청된 customer_uid 중 일부 빌키정보 조회 실패(ex. 접근권한없음 또는 존재하지 않는 customer_uid)
code?: integer
응답코드
(Optional)

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

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

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

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

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

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: 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_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

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

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

401

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

404

유효하지 않은 customer_uid
try
Request
Request Sample
N/A
get/subscribe/customers/{customer_uid}

빌링키 정보 단건조회 API

구매자의 빌링키 정보 조회

Request

Path

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

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

Response

200

정상 조회
code?: integer
응답코드
(Optional)

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

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

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

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

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

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: 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_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

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

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

401

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

404

유효하지 않은 customer_uid
try
Request
Request Sample
N/A
post/subscribe/customers/{customer_uid}

빌링키 발급 API

구매자에 대해 빌링키 발급 및 저장
해당 빌링키 발급 API는 PG사와 협의가 완료된 경우 이용 가능한 서비스입니다.
  • PG사 협의를 통해 카드정보 필수 조건 값 조정이 가능합니다.
  • 민감한 카드정보를 이용하기 때문에 보안에 특히 유의하셔야 합니다.
  • customer_uid 값은 고객 & 카드번호 단위별로 고유하게 발급 관리되어야 합니다

Request

Path

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

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

Body

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

빌링키 발급을 받고자 하는 PG사 구분코드


customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호


card_number: string
카드번호

빌링키 발급 하고자 하는 카드의 번호(dddd-dddd-dddd-dddd)


expiry: string
카드 유효기간

빌링키 발급 하고자 하는 카드 유효기간(YYYY-MM)


birth?: string
생년월일
(Optional)

법인카드의 경우 사업자등록번호10자리

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


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

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


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

빌링키 발급 받고자 하는 카드 카드 뒷면 3자리, AMEX의 경우 4자리


customer_name?: string
카드소유자명
(Optional)

고객(카드소지자) 관리용 성함


customer_tel?: string
카드소유자 연락처
(Optional)

고객(카드소지자) 전화번호


customer_email?: string
카드소유자 이메일주소
(Optional)

고객(카드소지자) Email


customer_addr?: string
카드소유자 주소
(Optional)

고객(카드소지자) 주소


customer_postcode?: string
카드소유자 우편번호
(Optional)

고객(카드소지자) 우편번호

Response

200

정상 등록
code?: integer
응답코드
(Optional)

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

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

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

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

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

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: 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_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

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

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

401

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

빌링키 삭제 API

구매자의 빌링키 정보 삭제
빌링키 삭제시 결제예약된 내역이 존재하는지 반드시 확인하셔야 합니다.
삭제된 빌링키는 복구할 수 없습니다.

Request

Path

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

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

Query

reason?: string
삭제 사유
(Optional)

빌링키를 삭제하려는 사유


extra[requester]?: string
삭제 요청자
(Optional)

빌링키 삭제 요청자

Response

200

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

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

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

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

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

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

pg_provider: string
PG사 구분코드

빌링키가 등록된 PG사 구분코드

pg_id: string
상점아이디(MID)

빌링키가 등록된 PG사 상점아이디(MID)

customer_id?: string
구매자 ID
(Optional)

구매자 식별 고유 번호

card_name: string
카드명

빌링키 발급 한 카드명

card_code?: 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_number?: string
마스킹 카드번호
(Optional)

빌링키 발급 한 카드의 마스킹된 카드번호

card_type?: integer
카드유형
(Optional)

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

  • 0 : 신용카드
  • 1 : 체크카드
customer_name?: string
고객 성함
(Optional)

빌링키 발급 한 고객(카드소지자)의 성함

customer_tel?: string
전화번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 전화번호

customer_email?: string
Email 주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 Email 주소

customer_addr?: string
주소
(Optional)

빌링키 발급 한 고객(카드소지자)의 주소

customer_postcode?: string
우편번호
(Optional)

빌링키 발급 한 고객(카드소지자)의 우편번호

inserted: integer
발급 시각

빌링키가 발급된 시각 UNIX timestamp

updated: integer
업데이트 시각

빌링키가 업데이트된 시각 UNIX timestamp

401

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

404

유효하지 않은 customer_uid
try
Request
Request Sample
N/A
get/subscribe/customers/{customer_uid}/payments

빌링키 결제 복수조회 API (빌링키 결제 내역 확인)

구매자의 빌링키로 결제된 결제목록을 조회합니다.

Request

Path

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

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

Query

page?: integer
조회목록 페이징
(Optional)

조회목록 페이징으로 기본값은 1입니다.

Response

200

정상 조회
code?: integer
응답코드
(Optional)

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

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

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

(Optional)
total: integer
전체 건수

조회한 결제 상태에 대한 전체 건수

previous: integer
이전 page숫자

이전 page숫자로 이전 페이지가 없는 경우 0을 반환합니다.

next: integer
다음 page숫자

다음 page숫자로 다음 페이지가 없는 경우 0을 반환합니다.

결제 상세정보 배열
(Optional)

결제 상세정보 배열로 최대 20개를 반환합니다. 바로 아래 Payment structure를 확인해주세요.

401

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

404

유효하지 않은 customer_uid
try
Request
Request Sample
N/A
get/subscribe/customers/{customer_uid}/schedules

빌링키 결제예약 조회 API

결제예약 복수조회(빌키) API와 동일한 동작을 하는 API입니다.

customer_uid별 결제예약목록을 조회할 수 있습니다. 결제예약정보가 (페이징된)목록으로 전달되며, 최대 3개월 단위로 조회가 가능합니다.

결제예약정보가 예약된 시각 기준으로 최신순으로 정렬되어 전달됩니다.

Request

Path

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

결제예약에 사용된 구매자의 결제 수단 식별 고유번호

Query

page?: integer
조회목록 페이징
(Optional)

조회목록 페이징으로 기본값은 1입니다.


from: integer
조회 시작시각

unix timestamp(결제예약건의 '예약시각'기준으로 조회합니다. from <= '예약시각')


to: integer
조회 종료시각

unix timestamp(결제예약건의 '예약시각'기준으로 조회합니다. '예약시각' < to)


schedule-status?: string
예약상태
(Optional)

조회 하고자 하는 예약 상태

Response

200

결제예약목록 조회완료
code?: integer
응답코드
(Optional)

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

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

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

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

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

merchant_uid?: string
가맹점 주문번호
(Optional)

예약 결제건의 가맹점 주문번호

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

예약된 결제가 실행 전 철회되거나 아직 실행 전 예약 상태에 있으면 imp_uid는 null입니다.

customer_id?: string
구매자 ID
(Optional)

string 타입의 구매자 식별 고유번호

schedule_at?: integer
결제 예정 시각
(Optional)

결제 예약시 요청한 결제 예정 시각 UNIX timestamp

executed_at?: integer
결제 실행 시각
(Optional)

실제 결제가 실행된 시각 UNIX timestamp

revoked_at?: integer
결제 실행 철회 시각
(Optional)

예약 결제 실행을 철회한 시각 UNIX timestamp

amount?: number
결제금액
(Optional)

결제 예약시 요청한 결제금액

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

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

name?: string
제품명
(Optional)

예약 결제건의 제품명

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)

예약된 결제가 수행될 때 결제정보와 함께 저장할 추가정보

schedule_status?: string
예약상태
(Optional)

결제건의 예약상태

payment_status?: string
결제상태
(Optional)

예약 결제건의 승인 상태

fail_reason?: string
실패사유
(Optional)

예약 결제건이 결제 승인에 실패한 경우, 실패사유

400

검색 파라메터가 유효하지 않은 경우

401

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

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