결제응답 파라미터

callback 으로 내려가는 응답 파라미터 항목을 확인할 수 있습니다.

결제 요청에 대해 반환되는 응답 정보

PG사 또는 결제수단에 따라서 반환되는 속성들이 상이합니다.

<script src="https://cdn.iamport.kr/v1/iamport.js"></script>

위 JS SDK 버전을 사용하면서 (신) 토스페이먼츠, (신) 스마트로, (신) 나이스페이먼츠, (신) 페이팔, KSNET, 웰컴페이먼츠 연동시에는 imp_uid, merchant_uid, error_code, error_msg만 제공됩니다.

결제 실패 사유와 코드 확인을 위해서는 error_code, error_msg 파라미터를 참고해주세요.

success:

success: boolean

결제 성공여부

결제승인 혹은 가상계좌 발급이 성공한 경우, True

PG사/결제수단에 따라 imp_success로 반환됩니다.

error_code:

error_code: string

결제 실패코드

결제가 실패하는 경우 PG사 원천코드가 내려갑니다.

error_msg:

error_msg: string

결제 실패메세지

결제가 실패하는 경우 PG사 원천메세지가 내려갑니다.

imp_uid:

imp_uid: string

포트원 고유 결제번호

success가 false이고 사전 validation에 실패한 경우, imp_uid는 null일 수 있음

merchant_uid:

merchant_uid: string

주문번호

pay_method:

pay_method: string

결제수단 구분코드

paid_amount:

paid_amount: number

결제금액

status:

status: string

결제상태

ready(브라우저 창 이탈, 가상계좌 발급 완료 등 미결제 상태)
paid(결제완료)
failed(신용카드 한도 초과, 체크카드 잔액 부족, 브라우저 창 종료 또는 취소 버튼 클릭 등 결제실패 상태)

name:

name: string

주문명

pg_provider:

pg_provider: string

PG사 구분코드

emb_pg_provider:

emb_pg_provider?: string

간편결제 구분코드

결제창에서 간편결제 호출시 결제 승인된 PG사 구분코드

일부 PG사 또는 간편결제로 결제가 발생되지 않은 경우 해당 파라미터는 생략됩니다.

pg_tid:

pg_tid: string

PG사 거래번호

PG사에서 거래당 고유하게 부여하는 거래번호입니다.

buyer_name:

buyer_name: string

주문자명

buyer_email:

buyer_email: string

주문자 Email

buyer_tel:

buyer_tel: string

주문자 연락처

buyer_addr:

buyer_addr: string

주문자 주소

buyer_postcode:

buyer_postcode: string

주문자 우편번호

custom_data:

custom_data: string

고객사 임의 지정 데이터

paid_at:

paid_at: string

결제승인시각 (UNIX timestamp)

Unix timestamp 란?

유닉스 시간(영어: Unix time)은 시각을 나타내는 방식이다. POSIX 시간이나 Epoch 시간이라고 부르기도 한다. 1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 초로 환산하여 정수로 나타낸 것이다. 유닉스 시간에서 윤초는 무시된다. 유닉스 계열 운영 체제나 여러 다른 운영 체제, 그리고 파일 형식들에서 사용된다. 윤초 처리 방식 때문에 시간을 선형으로 표현하지 못하며 협정 세계시의 윤초를 표현할 수 없다..

receipt_url:

receipt_url?: string

거래 매출전표 URL

추가속성

apply_num:

apply_num?: string

신용카드 승인번호

신용카드 결제수단에 한하여 제공

vbank_num:

vbank_num?: string

가상계좌 입금 계좌번호

PG사로부터 전달된 정보 그대로 제공에 따라 숫자 외 dash(-) 또는 기타 기호가 포함되어 있을 수 있음

vbank_name:

vbank_name?: string

가상계좌 입금은행 명

vbank_holder:

vbank_holder?: string

가상계좌 예금주

계약된 사업자명으로 표시됨, 단, 일부 PG사의 경우 null 을 반환하므로 자체 처리 필요

vbank_date:

vbank_date?: string

가상계좌 입금기한 (UNIX timestamp)

결제 응답 샘플

결제 응답 sample object
{
  "apply_num": "42827474",
  "bank_name": null,
  "buyer_addr": "서울특별시 강남구 삼성동",
  "buyer_email": "test@portone.io",
  "buyer_name": "포트원 기술지원팀",
  "buyer_postcode": "123-456",
  "buyer_tel": "010-1234-5678",
  "card_name": "신한카드",
  "card_number": "5428790000000294",
  "card_quota": 0,
  "currency": "KRW",
  "custom_data": null,
  "imp_uid": "imp_347242536261",
  "merchant_uid": "57008833-33004",
  "name": "당근 10kg",
  "paid_amount": 1004,
  "paid_at": 1648344363,
  "pay_method": "card",
  "pg_provider": "kcp",
  "pg_tid": "22336466628585",
  "pg_type": "payment",
  "receipt_url": "https://admin8.kcp.co.kr/assist/bill.BillActionNew.do?cmd=card_bill&tno=22336466628585&order_no=imp_347242536261&trade_mony=1004",
  "status": "paid",
  "success": true
}