1.4.0 • Published 2 months ago
iamport-typings v1.4.0
국내 PG 결제연동 서비스, 포트원(구 아임포트)를 위한 타입스크립트 타입 선언을 제공합니다.
⚔️ 사용하는 곳
📦 설치
npm install -D iamport-typings
# Or using yarn
yarn add -D iamport-typings
패키지를 설치합니다.
📌 로드맵
메소드별 지원 상황입니다. PR은 언제나 환영! 🙌
init
request_pay
agency
certification
close
communicate
naver_zzim
🚀 사용 방법
// tsconfig.json
{
"compilerOptions": {
"types": ["iamport-typings"]
}
}
사용할 프로젝트 루트 디렉토리에 있는 tsconfig.json
파일의 compilerOptions.types
에 iamport-typings
를 추가하기만 하면 끝!
const { IMP } = window;
Window
인터페이스를 확장하기 때문에, 기존처럼 위와 같이 바로 사용할 수 있답니다! 😋
import Iamport from 'iamport-typings';
declare global {
interface Window {
IMP?: Iamport;
}
}
import { RequestPayParams, RequestPayResponse } from 'iamport-typings';
const onClickPayment = () => {
const { IMP } = window;
IMP.init('your_imp_uid');
const params: RequestPayParams = {
...
};
IMP.request_pay(params, onPaymentAccepted);
};
const onPaymentAccepted = (response: RequestPayResponse) => {
const { imp_uid, merchant_uid } = response;
console.log(imp_uid, merchant_uid);
};
위와 같이 각각의 인터페이스를 가져와 사용하는 것도 가능합니다.
아임포트 객체
인터페이스 이름 | 설명 |
---|---|
Iamport | 아임포트 객체 |
결제요청 파라미터
인터페이스 이름 | 설명 |
---|---|
RequestPayParams | request_pay 메소드를 위한 결제 승인에 필요한 정보를 담고 있는 객체로, RequestPayAdditionalParams 에서 확장됨 |
RequestPayAdditionalParams | request_pay 메소드를 위한 추가 속성 |
인터페이스 이름 | 설명 |
---|---|
RequestPayNaverAdditionalParams | 네이버페이 연동 시 RequestPayParams 에 추가되는 파라미터 |
RequestPayNaverParams | RequestPayParams & RequestPayNaverAdditionalParams |
기타
타입 이름 | 설명 | Codegen |
---|---|---|
Pg | Codegen | |
PaymentMethod | Codegen | |
PayPalSupportedCurrency | PayPal 지원 결제통화의 유니언 타입(union type) | Codegen |
Currency | 결제통화 구분코드 ('KRW' \| 'USD' \| 'EUR' \| 'JPY' \| PayPalSupportedCurrency ) | |
CardCode | 카드사 금융결제원 표준 코드의 유니언 타입(union type) | Codegen |
Language | 'en' \| 'ko' \| 'zh' | |
EscrowProduct |
타입 이름 | 설명 |
---|---|
NaverProductCategoryType | |
NaverProductCategoryId | |
NaverPayReferrer | |
NaverProduct | 네이버페이 상품 정보 |
결제응답 파라미터
인터페이스 이름 | 설명 |
---|---|
RequestPayResponse | 결제 결과의 정보를 담고 있는 객체로, request_pay 메소드에 지정되는 콜백 함수의 인자로, RequestPayAdditionalResponse 에서 확장됨 |
RequestPayAdditionalResponse | request_pay 메소드의 콜백을 위한 추가 속성 |
RequestPayResponseCallback | request_pay 메소드의 함수 타입 리터럴 |