Iamport

⚠️ DEPRECATED: 이 레포지토리는 2026년 3월 4일부로 deprecated 되었으며, 공식 지원이 되지 않습니다. 본 클라이언트는 함께 포함된 openapi.json Swagger spec 기준으로 동작합니다. 추가/수정이 필요한 경우 본 레포지토리를 fork하여 수정하거나, PortOne V1 REST API 문서를 참고하여 REST client를 직접 구현해주세요.

아임포트는 특정 서비스와 국내 PG사와의 연동을 간편하게 연결해주는 서비스입니다.

• 이 모듈은 아임포트에서 제공하는 REST API를 Node.js로 구현한 샘플프로그램입니다.
• 아임포트의 자세한 내용은 여기를 참고하시기 바랍니다.

Features

• 모든 함수는 Promise를 반환

Requirements

• nodejs >= 0.12.x

Installation

$ npm install --save iamport

Usage

var Iamport = require('iamport');
var iamport = new Iamport({
  impKey: 'your API key',
  impSecret: 'your API Secret key'
});

// 아임포트 고유 아이디로 결제 정보를 조회
iamport.payment.getByImpUid({
  imp_uid: 'your imp_uid'
}).then(function(result){
  // To do
}).catch(function(error){
  // handle error
});

// 상점 고유 아이디로 결제 정보를 조회
iamport.payment.getByMerchant({
  merchant_uid: 'your merchant_uid'
})

// 상태별 결제 정보 조회
iamport.payment.getByStatus({
  payment_status: 'your payment_status'
})

Available resources & methods

Where you see params it is a plain JavaScript object

• certification

• get(params)
• delete(params)
• otpRequest(params)
• otpConfirm(params)

• payment

• getByImpUid(params)
• getByMerchant(params)
• getByStatus(params)
• cancel(params)
• prepare(params)
• getPrepare(params)
• getBalance(params)
• getByImpUids(params)
• getAllByMerchant(params)
• updatePrepare(params)

• subscribe

• onetime(params)
• again(params)
• schedule(params)
• unschedule(params)
• getSchedules(params)
• getScheduleByMerchantUid(params)
• updateSchedule(params)
• retrySchedule(params)
• rescheduleSchedule(params)
• getSchedulesByCustomerUid(params)

• subscribe_customer

• get(params)
• create(params)
• delete(params)
• getPayments(params)
• getMultiple(params)
• getSchedules(params)

• vbank

• create(params)
• getHolder(params)
• update(params)
• delete(params)

• escrows

• create(params)
• get(params)
• update(params)

• benepia

• getPoint(params)
• payment(params)

• bank

• getAll()
• getByCode(params)

• card

• getAll()
• getByCode(params)

• cvs

• create(params)
• delete(params)

• kcpQuick

• deleteMember(params)
• payMoney(params)

• naver

• getProductOrder(params)
• getReviews(params)

• naverPayment

• getProductOrders(params)
• getCashAmount(params)
• place(params)
• ship(params)
• confirm(params)
• approveCancel(params)
• approveReturn(params)
• cancel(params)
• requestReturn(params)
• rejectReturn(params)
• resolveReturn(params)
• withholdReturn(params)
• collectExchanged(params)
• shipExchanged(params)
• point(params)

• partner

• issueReceipt(params)

• payco

• updateOrderStatus(params)

• receipt

• get(params)
• create(params)
• delete(params)
• getExternal(params)
• createExternal(params)
• deleteExternal(params)

• tier

• get(params)

• user

• getPg()

• paymentwall

• sendDelivery(params)

Contribution

• 이 프로젝트는 누구나 참여 가능합니다.
• 버그나 개선점 및 의견 등은 이슈 및 Pull Request를 활용해주세요.

Conventions

• ES5
• ES6

Links

• I'amport; 공식 사이트: http://www.iamport.kr/
• I'amport; API(swagger): https://api.iamport.kr/
• I'amport; 메뉴얼: http://www.iamport.kr/manual/

License

• MIT