⌨️비 인증 결제(빌링키) API

저장된 빌링키(customer_uid)를 이용하여 결제를 요청할 수 있는 API 명세를 기술합니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

저장된 빌링키(customer_uid)로 결제를 요청 할수 있습니다.

customer_uid 로 결제를 요청합니다.

POST https://api.iamport.kr/subscribe/payments/again

빌링키 발급 API 또는 PG사 빌링키 발급 결제창에서 설정한

customer_uid

로 비 인증 결제를 요청할 수 있습니다.

Request Body

Name	Type	Description
customer_uid*	String	빌링키
merchant_uid*	String	주문번호
currency	String	결제 통화코드
amount*	integer	결제금액
tax_free	integer	면세금액
vat_amount	integer	부가세 지정(기본값: null) 지원 PG사 -나이스페이먼츠 -이니시스
name*	String	제품명
buyer_name	String	주문자명
buyer_email	String	주문자 E-mail 주소
buyer_tel	String	주문자 전화번호
buyer_addr	String	주문자 주소
buyer_postcode	String	주문자 우편번호
card_quota	integer	카드 할부개월수
interest_free_by_merchant	boolean	가맹점부담 무이자 할부여부
use_card_point	boolean	카드포인트 사용여부
custom_data	String	에코항목
notice_url	String	결제성공 시 통지될 웹훅 URL
browser_ip	String	구매자 브라우저(PC)의 IP

200: OK 결제성공

PaymentResponse

code * integer

응답코드

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

message * string

응답메세지

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

response (PaymentAnnotation, optional)

PaymentAnnotation

code * integer

응답코드

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

message * string

응답메세지

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

imp_uid * string

포트원 결제 고유 UID

merchant_uid * string

주문번호

pay_method * string

결제수단 구분코드

channel * string

결제환경 구분코드

• pc : (인증방식)PC결제

• mobile:(인증방식)모바일결제

• api:정기결제 또는 비인증 결제

pg_provider * string

PG사 구분코드

emb_pg_provider * string

허브형결제 PG사 구분코드

pg_tid * string

pg사 거래번호

pg_id * string

PG사 MID

escrow boolean

에스크로 결제여부

apply_num string

신용카드 승인번호

bank_code string

은행 표준코드(링크보기)

bank_name string

은행 명칭

card_code string

카드사 코드번호(금융결제원 표준코드번호 : 링크 )

card_name string

카드사명

card_quota integer

할부개월 수(0이면 일시불)

card_number string

마스킹 카드번호

card_type string

카드 구분코드

• 0 : 신용카드

• 1 : 체크카드

vbank_code string

가상계좌 은행 표준코드(하단이미지 참고)

vbank_name string

입금받을 가상계좌 은행명

vbank_holder string

입금받을 가상계좌 예금주

vbank_date string

입금받을 가상계좌 마감기한 (UNIX timestamp)

vbank_issued_at string

가상계좌 생성 시각 (UNIX timestamp)

name string

제품명

amount * integer

주문(결제)금액

cancel_amount integer

결제취소금액

currency string

통화구분코드

• USD

• KRW

• EUR

buyer_name string

주문자명

buyer_email string

주문자 Email주소\

buyer_tel string

주문자 전화번호

buyer_addr string

주문자 주소

buyer_postcode string

주문자 우편번호

custom_data string

echo data

JSON string으로 전달

user_agent string

UserAgent

결제를 시작한 단말기 정

status * string

결제상태 구분코드

• ready

• paid

• cancelled

• failed

started_at * string

결제시작시점 (UNIX timestamp)

paid_at * string

결제완료시점 (UNIX timestamp)\

failed_at * string

결제실패시점 (UNIX timestamp)

cancelled_at * string

결제취소시점 (UNIX timestamp)

fail_reason string

결제실패 사유

cancel_reason string

결제취소 사유

receipt_url string

신용카드 매출전표 확인 URL

cash_receipt_issued boolean

현금영수증 자동발급 여부

customer_uid string

해당 결제처리에 사용된 customer_uid

customer_uid_usage string

customer_uid 사용 구분코드

• issue : 빌링키 발급

• payment : 결제

• payment.scheduled : 예약결제

cancel_history (Array[PaymentCancelAnnotation], optional):

취소/부분취소 내역

PaymentCancelAnnotation

cancel_history array []

pg_tid * string

PG사 승인취소번호

amount * integer

취소 금액

cancelled_at * string

결제취소된 시각 UNIX timestamp

reason * string

결제취소 사유

receipt_url * string

취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음

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

{
    // Response
}

주요 요청 파라미터 상세 설명

customer_uid * string

빌링키

PG사가 발급한 빌링키와 1:1로 맵핑되는 가맹점이 지정한 고유값입니다. customer_uid 는 카드번호 단위로 구분되서 저장되어야 합니다

**currency ** string

**결제통화 구분코드 **

KRW, USD, VND...

페이먼트월 PG사인 경우 필수

browser_ip string

**구매자 브라우저 IP **

페이먼트월 PG사인 경우 필수

buyer_name string

구매자명

페이먼트월 PG사인 경우 first name, last name 한칸 띄어쓰기로 구분되어 유입되어야 합니다.

buyer_email string

구매자 이메일 주소

페이먼트월 PG사인 경우 필수파라미터 입니다.

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": {
    "imp_uid": "string",
    "merchant_uid": "string",
    "pay_method": "string",
    "channel": "pc",
    "pg_provider": "string",
    "emb_pg_provider": "string",
    "pg_tid": "string",
    "pg_id": "string",
    "escrow": true,
    "apply_num": "string",
    "bank_code": "string",
    "bank_name": "string",
    "card_code": "string",
    "card_name": "string",
    "card_quota": 0,
    "card_number": "string",
    "card_type": "null",
    "vbank_code": "string",
    "vbank_name": "string",
    "vbank_num": "string",
    "vbank_holder": "string",
    "vbank_date": 0,
    "vbank_issued_at": 0,
    "name": "string",
    "amount": 0,
    "cancel_amount": 0,
    "currency": "string",
    "buyer_name": "string",
    "buyer_email": "string",
    "buyer_tel": "string",
    "buyer_addr": "string",
    "buyer_postcode": "string",
    "custom_data": "string",
    "user_agent": "string",
    "status": "ready",
    "started_at": 0,
    "paid_at": 0,
    "failed_at": 0,
    "cancelled_at": 0,
    "fail_reason": "string",
    "cancel_reason": "string",
    "receipt_url": "string",
    "cancel_history": [
      {
        "pg_tid": "string",
        "amount": 0,
        "cancelled_at": 0,
        "reason": "string",
        "receipt_url": "string"
      }
    ],
    "cancel_receipt_urls": [
      "string"
    ],
    "cash_receipt_issued": true,
    "customer_uid": "string",
    "customer_uid_usage": "issue"
  }
}

Swagger Test Link

https://api.iamport.kr/#!/subscribe/again